ICM10 REST API v1

Base URLs:

Activity

Live and completed activities

Get completed activities.

Parameters

Name

In

Type

Required

Description

filter

query

string

false

####Supported operations

orderBy

query

string

false

####Description

limit

query

integer(int32)

false

Number of records to retrieve.

offset

query

integer(int32)

false

Offset number of records.

Detailed descriptions

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

type, time, status, progressid

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

time

limit: Number of records to retrieve.

Default: 50

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.CompletedActivityDTO]

false

none

none

» progressId

integer(int32)

false

none

none

» userId

string¦null

false

none

none

» type

string

false

none

none

» status

string

false

none

none

» message

string¦null

false

none

none

» time

string(date-time)

false

none

none

» messageDetails

string¦null

false

none

none

» apiServer

string¦null

false

none

none

Enumerated Values

Property

Value

type

Calculation

type

Import

type

Library

type

Migration

type

Task

type

Time

type

Optimization

type

Preview

type

BPMWorkflow

type

PurgePeriods

type

MakeEffective

type

Publication

type

Transformation

type

Scheduler

type

ScenarioPromote

type

NotifyUsers

type

HistoryPurge

type

PushAnalyticsData

type

ReapplyTemplate

type

UpdateHistoryTracking

type

ModifyCalendar

type

TableClear

type

IndexRebuild

type

PayeePublication

type

DeleteRows

type

GenerateTasks

type

QueryTool

type

BPMWorkflowAddMember

type

TableAlter

type

Sync

type

ModelEvaluation

type

CalcAndLock

type

Base64Conversion

type

AlterTableAdditionalData

type

BPMInquiryAutoAdjust

type

MaterializedView

type

PresenterReportThumbnail

type

PlanApprovalsPDF

type

CopyPaste

type

CutPaste

type

LGMConvert

type

CDWTableInitialization

type

CDWPopulateTable

type

DMSTransfer

type

PlanDocumentPDF

type

BPMWorkflowRemoveMember

type

ELTRun

type

Replication

status

Running

status

Completed

status

Failed

status

Cancelled

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/completedactivities", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/completedactivities");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/completedactivities',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/completedactivities', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/completedactivities',
  params: {
  }, headers: headers

p JSON.parse(result)

CompletedActivitiesControllerV1_Post

Body parameter

{
  "progressId": 0,
  "userId": "string",
  "type": "Calculation",
  "status": "Running",
  "message": "string",
  "time": "2019-08-24T14:15:22Z",
  "messageDetails": "string",
  "apiServer": "string"
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.CompletedActivityDTO

false

none

» progressId

body

integer(int32)

false

none

» userId

body

string¦null

false

none

» type

body

string

false

none

» status

body

string

false

none

» message

body

string¦null

false

none

» time

body

string(date-time)

false

none

» messageDetails

body

string¦null

false

none

» apiServer

body

string¦null

false

none

Enumerated Values

Parameter

Value

» type

Calculation

» type

Import

» type

Library

» type

Migration

» type

Task

» type

Time

» type

Optimization

» type

Preview

» type

BPMWorkflow

» type

PurgePeriods

» type

MakeEffective

» type

Publication

» type

Transformation

» type

Scheduler

» type

ScenarioPromote

» type

NotifyUsers

» type

HistoryPurge

» type

PushAnalyticsData

» type

ReapplyTemplate

» type

UpdateHistoryTracking

» type

ModifyCalendar

» type

TableClear

» type

IndexRebuild

» type

PayeePublication

» type

DeleteRows

» type

GenerateTasks

» type

QueryTool

» type

BPMWorkflowAddMember

» type

TableAlter

» type

Sync

» type

ModelEvaluation

» type

CalcAndLock

» type

Base64Conversion

» type

AlterTableAdditionalData

» type

BPMInquiryAutoAdjust

» type

MaterializedView

» type

PresenterReportThumbnail

» type

PlanApprovalsPDF

» type

CopyPaste

» type

CutPaste

» type

LGMConvert

» type

CDWTableInitialization

» type

CDWPopulateTable

» type

DMSTransfer

» type

PlanDocumentPDF

» type

BPMWorkflowRemoveMember

» type

ELTRun

» type

Replication

» status

Running

» status

Completed

» status

Failed

» status

Cancelled

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/completedactivities", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/completedactivities");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "progressId": 0,
  "userId": "string",
  "type": "Calculation",
  "status": "Running",
  "message": "string",
  "time": "2019-08-24T14:15:22Z",
  "messageDetails": "string",
  "apiServer": "string"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/completedactivities',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/completedactivities', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/completedactivities',
  params: {
  }, headers: headers

p JSON.parse(result)

CompletedActivitiesControllerV1_DeleteAllFinished

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/completedactivities", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/completedactivities");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/completedactivities',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/completedactivities')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/completedactivities',
  params: {
  }

p JSON.parse(result)

Get completed activity by ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Id

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.CompletedActivityDTO Varicent.RESTAPI.v1.DTOs.CompletedActivityDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/completedactivities/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/completedactivities/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/completedactivities/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/completedactivities/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/completedactivities/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "progressId": 0,
  "userId": "string",
  "type": "Calculation",
  "status": "Running",
  "message": "string",
  "time": "2019-08-24T14:15:22Z",
  "messageDetails": "string",
  "apiServer": "string"
}
{"progressId":0,"userId":"string","type":"Calculation","status":"Running","message":"string","time":"2019-08-24T14:15:22Z","messageDetails":"string","apiServer":"string"}

CompletedActivitiesControllerV1_Delete

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/completedactivities/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/completedactivities/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/completedactivities/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/completedactivities/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/completedactivities/{id}',
  params: {
  }

p JSON.parse(result)

Get live activities.

Returns no activities if user has no permission

Parameters

Name

In

Type

Required

Description

filter

query

string

false

####Supported operations

orderBy

query

string

false

####Description

limit

query

integer(int32)

false

Number of records to retrieve.

offset

query

integer(int32)

false

Offset number of records.

Detailed descriptions

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

type, time, status, progressid

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

time

limit: Number of records to retrieve.

Default: 50

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.LiveActivityDTO]

false

none

none

» progressId

integer(int32)

false

none

none

» userId

string¦null

false

none

none

» type

string

false

none

none

» status

string

false

none

none

» message

string¦null

false

none

none

» time

string(date-time)

false

none

none

» messageDetails

string¦null

false

none

none

» apiServer

string¦null

false

none

none

» percent

integer(int32)

false

none

none

» description

string¦null

false

none

none

» hasDescription

boolean

false

none

none

» expiresAt

string(date-time)

false

none

none

» isCancellable

boolean

false

none

none

» isInitialization

boolean

false

none

none

» computationId

integer(int32)

false

none

none

» parentProgressId

integer(int32)¦null

false

none

none

Enumerated Values

Property

Value

type

Calculation

type

Import

type

Library

type

Migration

type

Task

type

Time

type

Optimization

type

Preview

type

BPMWorkflow

type

PurgePeriods

type

MakeEffective

type

Publication

type

Transformation

type

Scheduler

type

ScenarioPromote

type

NotifyUsers

type

HistoryPurge

type

PushAnalyticsData

type

ReapplyTemplate

type

UpdateHistoryTracking

type

ModifyCalendar

type

TableClear

type

IndexRebuild

type

PayeePublication

type

DeleteRows

type

GenerateTasks

type

QueryTool

type

BPMWorkflowAddMember

type

TableAlter

type

Sync

type

ModelEvaluation

type

CalcAndLock

type

Base64Conversion

type

AlterTableAdditionalData

type

BPMInquiryAutoAdjust

type

MaterializedView

type

PresenterReportThumbnail

type

PlanApprovalsPDF

type

CopyPaste

type

CutPaste

type

LGMConvert

type

CDWTableInitialization

type

CDWPopulateTable

type

DMSTransfer

type

PlanDocumentPDF

type

BPMWorkflowRemoveMember

type

ELTRun

type

Replication

status

Running

status

Completed

status

Failed

status

Cancelled

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/liveactivities", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/liveactivities");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/liveactivities',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/liveactivities', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/liveactivities',
  params: {
  }, headers: headers

p JSON.parse(result)

LiveActivitiesControllerV1_Get

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

payeeID

query

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.LiveActivityDTO Varicent.RESTAPI.v1.DTOs.LiveActivityDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/liveactivities/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/liveactivities/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/liveactivities/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/liveactivities/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/liveactivities/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "progressId": 0,
  "userId": "string",
  "type": "Calculation",
  "status": "Running",
  "message": "string",
  "time": "2019-08-24T14:15:22Z",
  "messageDetails": "string",
  "apiServer": "string",
  "percent": 0,
  "description": "string",
  "hasDescription": true,
  "expiresAt": "2019-08-24T14:15:22Z",
  "isCancellable": true,
  "isInitialization": true,
  "computationId": 0,
  "parentProgressId": 0
}
{"progressId":0,"userId":"string","type":"Calculation","status":"Running","message":"string","time":"2019-08-24T14:15:22Z","messageDetails":"string","apiServer":"string","percent":0,"description":"string","hasDescription":true,"expiresAt":"2019-08-24T14:15:22Z","isCancellable":true,"isInitialization":true,"computationId":0,"parentProgressId":0}

Update a live activity by ID.

Body parameter

{
  "progressId": 0,
  "userId": "string",
  "type": "Calculation",
  "status": "Running",
  "message": "string",
  "time": "2019-08-24T14:15:22Z",
  "messageDetails": "string",
  "apiServer": "string",
  "percent": 0,
  "description": "string",
  "hasDescription": true,
  "expiresAt": "2019-08-24T14:15:22Z",
  "isCancellable": true,
  "isInitialization": true,
  "computationId": 0,
  "parentProgressId": 0
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.LiveActivityDTO

false

none

» progressId

body

integer(int32)

false

none

» userId

body

string¦null

false

none

» type

body

string

false

none

» status

body

string

false

none

» message

body

string¦null

false

none

» time

body

string(date-time)

false

none

» messageDetails

body

string¦null

false

none

» apiServer

body

string¦null

false

none

» percent

body

integer(int32)

false

none

» description

body

string¦null

false

none

» hasDescription

body

boolean

false

none

» expiresAt

body

string(date-time)

false

none

» isCancellable

body

boolean

false

none

» isInitialization

body

boolean

false

none

» computationId

body

integer(int32)

false

none

» parentProgressId

body

integer(int32)¦null

false

none

Enumerated Values

Parameter

Value

» type

Calculation

» type

Import

» type

Library

» type

Migration

» type

Task

» type

Time

» type

Optimization

» type

Preview

» type

BPMWorkflow

» type

PurgePeriods

» type

MakeEffective

» type

Publication

» type

Transformation

» type

Scheduler

» type

ScenarioPromote

» type

NotifyUsers

» type

HistoryPurge

» type

PushAnalyticsData

» type

ReapplyTemplate

» type

UpdateHistoryTracking

» type

ModifyCalendar

» type

TableClear

» type

IndexRebuild

» type

PayeePublication

» type

DeleteRows

» type

GenerateTasks

» type

QueryTool

» type

BPMWorkflowAddMember

» type

TableAlter

» type

Sync

» type

ModelEvaluation

» type

CalcAndLock

» type

Base64Conversion

» type

AlterTableAdditionalData

» type

BPMInquiryAutoAdjust

» type

MaterializedView

» type

PresenterReportThumbnail

» type

PlanApprovalsPDF

» type

CopyPaste

» type

CutPaste

» type

LGMConvert

» type

CDWTableInitialization

» type

CDWPopulateTable

» type

DMSTransfer

» type

PlanDocumentPDF

» type

BPMWorkflowRemoveMember

» type

ELTRun

» type

Replication

» status

Running

» status

Completed

» status

Failed

» status

Cancelled

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

400

Bad Request

Activity not cancellable, or status not set to Cancelled

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/liveactivities/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/liveactivities/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "progressId": 0,
  "userId": "string",
  "type": "Calculation",
  "status": "Running",
  "message": "string",
  "time": "2019-08-24T14:15:22Z",
  "messageDetails": "string",
  "apiServer": "string",
  "percent": 0,
  "description": "string",
  "hasDescription": true,
  "expiresAt": "2019-08-24T14:15:22Z",
  "isCancellable": true,
  "isInitialization": true,
  "computationId": 0,
  "parentProgressId": 0
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/liveactivities/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/liveactivities/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/liveactivities/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

Audit

Get audit log entries.

Parameters

Name

In

Type

Required

Description

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

orderBy

query

string

false

####Description

filter

query

string

false

####Supported operations

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

time

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

time, usertype, userid, module, eventname

Responses

Status

Meaning

Description

Schema

200

OK

Get all Audit Log Items (limit, offset, date order, filter supported)

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.AuditItemDTO]

false

none

none

» id

integer(int32)

false

none

none

» userType

string

false

none

none

» userId

string¦null

false

none

none

» module

string¦null

false

none

none

» eventName

string¦null

false

none

none

» time

string(date-time)

false

none

none

» revisionStart

integer(int32)¦null

false

none

none

» revisionEnd

integer(int32)¦null

false

none

none

» message

string¦null

false

none

none

» hasHistory

boolean

false

none

none

Enumerated Values

Property

Value

userType

Admin

userType

Web

userType

Anonymous

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/auditlog", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/auditlog");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/auditlog',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/auditlog', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/auditlog',
  params: {
  }, headers: headers

p JSON.parse(result)

Get an audit log item by its ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Audit Item Id

Responses

Status

Meaning

Description

Schema

200

OK

Get Audit Log Item by Id

Varicent.RESTAPI.v1.DTOs.AuditItemDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/auditlog/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/auditlog/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/auditlog/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/auditlog/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/auditlog/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "userType": "Admin",
  "userId": "string",
  "module": "string",
  "eventName": "string",
  "time": "2019-08-24T14:15:22Z",
  "revisionStart": 0,
  "revisionEnd": 0,
  "message": "string",
  "hasHistory": true
}
{"id":0,"userType":"Admin","userId":"string","module":"string","eventName":"string","time":"2019-08-24T14:15:22Z","revisionStart":0,"revisionEnd":0,"message":"string","hasHistory":true}

Get an audit log’s entry details by its ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Audit item Id

index

path

integer(int32)

true

none

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

Responses

Status

Meaning

Description

Schema

200

OK

Get Audit Log Details By Id

Varicent.RESTAPI.v1.DTOs.AuditItemDetailsDTOVaricent.RESTAPI.v1.DTOs.AuditItemDetailsDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/auditlog/{id}/details/{index}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/auditlog/{id}/details/{index}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/auditlog/{id}/details/{index}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/auditlog/{id}/details/{index}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/auditlog/{id}/details/{index}',
  params: {
  }, headers: headers

p JSON.parse(result)

Export audit logs.

Parameters

Name

In

Type

Required

Description

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

orderBy

query

string

false

####Description

filter

query

string

false

####Supported operations

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 5000

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

time

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

time, usertype, userid, module, eventname

Responses

Status

Meaning

Description

Schema

200

OK

Export audit logs

Varicent.RESTAPI.v1.DTOs.FileContentDTOVaricent.RESTAPI.v1.DTOs.FileContentDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/auditlog/export", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/auditlog/export");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/auditlog/export',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/auditlog/export', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/auditlog/export',
  params: {
  }, headers: headers

p JSON.parse(result)

Get audit export error log items.

Parameters

Name

In

Type

Required

Description

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

orderBy

query

string

false

####Description

filter

query

string

false

####Supported operations

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

timestamp, table, summary

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

timestamp, table, summary

Responses

Status

Meaning

Description

Schema

200

OK

Get all Audit Export Error Log Items (limit, offset, date order, filter supported)

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.Logs.ExportExceptionLogDTO]

false

none

none

» logID

integer(int32)

false

read-only

none

» table

string¦null

false

read-only

none

» summary

string¦null

false

read-only

none

» importName

string¦null

false

read-only

none

» timestamp

string(date-time)

false

none

none

» error

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/auditexports", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/auditexports");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/auditexports',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/auditexports', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/auditexports',
  params: {
  }, headers: headers

p JSON.parse(result)

Get details of export exception log by id.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get details of export exception log by id.

RESTAPI.v1.DTOs.Logs.ExportExceptionLogDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/auditexports/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/auditexports/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/auditexports/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/auditexports/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/auditexports/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "logID": 0,
  "table": "string",
  "summary": "string",
  "importName": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "error": "string"
}
{"logID":0,"table":"string","summary":"string","importName":"string","timestamp":"2019-08-24T14:15:22Z","error":"string"}

Get audit import error log items.

Parameters

Name

In

Type

Required

Description

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

orderBy

query

string

false

####Description

filter

query

string

false

####Supported operations

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

timestamp, importName, table, summary, logID

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

timestamp, importName, table, summary, logID

Responses

Status

Meaning

Description

Schema

200

OK

Get all Audit Import Error Log Items (limit, offset, date order, filter supported)

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.Logs.ImportExceptionLogDTO]

false

none

none

» logID

integer(int32)

false

read-only

none

» table

string¦null

false

read-only

none

» summary

string¦null

false

read-only

none

» importName

string¦null

false

read-only

none

» timestamp

string(date-time)

false

none

none

» error

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/auditimports", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/auditimports");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/auditimports',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/auditimports', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/auditimports',
  params: {
  }, headers: headers

p JSON.parse(result)

Get details of import exception log by id.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get details of import exception log by id

RESTAPI.v1.DTOs.Logs.ImportExceptionLogDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/auditimports/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/auditimports/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/auditimports/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/auditimports/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/auditimports/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "logID": 0,
  "table": "string",
  "summary": "string",
  "importName": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "error": "string"
}
{"logID":0,"table":"string","summary":"string","importName":"string","timestamp":"2019-08-24T14:15:22Z","error":"string"}

Get audit scheduler error log items.

Parameters

Name

In

Type

Required

Description

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

orderBy

query

string

false

####Description

filter

query

string

false

####Supported operations

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

entry, timestamp

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

entry, timestamp

Responses

Status

Meaning

Description

Schema

200

OK

Get all Audit Scheduler Error Log Items (limit, offset, date order, filter supported)

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.AuditErrorItemDTO]

false

none

none

» timestamp

string(date-time)

false

none

none

» error

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/auditschedulers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/auditschedulers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/auditschedulers',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/auditschedulers', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/auditschedulers',
  params: {
  }, headers: headers

p JSON.parse(result)

Get audit PPO error log items.

Parameters

Name

In

Type

Required

Description

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

orderBy

query

string

false

####Description

filter

query

string

false

####Supported operations

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

entry, timestamp

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

entry, timestamp

Responses

Status

Meaning

Description

Schema

200

OK

Get all Audit PPO Error Log Items (limit, offset, date order, filter supported)

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.AuditErrorItemDTO]

false

none

none

» timestamp

string(date-time)

false

none

none

» error

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/auditppoerrorlogs", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/auditppoerrorlogs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/auditppoerrorlogs',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/auditppoerrorlogs', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/auditppoerrorlogs',
  params: {
  }, headers: headers

p JSON.parse(result)

Get audit task error log items.

Parameters

Name

In

Type

Required

Description

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

filter

query

string

false

####Supported operations

orderBy

query

string

false

####Description

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

summary, timestamp

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

summary, timestamp

Responses

Status

Meaning

Description

Schema

200

OK

Get all Audit Task Error Log Items (limit, offset, date order, filter supported)

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.AuditErrorItemDTO]

false

none

none

» timestamp

string(date-time)

false

none

none

» error

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/uservisiblesystemtables/LogTask/data", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/uservisiblesystemtables/LogTask/data");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/uservisiblesystemtables/LogTask/data',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/uservisiblesystemtables/LogTask/data', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/uservisiblesystemtables/LogTask/data',
  params: {
  }, headers: headers

p JSON.parse(result)

Get User Ids (Admin, Payee)

Responses

Status

Meaning

Description

Schema

200

OK

Get all audit users (admin, payee)

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/auditusers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/auditusers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/auditusers',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/auditusers', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/auditusers',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  "string"
]
["string"]

Get audit log signature entries.

Parameters

Name

In

Type

Required

Description

field

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get all Audit Log Signature Item of a specific column

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/auditsignaturelog/{field}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/auditsignaturelog/{field}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/auditsignaturelog/{field}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/auditsignaturelog/{field}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/auditsignaturelog/{field}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  "string"
]
["string"]

Clears the service exception log up to the given date

Body parameter

{
  "property1": "string",
  "property2": "string"
}

Parameters

Name

In

Type

Required

Description

body

body

object

false

none

» additionalProperties

body

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Clears the service exception log

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/auditsignaturelog", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/auditsignaturelog");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "property1": "string",
  "property2": "string"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/auditsignaturelog',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.delete('http://localhost:8080/api/v1/auditsignaturelog', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.delete 'http://localhost:8080/api/v1/auditsignaturelog',
  params: {
  }, headers: headers

p JSON.parse(result)

Records the login of a user in the audit log

Body parameter

{
  "userIds": [
    "string"
  ],
  "modelMap": {
    "property1": "string",
    "property2": "string"
  },
  "featureFlagsMap": {
    "property1": "string",
    "property2": "string"
  },
  "eventName": "string",
  "targetUser": "string",
  "name": "string",
  "adminUserAuditLogEnabled": true
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.AdminUserAuditLogDTO

false

none

» userIds

body

[string]¦null

false

none

» modelMap

body

object¦null

false

none

»» additionalProperties

body

string¦null

false

none

» featureFlagsMap

body

object¦null

false

none

»» additionalProperties

body

string¦null

false

none

» eventName

body

string¦null

false

none

» targetUser

body

string¦null

false

none

» name

body

string¦null

false

none

» adminUserAuditLogEnabled

body

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Generic log for admin

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/adminAuditLog", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/adminAuditLog");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "userIds": [
    "string"
  ],
  "modelMap": {
    "property1": "string",
    "property2": "string"
  },
  "featureFlagsMap": {
    "property1": "string",
    "property2": "string"
  },
  "eventName": "string",
  "targetUser": "string",
  "name": "string",
  "adminUserAuditLogEnabled": true
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/adminAuditLog',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/adminAuditLog', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/adminAuditLog',
  params: {
  }, headers: headers

p JSON.parse(result)

Records the logout of a user in the audit log

Body parameter

{
  "property1": "string",
  "property2": "string"
}

Parameters

Name

In

Type

Required

Description

body

body

object

false

none

» additionalProperties

body

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Logs a payee user logout into the audit log

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/auditlog/logpayeelogout", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/auditlog/logpayeelogout");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "property1": "string",
  "property2": "string"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/auditlog/logpayeelogout',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/auditlog/logpayeelogout', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/auditlog/logpayeelogout',
  params: {
  }, headers: headers

p JSON.parse(result)

Send Sales Portal Usage Log Data to Kinesis Data Stream

Body parameter

{
  "salesPortalActionCategory": "string",
  "salesPortalModuleName": "string",
  "salesPortalSubModuleName": "string",
  "salesPortalURL": "string",
  "salesPortalWebTabName": "string",
  "salesPortalWebTabType": "string",
  "salesPortalReportName": "string",
  "salesPortalReportTimestamp": "2019-08-24T14:15:22Z"
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.AuditLogSalesPortalUsageLogsDTO

false

none

» salesPortalActionCategory

body

string¦null

false

none

» salesPortalModuleName

body

string¦null

false

none

» salesPortalSubModuleName

body

string¦null

false

none

» salesPortalURL

body

string¦null

false

none

» salesPortalWebTabName

body

string¦null

false

none

» salesPortalWebTabType

body

string¦null

false

none

» salesPortalReportName

body

string¦null

false

none

» salesPortalReportTimestamp

body

string(date-time)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Send Sales Portal Usage Log Data to Kinesis Data Stream

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/auditlog/salesPortalUsageLogs", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/auditlog/salesPortalUsageLogs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "salesPortalActionCategory": "string",
  "salesPortalModuleName": "string",
  "salesPortalSubModuleName": "string",
  "salesPortalURL": "string",
  "salesPortalWebTabName": "string",
  "salesPortalWebTabType": "string",
  "salesPortalReportName": "string",
  "salesPortalReportTimestamp": "2019-08-24T14:15:22Z"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/auditlog/salesPortalUsageLogs',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/auditlog/salesPortalUsageLogs', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/auditlog/salesPortalUsageLogs',
  params: {
  }, headers: headers

p JSON.parse(result)

Get computation log items.

Parameters

Name

In

Type

Required

Description

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

orderBy

query

string

false

####Description

filter

query

string

false

####Supported operations

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

start, batchid, status, duration, type, incremental, calcscount

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

start, batchid, type, incremental

Responses

Status

Meaning

Description

Schema

200

OK

Get all Computation Log Items (limit, offset, date order, filter supported)

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/computationlog", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/computationlog");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/computationlog',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/computationlog', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/computationlog',
  params: {
  }, headers: headers

p JSON.parse(result)

Get computation log item by ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Computation Log ID

Responses

Status

Meaning

Description

Schema

200

OK

Get Computation Log Item by Id

Varicent.RESTAPI.v1.DTOs.ComputationLogItemDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/computationlog/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/computationlog/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/computationlog/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/computationlog/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/computationlog/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "computationId": 0,
  "clientVersion": "string",
  "databaseVersion": 0,
  "start": "2019-08-24T14:15:22Z",
  "duration": "string",
  "incremental": 0,
  "type": 0,
  "status": 0,
  "calcsCount": 0,
  "events": [
    {
      "batchId": 0,
      "computationEventId": 0,
      "name": "string",
      "runningTime": 0,
      "finished": true,
      "calcId": 0,
      "calcMethod": "string",
      "status": "string",
      "syncRunningTime": 0,
      "skipped": true,
      "details": [],
      "start": "2019-08-24T14:15:22Z",
      "end": "2019-08-24T14:15:22Z",
      "duration": "string",
      "syncDuration": "string"
    }
  ]
}
{"computationId":0,"clientVersion":"string","databaseVersion":0,"start":"2019-08-24T14:15:22Z","duration":"string","incremental":0,"type":0,"status":0,"calcsCount":0,"events":[{"batchId":0,"computationEventId":0,"name":"string","runningTime":0,"finished":true,"calcId":0,"calcMethod":"string","status":"string","syncRunningTime":0,"skipped":true,"details":[],"start":"2019-08-24T14:15:22Z","end":"2019-08-24T14:15:22Z","duration":"string","syncDuration":"string"}]}

Get computation chart item by ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Computation Log ID

Responses

Status

Meaning

Description

Schema

200

OK

Get Computation Chart Item by Id

Varicent.RESTAPI.v1.DTOs.ComputationChartDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/computationchart/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/computationchart/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/computationchart/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/computationchart/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/computationchart/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "status": 0,
  "durationInMs": 0,
  "computationChartTasks": [
    {
      "name": "string",
      "calcId": 0,
      "durationMilliseconds": 0,
      "startDate": 0,
      "endDate": 0,
      "taskName": "string",
      "status": 0,
      "taskStatus": 0,
      "elementId": 0,
      "parentBlockId": 0,
      "tableName": "string"
    }
  ]
}
{"status":0,"durationInMs":0,"computationChartTasks":[{"name":"string","calcId":0,"durationMilliseconds":0,"startDate":0,"endDate":0,"taskName":"string","status":0,"taskStatus":0,"elementId":0,"parentBlockId":0,"tableName":"string"}]}

Get Plan Builder Computation Events by ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

orderBy

query

string

false

####Description

filter

query

string

false

####Supported operations

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

name, status, startDate, endDate, calculationDuration, method

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

name, status, startDate, method

Responses

Status

Meaning

Description

Schema

200

OK

Get Plan Builder Computation Events. (limit, offset, date order, filter supported)

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.PlanBuilderCalculationEventDTO]

false

none

none

» computationEventID

integer(int32)

false

none

none

» computationID

integer(int32)

false

none

none

» planBuilderCalculationID

string¦null

false

none

none

» name

string¦null

false

none

none

» finished

boolean

false

none

none

» startDate

string(date-time)¦null

false

none

none

» endDate

string(date-time)¦null

false

none

none

» calculationDuration

integer(int32)

false

none

none

» syncBackDuration

integer(int32)

false

none

none

» method

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/computationlog/{id}/planbuilderevents", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/computationlog/{id}/planbuilderevents");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/computationlog/{id}/planbuilderevents',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/computationlog/{id}/planbuilderevents', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/computationlog/{id}/planbuilderevents',
  params: {
  }, headers: headers

p JSON.parse(result)

Get database object rename log items.

Parameters

Name

In

Type

Required

Description

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 5

Responses

Status

Meaning

Description

Schema

200

OK

Get all DB Object Rename Log Items (limit, offset supported)

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.DBObjectsRenameLogsDTO]

false

none

none

» logID

integer(int32)

false

none

none

» actionTime

string(date-time)

false

none

none

» inputValue

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/renamelog", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/renamelog");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/renamelog',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/renamelog', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/renamelog',
  params: {
  }, headers: headers

p JSON.parse(result)

Get database object rename log item detail by ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

DB Object Rename Log ID

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 10

Responses

Status

Meaning

Description

Schema

200

OK

Get DB Object Rename Log Item by Id

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.DBObjectsRenameLogDetailsDTO]

false

none

none

» logID

integer(int32)

false

none

none

» actionType

string¦null

false

none

none

» actionStatus

string¦null

false

none

none

» updateCount

integer(int32)

false

none

none

» itemToUpdate

string¦null

false

none

none

» oldValue

string¦null

false

none

none

» newValue

string¦null

false

none

none

» errorMessage

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/renamelog/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/renamelog/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/renamelog/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/renamelog/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/renamelog/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

Batch

PerformanceBatchComparisonsControllerV1_Get

Parameters

Name

In

Type

Required

Description

id

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.PerformanceBatchComparisonDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/performancebatchcomparisons/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/performancebatchcomparisons/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/performancebatchcomparisons/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/performancebatchcomparisons/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/performancebatchcomparisons/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "baseComputation": {
    "batchId": 0,
    "status": "Started",
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z",
    "duration": "string",
    "computationEvents": [
      {}
    ],
    "type": "All",
    "clientVersion": "string",
    "databaseVersion": 0,
    "incremental": "No",
    "calculationsCount": 0
  },
  "targetComputation": {
    "batchId": 0,
    "status": "Started",
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z",
    "duration": "string",
    "computationEvents": [
      {}
    ],
    "type": "All",
    "clientVersion": "string",
    "databaseVersion": 0,
    "incremental": "No",
    "calculationsCount": 0
  },
  "comparisonItems": [
    {
      "id": 0,
      "name": "string",
      "baseDuration": 0.1,
      "targetDuration": 0.1,
      "delta": 0.1,
      "baseMethod": "string",
      "targetMethod": "string",
      "planBuilderCalculationId": "string",
      "planBuilderParentFolderName": "string"
    }
  ]
}
{"baseComputation":{"batchId":0,"status":"Started","start":"2019-08-24T14:15:22Z","end":"2019-08-24T14:15:22Z","duration":"string","computationEvents":[{}],"type":"All","clientVersion":"string","databaseVersion":0,"incremental":"No","calculationsCount":0},"targetComputation":{"batchId":0,"status":"Started","start":"2019-08-24T14:15:22Z","end":"2019-08-24T14:15:22Z","duration":"string","computationEvents":[{}],"type":"All","clientVersion":"string","databaseVersion":0,"incremental":"No","calculationsCount":0},"comparisonItems":[{"id":0,"name":"string","baseDuration":0.1,"targetDuration":0.1,"delta":0.1,"baseMethod":"string","targetMethod":"string","planBuilderCalculationId":"string","planBuilderParentFolderName":"string"}]}

Calculation

Get calculations.

Parameters

Name

In

Type

Required

Description

filter

query

string

false

####Supported operations

Detailed descriptions

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

name, type

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.NavigationCalculationElementDTO]

false

none

none

» parentBlockId

integer(int32)

false

none

none

» elementId

integer(int32)

false

none

none

» calculationId

integer(int32)

false

none

none

» calculationType

string¦null

false

none

none

» name

string¦null

false

none

none

» comment

string¦null

false

none

none

» isFavourite

boolean

false

none

none

» sourceTables

[string]¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/calculations", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/calculations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/calculations',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/calculations', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/calculations',
  params: {
  }, headers: headers

p JSON.parse(result)

CalculationsControllerV1_Post

Body parameter

{
  "calculation": {
    "calculationId": 0,
    "calculationType": "Mathematical",
    "name": "string",
    "comment": "string",
    "hasOutputGroups": true,
    "source": "string",
    "usesLeftJoin": true,
    "calendar": "string",
    "timePartitionPath": "string",
    "timeLevel": "string",
    "resetLevel": "string",
    "timeStart": {},
    "timeEnd": {},
    "isCurrent": true,
    "outputTable": "string",
    "previewId": 0,
    "previewTable": "string",
    "rowVersion": {
      "rowVersion": 0
    },
    "restrictions": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "mainSourceRestrictions": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "partitions": [
      {}
    ],
    "lookups": [
      {}
    ],
    "unions": [
      {}
    ],
    "traceColumns": [
      {}
    ],
    "executionPaths": [
      "LimitAll"
    ],
    "references": {
      "property1": {},
      "property2": {}
    },
    "timeReferences": {
      "property1": {},
      "property2": {}
    },
    "sourceColumns": [
      {}
    ],
    "sourceKeyColumns": [
      {}
    ],
    "outputColumns": [
      {}
    ],
    "calculationDataId": 0,
    "formulas": {
      "property1": "string",
      "property2": "string"
    },
    "formulaOrder": {
      "property1": 0,
      "property2": 0
    },
    "pipeConnection": {
      "pipeID": "string",
      "inputID": "string",
      "outputID": "string",
      "outputName": "string",
      "lastValidated": "2019-08-24T14:15:22Z",
      "inputMapping": [],
      "outputMapping": []
    },
    "sortColumns": [
      {}
    ],
    "limit": 0,
    "sortDirection": "Ascending",
    "rankType": "Standard",
    "timeColumn": "string",
    "timeId": "string",
    "levelId": "string",
    "shift": 0,
    "categories": [
      {}
    ],
    "timeLockStart": "2019-08-24T14:15:22Z",
    "timeLockEnd": "2019-08-24T14:15:22Z",
    "timeLockCalendar": "string"
  },
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Composer.CalculationElementDTO

false

none

» calculation

body

Varicent.RESTAPI.v1.DTOs.Calculations.CalculationDTO

false

none

»» calculationId

body

integer(int32)

false

none

»» calculationType

body

string

false

none

»» name

body

string¦null

false

none

»» comment

body

string¦null

false

none

»» hasOutputGroups

body

boolean

false

none

»» source

body

string¦null

false

none

»» usesLeftJoin

body

boolean

false

none

»» calendar

body

string¦null

false

none

»» timePartitionPath

body

string¦null

false

none

»» timeLevel

body

string¦null

false

none

»» resetLevel

body

string¦null

false

none

»» timeStart

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»» timeEnd

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»» isCurrent

body

boolean

false

none

»» outputTable

body

string¦null

false

none

»» previewId

body

integer(int32)

false

none

»» previewTable

body

string¦null

false

none

»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» rowVersion

body

integer(int64)

false

none

»» restrictions

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» constraintType

body

string

false

none

»»» op

body

string¦null

false

none

»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» expressionType

body

string

false

none

»»»» cases

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» op

body

string¦null

false

none

»»»» arguments

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» condition

body

any

false

none

»»»» trueValue

body

any

false

none

»»»» falseValue

body

any

false

none

»»»» isDate

body

boolean

false

none

»»»» literalType

body

string

false

none

»»»» value

body

any

false

none

»»» caseSensitive

body

boolean

false

none

»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»» constraintType

body

string

false

none

»»»» op

body

string¦null

false

none

»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» caseSensitive

body

boolean

false

none

»»»» constraints

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» literalRight

body

any

false

none

»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» right

body

any

false

none

»»»» expressionLeft

body

any

false

none

»»»» expressionRight

body

any

false

none

»»»» isPreciseDecimal

body

boolean

false

none

»»»» like

body

string¦null

false

none

»»»» escapeWildcards

body

boolean

false

none

»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»» table

body

string¦null

false

none

»»»» queryDefinitionRight

body

any

false

none

»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» expressionType

body

string

false

none

»»»» cases

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» op

body

string¦null

false

none

»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»» trueValue

body

any

false

none

»»»»» falseValue

body

any

false

none

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» isDate

body

boolean

false

none

»»»» literalType

body

string

false

none

»»»» value

body

any

false

none

»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»» isPreciseDecimal

body

boolean

false

none

»»» like

body

string¦null

false

none

»»» escapeWildcards

body

boolean

false

none

»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» table

body

string¦null

false

none

»»» queryDefinitionRight

body

any

false

none

»» mainSourceRestrictions

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» partitions

body

[Varicent.RESTAPI.v1.DTOs.Calculations.PartitionDefinitionDTO]¦null

false

none

»»» source

body

string¦null

false

none

»»» outputGroup

body

string¦null

false

none

»»» isAccumulating

body

boolean

false

none

»»» userDefinedColumnName

body

string¦null

false

none

»» lookups

body

[Varicent.RESTAPI.v1.DTOs.Calculations.LookupDTO]¦null

false

none

»»» name

body

string¦null

false

none

»»» source

body

string¦null

false

none

»»» restrictions

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» unions

body

[Varicent.RESTAPI.v1.DTOs.Calculations.UnionDefinitionDTO]¦null

false

none

»»» sourceAlias

body

string¦null

false

none

»»» sourceColumns

body

[string]¦null

false

none

»»» unionTable

body

string¦null

false

none

»»» unionColumns

body

[string]¦null

false

none

»» traceColumns

body

[Varicent.RESTAPI.v1.DTOs.Calculations.TraceColumnDTO]¦null

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» type

body

string

false

none

»» executionPaths

body

[string]¦null

false

none

»» references

body

object¦null

false

none

»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.DataItemDTO

false

none

»»»» path

body

RESTAPI.v1.DTOs.DataPathDTO

false

none

»»»»» path

body

[string]¦null

false

none

»»»» column

body

string¦null

false

none

»»»» alias

body

string¦null

false

none

»» timeReferences

body

object¦null

false

none

»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»»» levelId

body

string¦null

false

none

»»»» timeId

body

string¦null

false

none

»» sourceColumns

body

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

»»» name

body

string¦null

false

none

»»» type

body

string

false

none

»»» isKey

body

boolean

false

none

»»» nullable

body

boolean

false

none

»»» values

body

string¦null

false

none

»»» lockedPeriod

body

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

»»»» start

body

string(date-time)

false

none

»»»» end

body

string(date-time)

false

none

»»» referencedCol

body

string¦null

false

none

»»» picklistFilter

body

string¦null

false

none

»»» displayName

body

string¦null

false

none

»»» isELTPeriod

body

boolean¦null

false

none

»» sourceKeyColumns

body

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

»» outputColumns

body

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

»» calculationDataId

body

integer(int32)¦null

false

none

»» formulas

body

object¦null

false

none

»»» additionalProperties

body

string¦null

false

none

»» formulaOrder

body

object¦null

false

none

»»» additionalProperties

body

integer(int32)¦null

false

none

»» pipeConnection

body

Varicent.RESTAPI.v1.DTOs.Symon.PipeConnectionDTO

false

none

»»» pipeID

body

string¦null

false

none

»»» inputID

body

string¦null

false

none

»»» outputID

body

string¦null

false

none

»»» outputName

body

string¦null

false

none

»»» lastValidated

body

string(date-time)

false

none

»»» inputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»»»» source

body

string¦null

false

none

»»»» destination

body

string¦null

false

none

»»»» type

body

string

false

none

»»» outputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»» sortColumns

body

[Varicent.RESTAPI.v1.DTOs.DataItemDTO]¦null

false

none

»» limit

body

integer(int32)

false

none

»» sortDirection

body

string

false

none

»» rankType

body

string

false

none

»» timeColumn

body

string¦null

false

none

»» timeId

body

string¦null

false

none

»» levelId

body

string¦null

false

none

»» shift

body

integer(int32)

false

none

»» categories

body

[Varicent.RESTAPI.v1.DTOs.Calculations.CalculationCategoryDTO]¦null

false

none

»»» categoryId

body

integer(int32)

false

none

»»» name

body

string¦null

false

none

»»» clause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» timeLockStart

body

string(date-time)

false

none

»» timeLockEnd

body

string(date-time)

false

none

»» timeLockCalendar

body

string¦null

false

none

» elementId

body

integer(int32)

false

none

» parentBlockId

body

integer(int32)¦null

false

none

» bounds

body

System.Drawing.RectangleF

false

none

»» location

body

System.Drawing.PointF

false

none

»»» isEmpty

body

boolean

false

none

»»» x

body

number(float)

false

none

»»» y

body

number(float)

false

none

»» size

body

string

false

none

»» x

body

number(float)

false

none

»» y

body

number(float)

false

none

»» width

body

number(float)

false

none

»» height

body

number(float)

false

none

»» left

body

number(float)

false

none

»» top

body

number(float)

false

none

»» right

body

number(float)

false

none

»» bottom

body

number(float)

false

none

»» isEmpty

body

boolean

false

none

» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»» a

body

integer(int32)

false

none

»» b

body

integer(int32)

false

none

»» g

body

integer(int32)

false

none

»» r

body

integer(int32)

false

none

» name

body

string¦null

false

none

» parentBlock

body

Varicent.RESTAPI.v1.DTOs.Composer.ExpandableBlockElementDTO

false

none

»» id

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» href

body

string¦null

false

none

» isVisible

body

boolean

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

»» calculationType

Mathematical

»» calculationType

Sorting

»» calculationType

TimeShift

»» calculationType

Category

»» calculationType

Symon

»»» constraintType

clause

»»» constraintType

constraint

»»» constraintType

expressionConstraint

»»» constraintType

likeConstraint

»»» constraintType

rowVersionConstraint

»»» constraintType

subQueryConstraint

»»»» expressionType

caseExpression

»»»» expressionType

dataField

»»»» expressionType

function

»»»» expressionType

ifExpression

»»»» expressionType

literal

»»»» literalType

Integer

»»»» literalType

Decimal

»»»» literalType

Date

»»»» literalType

DateTime

»»»» literalType

String

»»»» literalType

Float

»»»» literalType

Long

»»»» literalType

Null

»»»» literalType

Parameter

»»»» literalType

Guid

»»»» literalType

SystemUtcTime

»»»» literalType

Boolean

»»»» constraintType

clause

»»»» constraintType

constraint

»»»» constraintType

expressionConstraint

»»»» constraintType

likeConstraint

»»»» constraintType

rowVersionConstraint

»»»» constraintType

subQueryConstraint

»»»» expressionType

caseExpression

»»»» expressionType

dataField

»»»» expressionType

function

»»»» expressionType

ifExpression

»»»» expressionType

literal

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» literalType

Integer

»»»» literalType

Decimal

»»»» literalType

Date

»»»» literalType

DateTime

»»»» literalType

String

»»»» literalType

Float

»»»» literalType

Long

»»»» literalType

Null

»»»» literalType

Parameter

»»»» literalType

Guid

»»»» literalType

SystemUtcTime

»»»» literalType

Boolean

»»» type

String

»»» type

LongString

»»» type

MaxString

»»» type

Date

»»» type

DateTime

»»» type

Decimal

»»» type

Int

»»» type

Long

»»» type

Float

»»» type

BLOB

»»» type

Identity

»»» type

CLOB

»»» type

RowVersion

»»» type

UID

»»» type

VarCharMax

»»» type

Boolean

»» executionPaths

LimitAll

»» executionPaths

LimitOne

»» executionPaths

MaxDOP1

»» executionPaths

SingleThreadedMerge

»» executionPaths

DisableMerge

»» executionPaths

SQL2014Estimator

»» executionPaths

ForceClassic

»» executionPaths

DisablePostCalculationOptimization

»» executionPaths

UseIncrementalSyncback

»»» type

String

»»» type

LongString

»»» type

MaxString

»»» type

Date

»»» type

DateTime

»»» type

Decimal

»»» type

Int

»»» type

Long

»»» type

Float

»»» type

BLOB

»»» type

Identity

»»» type

CLOB

»»» type

RowVersion

»»» type

UID

»»» type

VarCharMax

»»» type

Boolean

»»»» type

String

»»»» type

Number

»»»» type

Boolean

»»»» type

Date

»» sortDirection

Ascending

»» sortDirection

Descending

»» rankType

Standard

»» rankType

Sequential

»» rankType

Dense

Responses

Status

Meaning

Description

Schema

200

OK

Create a new Calculation

Varicent.RESTAPI.v1.DTOs.Composer.CalculationElementDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/calculations", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/calculations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "calculation": {
    "calculationId": 0,
    "calculationType": "Mathematical",
    "name": "string",
    "comment": "string",
    "hasOutputGroups": true,
    "source": "string",
    "usesLeftJoin": true,
    "calendar": "string",
    "timePartitionPath": "string",
    "timeLevel": "string",
    "resetLevel": "string",
    "timeStart": {},
    "timeEnd": {},
    "isCurrent": true,
    "outputTable": "string",
    "previewId": 0,
    "previewTable": "string",
    "rowVersion": {
      "rowVersion": 0
    },
    "restrictions": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "mainSourceRestrictions": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "partitions": [
      {}
    ],
    "lookups": [
      {}
    ],
    "unions": [
      {}
    ],
    "traceColumns": [
      {}
    ],
    "executionPaths": [
      "LimitAll"
    ],
    "references": {
      "property1": {},
      "property2": {}
    },
    "timeReferences": {
      "property1": {},
      "property2": {}
    },
    "sourceColumns": [
      {}
    ],
    "sourceKeyColumns": [
      {}
    ],
    "outputColumns": [
      {}
    ],
    "calculationDataId": 0,
    "formulas": {
      "property1": "string",
      "property2": "string"
    },
    "formulaOrder": {
      "property1": 0,
      "property2": 0
    },
    "pipeConnection": {
      "pipeID": "string",
      "inputID": "string",
      "outputID": "string",
      "outputName": "string",
      "lastValidated": "2019-08-24T14:15:22Z",
      "inputMapping": [],
      "outputMapping": []
    },
    "sortColumns": [
      {}
    ],
    "limit": 0,
    "sortDirection": "Ascending",
    "rankType": "Standard",
    "timeColumn": "string",
    "timeId": "string",
    "levelId": "string",
    "shift": 0,
    "categories": [
      {}
    ],
    "timeLockStart": "2019-08-24T14:15:22Z",
    "timeLockEnd": "2019-08-24T14:15:22Z",
    "timeLockCalendar": "string"
  },
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/calculations',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/calculations', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/calculations',
  params: {
  }, headers: headers

p JSON.parse(result)

CalculationsControllerV1_Put

Body parameter

{
  "calculation": {
    "calculationId": 0,
    "calculationType": "Mathematical",
    "name": "string",
    "comment": "string",
    "hasOutputGroups": true,
    "source": "string",
    "usesLeftJoin": true,
    "calendar": "string",
    "timePartitionPath": "string",
    "timeLevel": "string",
    "resetLevel": "string",
    "timeStart": {},
    "timeEnd": {},
    "isCurrent": true,
    "outputTable": "string",
    "previewId": 0,
    "previewTable": "string",
    "rowVersion": {
      "rowVersion": 0
    },
    "restrictions": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "mainSourceRestrictions": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "partitions": [
      {}
    ],
    "lookups": [
      {}
    ],
    "unions": [
      {}
    ],
    "traceColumns": [
      {}
    ],
    "executionPaths": [
      "LimitAll"
    ],
    "references": {
      "property1": {},
      "property2": {}
    },
    "timeReferences": {
      "property1": {},
      "property2": {}
    },
    "sourceColumns": [
      {}
    ],
    "sourceKeyColumns": [
      {}
    ],
    "outputColumns": [
      {}
    ],
    "calculationDataId": 0,
    "formulas": {
      "property1": "string",
      "property2": "string"
    },
    "formulaOrder": {
      "property1": 0,
      "property2": 0
    },
    "pipeConnection": {
      "pipeID": "string",
      "inputID": "string",
      "outputID": "string",
      "outputName": "string",
      "lastValidated": "2019-08-24T14:15:22Z",
      "inputMapping": [],
      "outputMapping": []
    },
    "sortColumns": [
      {}
    ],
    "limit": 0,
    "sortDirection": "Ascending",
    "rankType": "Standard",
    "timeColumn": "string",
    "timeId": "string",
    "levelId": "string",
    "shift": 0,
    "categories": [
      {}
    ],
    "timeLockStart": "2019-08-24T14:15:22Z",
    "timeLockEnd": "2019-08-24T14:15:22Z",
    "timeLockCalendar": "string"
  },
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Composer.CalculationElementDTO

false

none

» calculation

body

Varicent.RESTAPI.v1.DTOs.Calculations.CalculationDTO

false

none

»» calculationId

body

integer(int32)

false

none

»» calculationType

body

string

false

none

»» name

body

string¦null

false

none

»» comment

body

string¦null

false

none

»» hasOutputGroups

body

boolean

false

none

»» source

body

string¦null

false

none

»» usesLeftJoin

body

boolean

false

none

»» calendar

body

string¦null

false

none

»» timePartitionPath

body

string¦null

false

none

»» timeLevel

body

string¦null

false

none

»» resetLevel

body

string¦null

false

none

»» timeStart

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»» timeEnd

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»» isCurrent

body

boolean

false

none

»» outputTable

body

string¦null

false

none

»» previewId

body

integer(int32)

false

none

»» previewTable

body

string¦null

false

none

»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» rowVersion

body

integer(int64)

false

none

»» restrictions

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» constraintType

body

string

false

none

»»» op

body

string¦null

false

none

»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» expressionType

body

string

false

none

»»»» cases

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» op

body

string¦null

false

none

»»»» arguments

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» condition

body

any

false

none

»»»» trueValue

body

any

false

none

»»»» falseValue

body

any

false

none

»»»» isDate

body

boolean

false

none

»»»» literalType

body

string

false

none

»»»» value

body

any

false

none

»»» caseSensitive

body

boolean

false

none

»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»» constraintType

body

string

false

none

»»»» op

body

string¦null

false

none

»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» caseSensitive

body

boolean

false

none

»»»» constraints

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» literalRight

body

any

false

none

»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» right

body

any

false

none

»»»» expressionLeft

body

any

false

none

»»»» expressionRight

body

any

false

none

»»»» isPreciseDecimal

body

boolean

false

none

»»»» like

body

string¦null

false

none

»»»» escapeWildcards

body

boolean

false

none

»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»» table

body

string¦null

false

none

»»»» queryDefinitionRight

body

any

false

none

»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» expressionType

body

string

false

none

»»»» cases

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» op

body

string¦null

false

none

»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»» trueValue

body

any

false

none

»»»»» falseValue

body

any

false

none

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» isDate

body

boolean

false

none

»»»» literalType

body

string

false

none

»»»» value

body

any

false

none

»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»» isPreciseDecimal

body

boolean

false

none

»»» like

body

string¦null

false

none

»»» escapeWildcards

body

boolean

false

none

»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» table

body

string¦null

false

none

»»» queryDefinitionRight

body

any

false

none

»» mainSourceRestrictions

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» partitions

body

[Varicent.RESTAPI.v1.DTOs.Calculations.PartitionDefinitionDTO]¦null

false

none

»»» source

body

string¦null

false

none

»»» outputGroup

body

string¦null

false

none

»»» isAccumulating

body

boolean

false

none

»»» userDefinedColumnName

body

string¦null

false

none

»» lookups

body

[Varicent.RESTAPI.v1.DTOs.Calculations.LookupDTO]¦null

false

none

»»» name

body

string¦null

false

none

»»» source

body

string¦null

false

none

»»» restrictions

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» unions

body

[Varicent.RESTAPI.v1.DTOs.Calculations.UnionDefinitionDTO]¦null

false

none

»»» sourceAlias

body

string¦null

false

none

»»» sourceColumns

body

[string]¦null

false

none

»»» unionTable

body

string¦null

false

none

»»» unionColumns

body

[string]¦null

false

none

»» traceColumns

body

[Varicent.RESTAPI.v1.DTOs.Calculations.TraceColumnDTO]¦null

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» type

body

string

false

none

»» executionPaths

body

[string]¦null

false

none

»» references

body

object¦null

false

none

»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.DataItemDTO

false

none

»»»» path

body

RESTAPI.v1.DTOs.DataPathDTO

false

none

»»»»» path

body

[string]¦null

false

none

»»»» column

body

string¦null

false

none

»»»» alias

body

string¦null

false

none

»» timeReferences

body

object¦null

false

none

»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»»» levelId

body

string¦null

false

none

»»»» timeId

body

string¦null

false

none

»» sourceColumns

body

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

»»» name

body

string¦null

false

none

»»» type

body

string

false

none

»»» isKey

body

boolean

false

none

»»» nullable

body

boolean

false

none

»»» values

body

string¦null

false

none

»»» lockedPeriod

body

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

»»»» start

body

string(date-time)

false

none

»»»» end

body

string(date-time)

false

none

»»» referencedCol

body

string¦null

false

none

»»» picklistFilter

body

string¦null

false

none

»»» displayName

body

string¦null

false

none

»»» isELTPeriod

body

boolean¦null

false

none

»» sourceKeyColumns

body

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

»» outputColumns

body

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

»» calculationDataId

body

integer(int32)¦null

false

none

»» formulas

body

object¦null

false

none

»»» additionalProperties

body

string¦null

false

none

»» formulaOrder

body

object¦null

false

none

»»» additionalProperties

body

integer(int32)¦null

false

none

»» pipeConnection

body

Varicent.RESTAPI.v1.DTOs.Symon.PipeConnectionDTO

false

none

»»» pipeID

body

string¦null

false

none

»»» inputID

body

string¦null

false

none

»»» outputID

body

string¦null

false

none

»»» outputName

body

string¦null

false

none

»»» lastValidated

body

string(date-time)

false

none

»»» inputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»»»» source

body

string¦null

false

none

»»»» destination

body

string¦null

false

none

»»»» type

body

string

false

none

»»» outputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»» sortColumns

body

[Varicent.RESTAPI.v1.DTOs.DataItemDTO]¦null

false

none

»» limit

body

integer(int32)

false

none

»» sortDirection

body

string

false

none

»» rankType

body

string

false

none

»» timeColumn

body

string¦null

false

none

»» timeId

body

string¦null

false

none

»» levelId

body

string¦null

false

none

»» shift

body

integer(int32)

false

none

»» categories

body

[Varicent.RESTAPI.v1.DTOs.Calculations.CalculationCategoryDTO]¦null

false

none

»»» categoryId

body

integer(int32)

false

none

»»» name

body

string¦null

false

none

»»» clause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» timeLockStart

body

string(date-time)

false

none

»» timeLockEnd

body

string(date-time)

false

none

»» timeLockCalendar

body

string¦null

false

none

» elementId

body

integer(int32)

false

none

» parentBlockId

body

integer(int32)¦null

false

none

» bounds

body

System.Drawing.RectangleF

false

none

»» location

body

System.Drawing.PointF

false

none

»»» isEmpty

body

boolean

false

none

»»» x

body

number(float)

false

none

»»» y

body

number(float)

false

none

»» size

body

string

false

none

»» x

body

number(float)

false

none

»» y

body

number(float)

false

none

»» width

body

number(float)

false

none

»» height

body

number(float)

false

none

»» left

body

number(float)

false

none

»» top

body

number(float)

false

none

»» right

body

number(float)

false

none

»» bottom

body

number(float)

false

none

»» isEmpty

body

boolean

false

none

» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»» a

body

integer(int32)

false

none

»» b

body

integer(int32)

false

none

»» g

body

integer(int32)

false

none

»» r

body

integer(int32)

false

none

» name

body

string¦null

false

none

» parentBlock

body

Varicent.RESTAPI.v1.DTOs.Composer.ExpandableBlockElementDTO

false

none

»» id

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» href

body

string¦null

false

none

» isVisible

body

boolean

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

»» calculationType

Mathematical

»» calculationType

Sorting

»» calculationType

TimeShift

»» calculationType

Category

»» calculationType

Symon

»»» constraintType

clause

»»» constraintType

constraint

»»» constraintType

expressionConstraint

»»» constraintType

likeConstraint

»»» constraintType

rowVersionConstraint

»»» constraintType

subQueryConstraint

»»»» expressionType

caseExpression

»»»» expressionType

dataField

»»»» expressionType

function

»»»» expressionType

ifExpression

»»»» expressionType

literal

»»»» literalType

Integer

»»»» literalType

Decimal

»»»» literalType

Date

»»»» literalType

DateTime

»»»» literalType

String

»»»» literalType

Float

»»»» literalType

Long

»»»» literalType

Null

»»»» literalType

Parameter

»»»» literalType

Guid

»»»» literalType

SystemUtcTime

»»»» literalType

Boolean

»»»» constraintType

clause

»»»» constraintType

constraint

»»»» constraintType

expressionConstraint

»»»» constraintType

likeConstraint

»»»» constraintType

rowVersionConstraint

»»»» constraintType

subQueryConstraint

»»»» expressionType

caseExpression

»»»» expressionType

dataField

»»»» expressionType

function

»»»» expressionType

ifExpression

»»»» expressionType

literal

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» literalType

Integer

»»»» literalType

Decimal

»»»» literalType

Date

»»»» literalType

DateTime

»»»» literalType

String

»»»» literalType

Float

»»»» literalType

Long

»»»» literalType

Null

»»»» literalType

Parameter

»»»» literalType

Guid

»»»» literalType

SystemUtcTime

»»»» literalType

Boolean

»»» type

String

»»» type

LongString

»»» type

MaxString

»»» type

Date

»»» type

DateTime

»»» type

Decimal

»»» type

Int

»»» type

Long

»»» type

Float

»»» type

BLOB

»»» type

Identity

»»» type

CLOB

»»» type

RowVersion

»»» type

UID

»»» type

VarCharMax

»»» type

Boolean

»» executionPaths

LimitAll

»» executionPaths

LimitOne

»» executionPaths

MaxDOP1

»» executionPaths

SingleThreadedMerge

»» executionPaths

DisableMerge

»» executionPaths

SQL2014Estimator

»» executionPaths

ForceClassic

»» executionPaths

DisablePostCalculationOptimization

»» executionPaths

UseIncrementalSyncback

»»» type

String

»»» type

LongString

»»» type

MaxString

»»» type

Date

»»» type

DateTime

»»» type

Decimal

»»» type

Int

»»» type

Long

»»» type

Float

»»» type

BLOB

»»» type

Identity

»»» type

CLOB

»»» type

RowVersion

»»» type

UID

»»» type

VarCharMax

»»» type

Boolean

»»»» type

String

»»»» type

Number

»»»» type

Boolean

»»»» type

Date

»» sortDirection

Ascending

»» sortDirection

Descending

»» rankType

Standard

»» rankType

Sequential

»» rankType

Dense

Responses

Status

Meaning

Description

Schema

200

OK

Update an existing calculation

Varicent.RESTAPI.v1.DTOs.Composer.CalculationElementDTO

202

Accepted

Start updating an existing calculation

Inline

Response Schema

Status Code 202

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/calculations", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/calculations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "calculation": {
    "calculationId": 0,
    "calculationType": "Mathematical",
    "name": "string",
    "comment": "string",
    "hasOutputGroups": true,
    "source": "string",
    "usesLeftJoin": true,
    "calendar": "string",
    "timePartitionPath": "string",
    "timeLevel": "string",
    "resetLevel": "string",
    "timeStart": {},
    "timeEnd": {},
    "isCurrent": true,
    "outputTable": "string",
    "previewId": 0,
    "previewTable": "string",
    "rowVersion": {
      "rowVersion": 0
    },
    "restrictions": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "mainSourceRestrictions": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "partitions": [
      {}
    ],
    "lookups": [
      {}
    ],
    "unions": [
      {}
    ],
    "traceColumns": [
      {}
    ],
    "executionPaths": [
      "LimitAll"
    ],
    "references": {
      "property1": {},
      "property2": {}
    },
    "timeReferences": {
      "property1": {},
      "property2": {}
    },
    "sourceColumns": [
      {}
    ],
    "sourceKeyColumns": [
      {}
    ],
    "outputColumns": [
      {}
    ],
    "calculationDataId": 0,
    "formulas": {
      "property1": "string",
      "property2": "string"
    },
    "formulaOrder": {
      "property1": 0,
      "property2": 0
    },
    "pipeConnection": {
      "pipeID": "string",
      "inputID": "string",
      "outputID": "string",
      "outputName": "string",
      "lastValidated": "2019-08-24T14:15:22Z",
      "inputMapping": [],
      "outputMapping": []
    },
    "sortColumns": [
      {}
    ],
    "limit": 0,
    "sortDirection": "Ascending",
    "rankType": "Standard",
    "timeColumn": "string",
    "timeId": "string",
    "levelId": "string",
    "shift": 0,
    "categories": [
      {}
    ],
    "timeLockStart": "2019-08-24T14:15:22Z",
    "timeLockEnd": "2019-08-24T14:15:22Z",
    "timeLockCalendar": "string"
  },
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/calculations',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/calculations', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/calculations',
  params: {
  }, headers: headers

p JSON.parse(result)

Get calculation by ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Calculation Id

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.Composer.CalculationElementDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/calculations/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/calculations/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/calculations/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/calculations/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/calculations/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "calculation": {
    "calculationId": 0,
    "calculationType": "Mathematical",
    "name": "string",
    "comment": "string",
    "hasOutputGroups": true,
    "source": "string",
    "usesLeftJoin": true,
    "calendar": "string",
    "timePartitionPath": "string",
    "timeLevel": "string",
    "resetLevel": "string",
    "timeStart": {},
    "timeEnd": {},
    "isCurrent": true,
    "outputTable": "string",
    "previewId": 0,
    "previewTable": "string",
    "rowVersion": {
      "rowVersion": 0
    },
    "restrictions": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "mainSourceRestrictions": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "partitions": [
      {}
    ],
    "lookups": [
      {}
    ],
    "unions": [
      {}
    ],
    "traceColumns": [
      {}
    ],
    "executionPaths": [
      "LimitAll"
    ],
    "references": {
      "property1": {},
      "property2": {}
    },
    "timeReferences": {
      "property1": {},
      "property2": {}
    },
    "sourceColumns": [
      {}
    ],
    "sourceKeyColumns": [
      {}
    ],
    "outputColumns": [
      {}
    ],
    "calculationDataId": 0,
    "formulas": {
      "property1": "string",
      "property2": "string"
    },
    "formulaOrder": {
      "property1": 0,
      "property2": 0
    },
    "pipeConnection": {
      "pipeID": "string",
      "inputID": "string",
      "outputID": "string",
      "outputName": "string",
      "lastValidated": "2019-08-24T14:15:22Z",
      "inputMapping": [],
      "outputMapping": []
    },
    "sortColumns": [
      {}
    ],
    "limit": 0,
    "sortDirection": "Ascending",
    "rankType": "Standard",
    "timeColumn": "string",
    "timeId": "string",
    "levelId": "string",
    "shift": 0,
    "categories": [
      {}
    ],
    "timeLockStart": "2019-08-24T14:15:22Z",
    "timeLockEnd": "2019-08-24T14:15:22Z",
    "timeLockCalendar": "string"
  },
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "isEmpty": true,
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1,
    "left": 0.1,
    "top": 0.1,
    "right": 0.1,
    "bottom": 0.1,
    "isEmpty": true
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}
{"calculation":{"calculationId":0,"calculationType":"Mathematical","name":"string","comment":"string","hasOutputGroups":true,"source":"string","usesLeftJoin":true,"calendar":"string","timePartitionPath":"string","timeLevel":"string","resetLevel":"string","timeStart":{},"timeEnd":{},"isCurrent":true,"outputTable":"string","previewId":0,"previewTable":"string","rowVersion":{"rowVersion":0},"restrictions":{"constraintType":"clause","op":"string","dataFieldLeft":{},"caseSensitive":true,"constraints":[],"literalRight":{},"dataFieldRight":{},"right":{},"expressionLeft":{},"expressionRight":{},"isPreciseDecimal":true,"like":"string","escapeWildcards":true,"rowVersion":{},"table":"string","queryDefinitionRight":null},"mainSourceRestrictions":{"constraintType":"clause","op":"string","dataFieldLeft":{},"caseSensitive":true,"constraints":[],"literalRight":{},"dataFieldRight":{},"right":{},"expressionLeft":{},"expressionRight":{},"isPreciseDecimal":true,"like":"string","escapeWildcards":true,"rowVersion":{},"table":"string","queryDefinitionRight":null},"partitions":[{}],"lookups":[{}],"unions":[{}],"traceColumns":[{}],"executionPaths":["LimitAll"],"references":{"property1":{},"property2":{}},"timeReferences":{"property1":{},"property2":{}},"sourceColumns":[{}],"sourceKeyColumns":[{}],"outputColumns":[{}],"calculationDataId":0,"formulas":{"property1":"string","property2":"string"},"formulaOrder":{"property1":0,"property2":0},"pipeConnection":{"pipeID":"string","inputID":"string","outputID":"string","outputName":"string","lastValidated":"2019-08-24T14:15:22Z","inputMapping":[],"outputMapping":[]},"sortColumns":[{}],"limit":0,"sortDirection":"Ascending","rankType":"Standard","timeColumn":"string","timeId":"string","levelId":"string","shift":0,"categories":[{}],"timeLockStart":"2019-08-24T14:15:22Z","timeLockEnd":"2019-08-24T14:15:22Z","timeLockCalendar":"string"},"elementId":0,"parentBlockId":0,"bounds":{"location":{"isEmpty":true,"x":0.1,"y":0.1},"size":"string","x":0.1,"y":0.1,"width":0.1,"height":0.1,"left":0.1,"top":0.1,"right":0.1,"bottom":0.1,"isEmpty":true},"color":{"a":0,"b":0,"g":0,"r":0},"name":"string","parentBlock":{"id":0,"name":"string","href":"string"},"isVisible":true,"version":{"rowVersion":0}}

Delete a calculation with a given calculation ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Calculation ID

Responses

Status

Meaning

Description

Schema

200

OK

Delete the Calculation with the given Calculation ID

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/calculations/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/calculations/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/calculations/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/calculations/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/calculations/{id}',
  params: {
  }

p JSON.parse(result)

Runs all calculations.

Parameters

Name

In

Type

Required

Description

excelAddIn

query

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Runs all Calculations

None

202

Accepted

Runs all Calculations without computation logs

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/calculations", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/calculations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/rpc/calculations',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/v1/rpc/calculations')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/v1/rpc/calculations',
  params: {
  }

p JSON.parse(result)

Run individual calculations.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Calculation ID

Responses

Status

Meaning

Description

Schema

200

OK

Runs individual Calculation

None

202

Accepted

Runs individual Calculation without computation logs

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/calculations/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/calculations/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/rpc/calculations/{id}',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/v1/rpc/calculations/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/v1/rpc/calculations/{id}',
  params: {
  }

p JSON.parse(result)

Run selected calculations.

Body parameter

{
  "calculationIds": [
    0
  ],
  "componentIds": [
    0
  ],
  "computeDependencies": true
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Composer.SelectedCalculationsDTO

false

Selected Calculations DTO

» calculationIds

body

[integer]¦null

false

none

» componentIds

body

[integer]¦null

false

none

» computeDependencies

body

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Runs selected Calculations

None

202

Accepted

Runs selected Calculations without computation logs

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/computeselectedcalculations", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/computeselectedcalculations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "calculationIds": [
    0
  ],
  "componentIds": [
    0
  ],
  "computeDependencies": true
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/computeselectedcalculations',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/computeselectedcalculations', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/computeselectedcalculations',
  params: {
  }, headers: headers

p JSON.parse(result)

Preview calculations run for selected calculations/components.

Body parameter

{
  "calculationIds": [
    0
  ],
  "componentIds": [
    0
  ],
  "computeDependencies": true
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Composer.SelectedCalculationsDTO

false

Selected Calculations DTO

» calculationIds

body

[integer]¦null

false

none

» componentIds

body

[integer]¦null

false

none

» computeDependencies

body

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Runs selected Calculations

None

202

Accepted

Runs selected Calculations without computation logs

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/computeselectedcalculations/preview", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/computeselectedcalculations/preview");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "calculationIds": [
    0
  ],
  "componentIds": [
    0
  ],
  "computeDependencies": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/computeselectedcalculations/preview',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/computeselectedcalculations/preview', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/computeselectedcalculations/preview',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  0
]
[0]

Get the list of calculations the user has permissions to view/run based on a list of accessible components.

Body parameter

{
  "calculationIds": [
    0
  ],
  "componentIds": [
    0
  ],
  "computeDependencies": true
}

Parameters

Name

In

Type

Required

Description

filter

query

string

false

none

body

body

Varicent.RESTAPI.v1.DTOs.Composer.SelectedCalculationsDTO

false

Selected Calculations DTO

» calculationIds

body

[integer]¦null

false

none

» componentIds

body

[integer]¦null

false

none

» computeDependencies

body

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Gets accessible calculations

None

202

Accepted

Gets the list of accessible calculations for the user

Inline

Response Schema

Status Code 202

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.NavigationCalculationElementDTO]

false

none

none

» parentBlockId

integer(int32)

false

none

none

» elementId

integer(int32)

false

none

none

» calculationId

integer(int32)

false

none

none

» calculationType

string¦null

false

none

none

» name

string¦null

false

none

none

» comment

string¦null

false

none

none

» isFavourite

boolean

false

none

none

» sourceTables

[string]¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/accessiblecalculations", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/accessiblecalculations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "calculationIds": [
    0
  ],
  "componentIds": [
    0
  ],
  "computeDependencies": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/accessiblecalculations',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/accessiblecalculations', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/accessiblecalculations',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "parentBlockId": 0,
    "elementId": 0,
    "calculationId": 0,
    "calculationType": "string",
    "name": "string",
    "comment": "string",
    "isFavourite": true,
    "sourceTables": [
      "string"
    ]
  }
]
[{"parentBlockId":0,"elementId":0,"calculationId":0,"calculationType":"string","name":"string","comment":"string","isFavourite":true,"sourceTables":["string"]}]

Run calculations for a payee with the given payee ID.

Parameters

Name

In

Type

Required

Description

id

path

string

true

Payee ID

Responses

Status

Meaning

Description

Schema

200

OK

Runs Calculations for the Payee with the given Payee ID.

None

202

Accepted

Runs Calculations for the Payee with the given Payee ID without computation logs

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/payeecalculations/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/payeecalculations/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/rpc/payeecalculations/{id}',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/v1/rpc/payeecalculations/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/v1/rpc/payeecalculations/{id}',
  params: {
  }

p JSON.parse(result)

Run calculations for all presenter reports.

Responses

Status

Meaning

Description

Schema

200

OK

Runs Calculations for all Presenter reports

None

202

Accepted

Runs Calculations for all Presenter reports without computation logs

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/presentercalculations", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/presentercalculations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/rpc/presentercalculations',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/v1/rpc/presentercalculations')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/v1/rpc/presentercalculations',
  params: {
  }

p JSON.parse(result)

Run calculations for the presenter report with the given ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Runs Calculations for the Presenter report with the given ID

None

202

Accepted

Runs Calculations for the Presenter report with the given ID without computation logs

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/presentercalculations/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/presentercalculations/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/rpc/presentercalculations/{id}',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/v1/rpc/presentercalculations/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/v1/rpc/presentercalculations/{id}',
  params: {
  }

p JSON.parse(result)

Run calculations for all web forms.

Responses

Status

Meaning

Description

Schema

200

OK

Runs Calculations for all Web Forms

None

202

Accepted

Runs Calculations for all Web Forms with the given ID without computation logs

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/webformcalculations", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/webformcalculations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/rpc/webformcalculations',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/v1/rpc/webformcalculations')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/v1/rpc/webformcalculations',
  params: {
  }

p JSON.parse(result)

Run calculations for the web form with the given ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Runs Calculations for the Web Form with the given ID

None

202

Accepted

Runs Calculations for the Web Form with the given ID without computation logs

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/webformcalculations/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/webformcalculations/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/rpc/webformcalculations/{id}',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/v1/rpc/webformcalculations/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/v1/rpc/webformcalculations/{id}',
  params: {
  }

p JSON.parse(result)

Get the completed computation log for the given computation log ID.

Parameters

Name

In

Type

Required

Description

logId

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Gets the completed computation log for the given computation log ID

Varicent.RESTAPI.v1.DTOs.ComputationLogItemDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/calculations/logs/completed/{logId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/calculations/logs/completed/{logId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/calculations/logs/completed/{logId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/calculations/logs/completed/{logId}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/calculations/logs/completed/{logId}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "computationId": 0,
  "clientVersion": "string",
  "databaseVersion": 0,
  "start": "2019-08-24T14:15:22Z",
  "duration": "string",
  "incremental": 0,
  "type": 0,
  "status": 0,
  "calcsCount": 0,
  "events": [
    {
      "batchId": 0,
      "computationEventId": 0,
      "name": "string",
      "runningTime": 0,
      "finished": true,
      "calcId": 0,
      "calcMethod": "string",
      "status": "string",
      "syncRunningTime": 0,
      "skipped": true,
      "details": [],
      "start": "2019-08-24T14:15:22Z",
      "end": "2019-08-24T14:15:22Z",
      "duration": "string",
      "syncDuration": "string"
    }
  ]
}
{"computationId":0,"clientVersion":"string","databaseVersion":0,"start":"2019-08-24T14:15:22Z","duration":"string","incremental":0,"type":0,"status":0,"calcsCount":0,"events":[{"batchId":0,"computationEventId":0,"name":"string","runningTime":0,"finished":true,"calcId":0,"calcMethod":"string","status":"string","syncRunningTime":0,"skipped":true,"details":[],"start":"2019-08-24T14:15:22Z","end":"2019-08-24T14:15:22Z","duration":"string","syncDuration":"string"}]}

Returns a preview of the results of the given calculation. Use this endpoint when in a Calculation Wizard Source tab or Restrictions tab.

Body parameter

{
  "calculationToPreview": {
    "calculationId": 0,
    "calculationType": "Mathematical",
    "name": "string",
    "comment": "string",
    "hasOutputGroups": true,
    "source": "string",
    "usesLeftJoin": true,
    "calendar": "string",
    "timePartitionPath": "string",
    "timeLevel": "string",
    "resetLevel": "string",
    "timeStart": {},
    "timeEnd": {},
    "isCurrent": true,
    "outputTable": "string",
    "previewId": 0,
    "previewTable": "string",
    "rowVersion": {
      "rowVersion": 0
    },
    "restrictions": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "mainSourceRestrictions": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "partitions": [
      {}
    ],
    "lookups": [
      {}
    ],
    "unions": [
      {}
    ],
    "traceColumns": [
      {}
    ],
    "executionPaths": [
      "LimitAll"
    ],
    "references": {
      "property1": {},
      "property2": {}
    },
    "timeReferences": {
      "property1": {},
      "property2": {}
    },
    "sourceColumns": [
      {}
    ],
    "sourceKeyColumns": [
      {}
    ],
    "outputColumns": [
      {}
    ],
    "calculationDataId": 0,
    "formulas": {
      "property1": "string",
      "property2": "string"
    },
    "formulaOrder": {
      "property1": 0,
      "property2": 0
    },
    "pipeConnection": {
      "pipeID": "string",
      "inputID": "string",
      "outputID": "string",
      "outputName": "string",
      "lastValidated": "2019-08-24T14:15:22Z",
      "inputMapping": [],
      "outputMapping": []
    },
    "sortColumns": [
      {}
    ],
    "limit": 0,
    "sortDirection": "Ascending",
    "rankType": "Standard",
    "timeColumn": "string",
    "timeId": "string",
    "levelId": "string",
    "shift": 0,
    "categories": [
      {}
    ],
    "timeLockStart": "2019-08-24T14:15:22Z",
    "timeLockEnd": "2019-08-24T14:15:22Z",
    "timeLockCalendar": "string"
  },
  "parentBlockId": 0,
  "validate": true
}

Parameters

Name

In

Type

Required

Description

offset

query

integer(int32)

false

none

limit

query

integer(int32)

false

none

orderBy

query

string

false

none

filter

query

string

false

none

unique

query

boolean

false

none

body

body

Varicent.RESTAPI.v1.DTOs.Preview.PreviewStateDTO

false

none

» calculationToPreview

body

Varicent.RESTAPI.v1.DTOs.Calculations.CalculationDTO

false

none

»» calculationId

body

integer(int32)

false

none

»» calculationType

body

string

false

none

»» name

body

string¦null

false

none

»» comment

body

string¦null

false

none

»» hasOutputGroups

body

boolean

false

none

»» source

body

string¦null

false

none

»» usesLeftJoin

body

boolean

false

none

»» calendar

body

string¦null

false

none

»» timePartitionPath

body

string¦null

false

none

»» timeLevel

body

string¦null

false

none

»» resetLevel

body

string¦null

false

none

»» timeStart

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»» timeEnd

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»» isCurrent

body

boolean

false

none

»» outputTable

body

string¦null

false

none

»» previewId

body

integer(int32)

false

none

»» previewTable

body

string¦null

false

none

»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» rowVersion

body

integer(int64)

false

none

»» restrictions

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» constraintType

body

string

false

none

»»» op

body

string¦null

false

none

»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» expressionType

body

string

false

none

»»»» cases

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» op

body

string¦null

false

none

»»»» arguments

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» condition

body

any

false

none

»»»» trueValue

body

any

false

none

»»»» falseValue

body

any

false

none

»»»» isDate

body

boolean

false

none

»»»» literalType

body

string

false

none

»»»» value

body

any

false

none

»»» caseSensitive

body

boolean

false

none

»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»» constraintType

body

string

false

none

»»»» op

body

string¦null

false

none

»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» caseSensitive

body

boolean

false

none

»»»» constraints

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» literalRight

body

any

false

none

»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» right

body

any

false

none

»»»» expressionLeft

body

any

false

none

»»»» expressionRight

body

any

false

none

»»»» isPreciseDecimal

body

boolean

false

none

»»»» like

body

string¦null

false

none

»»»» escapeWildcards

body

boolean

false

none

»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»» table

body

string¦null

false

none

»»»» queryDefinitionRight

body

any

false

none

»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» expressionType

body

string

false

none

»»»» cases

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» op

body

string¦null

false

none

»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»» trueValue

body

any

false

none

»»»»» falseValue

body

any

false

none

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» isDate

body

boolean

false

none

»»»» literalType

body

string

false

none

»»»» value

body

any

false

none

»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»» isPreciseDecimal

body

boolean

false

none

»»» like

body

string¦null

false

none

»»» escapeWildcards

body

boolean

false

none

»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» table

body

string¦null

false

none

»»» queryDefinitionRight

body

any

false

none

»» mainSourceRestrictions

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» partitions

body

[Varicent.RESTAPI.v1.DTOs.Calculations.PartitionDefinitionDTO]¦null

false

none

»»» source

body

string¦null

false

none

»»» outputGroup

body

string¦null

false

none

»»» isAccumulating

body

boolean

false

none

»»» userDefinedColumnName

body

string¦null

false

none

»» lookups

body

[Varicent.RESTAPI.v1.DTOs.Calculations.LookupDTO]¦null

false

none

»»» name

body

string¦null

false

none

»»» source

body

string¦null

false

none

»»» restrictions

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» unions

body

[Varicent.RESTAPI.v1.DTOs.Calculations.UnionDefinitionDTO]¦null

false

none

»»» sourceAlias

body

string¦null

false

none

»»» sourceColumns

body

[string]¦null

false

none

»»» unionTable

body

string¦null

false

none

»»» unionColumns

body

[string]¦null

false

none

»» traceColumns

body

[Varicent.RESTAPI.v1.DTOs.Calculations.TraceColumnDTO]¦null

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» type

body

string

false

none

»» executionPaths

body

[string]¦null

false

none

»» references

body

object¦null

false

none

»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.DataItemDTO

false

none

»»»» path

body

RESTAPI.v1.DTOs.DataPathDTO

false

none

»»»»» path

body

[string]¦null

false

none

»»»» column

body

string¦null

false

none

»»»» alias

body

string¦null

false

none

»» timeReferences

body

object¦null

false

none

»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»»» levelId

body

string¦null

false

none

»»»» timeId

body

string¦null

false

none

»» sourceColumns

body

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

»»» name

body

string¦null

false

none

»»» type

body

string

false

none

»»» isKey

body

boolean

false

none

»»» nullable

body

boolean

false

none

»»» values

body

string¦null

false

none

»»» lockedPeriod

body

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

»»»» start

body

string(date-time)

false

none

»»»» end

body

string(date-time)

false

none

»»» referencedCol

body

string¦null

false

none

»»» picklistFilter

body

string¦null

false

none

»»» displayName

body

string¦null

false

none

»»» isELTPeriod

body

boolean¦null

false

none

»» sourceKeyColumns

body

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

»» outputColumns

body

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

»» calculationDataId

body

integer(int32)¦null

false

none

»» formulas

body

object¦null

false

none

»»» additionalProperties

body

string¦null

false

none

»» formulaOrder

body

object¦null

false

none

»»» additionalProperties

body

integer(int32)¦null

false

none

»» pipeConnection

body

Varicent.RESTAPI.v1.DTOs.Symon.PipeConnectionDTO

false

none

»»» pipeID

body

string¦null

false

none

»»» inputID

body

string¦null

false

none

»»» outputID

body

string¦null

false

none

»»» outputName

body

string¦null

false

none

»»» lastValidated

body

string(date-time)

false

none

»»» inputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»»»» source

body

string¦null

false

none

»»»» destination

body

string¦null

false

none

»»»» type

body

string

false

none

»»» outputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»» sortColumns

body

[Varicent.RESTAPI.v1.DTOs.DataItemDTO]¦null

false

none

»» limit

body

integer(int32)

false

none

»» sortDirection

body

string

false

none

»» rankType

body

string

false

none

»» timeColumn

body

string¦null

false

none

»» timeId

body

string¦null

false

none

»» levelId

body

string¦null

false

none

»» shift

body

integer(int32)

false

none

»» categories

body

[Varicent.RESTAPI.v1.DTOs.Calculations.CalculationCategoryDTO]¦null

false

none

»»» categoryId

body

integer(int32)

false

none

»»» name

body

string¦null

false

none

»»» clause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» timeLockStart

body

string(date-time)

false

none

»» timeLockEnd

body

string(date-time)

false

none

»» timeLockCalendar

body

string¦null

false

none

» parentBlockId

body

integer(int32)

false

none

» validate

body

boolean

false

none

Enumerated Values

Parameter

Value

»» calculationType

Mathematical

»» calculationType

Sorting

»» calculationType

TimeShift

»» calculationType

Category

»» calculationType

Symon

»»» constraintType

clause

»»» constraintType

constraint

»»» constraintType

expressionConstraint

»»» constraintType

likeConstraint

»»» constraintType

rowVersionConstraint

»»» constraintType

subQueryConstraint

»»»» expressionType

caseExpression

»»»» expressionType

dataField

»»»» expressionType

function

»»»» expressionType

ifExpression

»»»» expressionType

literal

»»»» literalType

Integer

»»»» literalType

Decimal

»»»» literalType

Date

»»»» literalType

DateTime

»»»» literalType

String

»»»» literalType

Float

»»»» literalType

Long

»»»» literalType

Null

»»»» literalType

Parameter

»»»» literalType

Guid

»»»» literalType

SystemUtcTime

»»»» literalType

Boolean

»»»» constraintType

clause

»»»» constraintType

constraint

»»»» constraintType

expressionConstraint

»»»» constraintType

likeConstraint

»»»» constraintType

rowVersionConstraint

»»»» constraintType

subQueryConstraint

»»»» expressionType

caseExpression

»»»» expressionType

dataField

»»»» expressionType

function

»»»» expressionType

ifExpression

»»»» expressionType

literal

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» literalType

Integer

»»»» literalType

Decimal

»»»» literalType

Date

»»»» literalType

DateTime

»»»» literalType

String

»»»» literalType

Float

»»»» literalType

Long

»»»» literalType

Null

»»»» literalType

Parameter

»»»» literalType

Guid

»»»» literalType

SystemUtcTime

»»»» literalType

Boolean

»»» type

String

»»» type

LongString

»»» type

MaxString

»»» type

Date

»»» type

DateTime

»»» type

Decimal

»»» type

Int

»»» type

Long

»»» type

Float

»»» type

BLOB

»»» type

Identity

»»» type

CLOB

»»» type

RowVersion

»»» type

UID

»»» type

VarCharMax

»»» type

Boolean

»» executionPaths

LimitAll

»» executionPaths

LimitOne

»» executionPaths

MaxDOP1

»» executionPaths

SingleThreadedMerge

»» executionPaths

DisableMerge

»» executionPaths

SQL2014Estimator

»» executionPaths

ForceClassic

»» executionPaths

DisablePostCalculationOptimization

»» executionPaths

UseIncrementalSyncback

»»» type

String

»»» type

LongString

»»» type

MaxString

»»» type

Date

»»» type

DateTime

»»» type

Decimal

»»» type

Int

»»» type

Long

»»» type

Float

»»» type

BLOB

»»» type

Identity

»»» type

CLOB

»»» type

RowVersion

»»» type

UID

»»» type

VarCharMax

»»» type

Boolean

»»»» type

String

»»»» type

Number

»»»» type

Boolean

»»»» type

Date

»» sortDirection

Ascending

»» sortDirection

Descending

»» rankType

Standard

»» rankType

Sequential

»» rankType

Dense

Responses

Status

Meaning

Description

Schema

200

OK

View Calculation preview inputs

Varicent.RESTAPI.v1.DTOs.ResultSetDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/calculations/previewInput", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/calculations/previewInput");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "calculationToPreview": {
    "calculationId": 0,
    "calculationType": "Mathematical",
    "name": "string",
    "comment": "string",
    "hasOutputGroups": true,
    "source": "string",
    "usesLeftJoin": true,
    "calendar": "string",
    "timePartitionPath": "string",
    "timeLevel": "string",
    "resetLevel": "string",
    "timeStart": {},
    "timeEnd": {},
    "isCurrent": true,
    "outputTable": "string",
    "previewId": 0,
    "previewTable": "string",
    "rowVersion": {
      "rowVersion": 0
    },
    "restrictions": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "mainSourceRestrictions": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "partitions": [
      {}
    ],
    "lookups": [
      {}
    ],
    "unions": [
      {}
    ],
    "traceColumns": [
      {}
    ],
    "executionPaths": [
      "LimitAll"
    ],
    "references": {
      "property1": {},
      "property2": {}
    },
    "timeReferences": {
      "property1": {},
      "property2": {}
    },
    "sourceColumns": [
      {}
    ],
    "sourceKeyColumns": [
      {}
    ],
    "outputColumns": [
      {}
    ],
    "calculationDataId": 0,
    "formulas": {
      "property1": "string",
      "property2": "string"
    },
    "formulaOrder": {
      "property1": 0,
      "property2": 0
    },
    "pipeConnection": {
      "pipeID": "string",
      "inputID": "string",
      "outputID": "string",
      "outputName": "string",
      "lastValidated": "2019-08-24T14:15:22Z",
      "inputMapping": [],
      "outputMapping": []
    },
    "sortColumns": [
      {}
    ],
    "limit": 0,
    "sortDirection": "Ascending",
    "rankType": "Standard",
    "timeColumn": "string",
    "timeId": "string",
    "levelId": "string",
    "shift": 0,
    "categories": [
      {}
    ],
    "timeLockStart": "2019-08-24T14:15:22Z",
    "timeLockEnd": "2019-08-24T14:15:22Z",
    "timeLockCalendar": "string"
  },
  "parentBlockId": 0,
  "validate": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/calculations/previewInput',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/calculations/previewInput', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/calculations/previewInput',
  params: {
  }, headers: headers

p JSON.parse(result)

Returns a list of calcs that have not been synced back from cos that the calc being previewed uses. Non-ppo will always return empty list

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Validate Preview

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/calculations/validatepreview/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/calculations/validatepreview/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/calculations/validatepreview/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/calculations/validatepreview/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/calculations/validatepreview/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  "string"
]
["string"]

Returns a preview of the results of the given calculation. Use this endpoint when in a Calculation Wizard tab that isn’t the Source tab or Restrictions tab.

Body parameter

{
  "calculationToPreview": {
    "calculationId": 0,
    "calculationType": "Mathematical",
    "name": "string",
    "comment": "string",
    "hasOutputGroups": true,
    "source": "string",
    "usesLeftJoin": true,
    "calendar": "string",
    "timePartitionPath": "string",
    "timeLevel": "string",
    "resetLevel": "string",
    "timeStart": {},
    "timeEnd": {},
    "isCurrent": true,
    "outputTable": "string",
    "previewId": 0,
    "previewTable": "string",
    "rowVersion": {
      "rowVersion": 0
    },
    "restrictions": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "mainSourceRestrictions": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "partitions": [
      {}
    ],
    "lookups": [
      {}
    ],
    "unions": [
      {}
    ],
    "traceColumns": [
      {}
    ],
    "executionPaths": [
      "LimitAll"
    ],
    "references": {
      "property1": {},
      "property2": {}
    },
    "timeReferences": {
      "property1": {},
      "property2": {}
    },
    "sourceColumns": [
      {}
    ],
    "sourceKeyColumns": [
      {}
    ],
    "outputColumns": [
      {}
    ],
    "calculationDataId": 0,
    "formulas": {
      "property1": "string",
      "property2": "string"
    },
    "formulaOrder": {
      "property1": 0,
      "property2": 0
    },
    "pipeConnection": {
      "pipeID": "string",
      "inputID": "string",
      "outputID": "string",
      "outputName": "string",
      "lastValidated": "2019-08-24T14:15:22Z",
      "inputMapping": [],
      "outputMapping": []
    },
    "sortColumns": [
      {}
    ],
    "limit": 0,
    "sortDirection": "Ascending",
    "rankType": "Standard",
    "timeColumn": "string",
    "timeId": "string",
    "levelId": "string",
    "shift": 0,
    "categories": [
      {}
    ],
    "timeLockStart": "2019-08-24T14:15:22Z",
    "timeLockEnd": "2019-08-24T14:15:22Z",
    "timeLockCalendar": "string"
  },
  "parentBlockId": 0,
  "validate": true
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Preview.PreviewStateDTO

false

none

» calculationToPreview

body

Varicent.RESTAPI.v1.DTOs.Calculations.CalculationDTO

false

none

»» calculationId

body

integer(int32)

false

none

»» calculationType

body

string

false

none

»» name

body

string¦null

false

none

»» comment

body

string¦null

false

none

»» hasOutputGroups

body

boolean

false

none

»» source

body

string¦null

false

none

»» usesLeftJoin

body

boolean

false

none

»» calendar

body

string¦null

false

none

»» timePartitionPath

body

string¦null

false

none

»» timeLevel

body

string¦null

false

none

»» resetLevel

body

string¦null

false

none

»» timeStart

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»» timeEnd

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»» isCurrent

body

boolean

false

none

»» outputTable

body

string¦null

false

none

»» previewId

body

integer(int32)

false

none

»» previewTable

body

string¦null

false

none

»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» rowVersion

body

integer(int64)

false

none

»» restrictions

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» constraintType

body

string

false

none

»»» op

body

string¦null

false

none

»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» expressionType

body

string

false

none

»»»» cases

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» op

body

string¦null

false

none

»»»» arguments

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» condition

body

any

false

none

»»»» trueValue

body

any

false

none

»»»» falseValue

body

any

false

none

»»»» isDate

body

boolean

false

none

»»»» literalType

body

string

false

none

»»»» value

body

any

false

none

»»» caseSensitive

body

boolean

false

none

»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»» constraintType

body

string

false

none

»»»» op

body

string¦null

false

none

»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» caseSensitive

body

boolean

false

none

»»»» constraints

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» literalRight

body

any

false

none

»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» right

body

any

false

none

»»»» expressionLeft

body

any

false

none

»»»» expressionRight

body

any

false

none

»»»» isPreciseDecimal

body

boolean

false

none

»»»» like

body

string¦null

false

none

»»»» escapeWildcards

body

boolean

false

none

»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»» table

body

string¦null

false

none

»»»» queryDefinitionRight

body

any

false

none

»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» expressionType

body

string

false

none

»»»» cases

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» op

body

string¦null

false

none

»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»» trueValue

body

any

false

none

»»»»» falseValue

body

any

false

none

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» isDate

body

boolean

false

none

»»»» literalType

body

string

false

none

»»»» value

body

any

false

none

»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»» isPreciseDecimal

body

boolean

false

none

»»» like

body

string¦null

false

none

»»» escapeWildcards

body

boolean

false

none

»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» table

body

string¦null

false

none

»»» queryDefinitionRight

body

any

false

none

»» mainSourceRestrictions

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» partitions

body

[Varicent.RESTAPI.v1.DTOs.Calculations.PartitionDefinitionDTO]¦null

false

none

»»» source

body

string¦null

false

none

»»» outputGroup

body

string¦null

false

none

»»» isAccumulating

body

boolean

false

none

»»» userDefinedColumnName

body

string¦null

false

none

»» lookups

body

[Varicent.RESTAPI.v1.DTOs.Calculations.LookupDTO]¦null

false

none

»»» name

body

string¦null

false

none

»»» source

body

string¦null

false

none

»»» restrictions

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» unions

body

[Varicent.RESTAPI.v1.DTOs.Calculations.UnionDefinitionDTO]¦null

false

none

»»» sourceAlias

body

string¦null

false

none

»»» sourceColumns

body

[string]¦null

false

none

»»» unionTable

body

string¦null

false

none

»»» unionColumns

body

[string]¦null

false

none

»» traceColumns

body

[Varicent.RESTAPI.v1.DTOs.Calculations.TraceColumnDTO]¦null

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» type

body

string

false

none

»» executionPaths

body

[string]¦null

false

none

»» references

body

object¦null

false

none

»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.DataItemDTO

false

none

»»»» path

body

RESTAPI.v1.DTOs.DataPathDTO

false

none

»»»»» path

body

[string]¦null

false

none

»»»» column

body

string¦null

false

none

»»»» alias

body

string¦null

false

none

»» timeReferences

body

object¦null

false

none

»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»»» levelId

body

string¦null

false

none

»»»» timeId

body

string¦null

false

none

»» sourceColumns

body

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

»»» name

body

string¦null

false

none

»»» type

body

string

false

none

»»» isKey

body

boolean

false

none

»»» nullable

body

boolean

false

none

»»» values

body

string¦null

false

none

»»» lockedPeriod

body

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

»»»» start

body

string(date-time)

false

none

»»»» end

body

string(date-time)

false

none

»»» referencedCol

body

string¦null

false

none

»»» picklistFilter

body

string¦null

false

none

»»» displayName

body

string¦null

false

none

»»» isELTPeriod

body

boolean¦null

false

none

»» sourceKeyColumns

body

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

»» outputColumns

body

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

»» calculationDataId

body

integer(int32)¦null

false

none

»» formulas

body

object¦null

false

none

»»» additionalProperties

body

string¦null

false

none

»» formulaOrder

body

object¦null

false

none

»»» additionalProperties

body

integer(int32)¦null

false

none

»» pipeConnection

body

Varicent.RESTAPI.v1.DTOs.Symon.PipeConnectionDTO

false

none

»»» pipeID

body

string¦null

false

none

»»» inputID

body

string¦null

false

none

»»» outputID

body

string¦null

false

none

»»» outputName

body

string¦null

false

none

»»» lastValidated

body

string(date-time)

false

none

»»» inputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»»»» source

body

string¦null

false

none

»»»» destination

body

string¦null

false

none

»»»» type

body

string

false

none

»»» outputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»» sortColumns

body

[Varicent.RESTAPI.v1.DTOs.DataItemDTO]¦null

false

none

»» limit

body

integer(int32)

false

none

»» sortDirection

body

string

false

none

»» rankType

body

string

false

none

»» timeColumn

body

string¦null

false

none

»» timeId

body

string¦null

false

none

»» levelId

body

string¦null

false

none

»» shift

body

integer(int32)

false

none

»» categories

body

[Varicent.RESTAPI.v1.DTOs.Calculations.CalculationCategoryDTO]¦null

false

none

»»» categoryId

body

integer(int32)

false

none

»»» name

body

string¦null

false

none

»»» clause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» timeLockStart

body

string(date-time)

false

none

»» timeLockEnd

body

string(date-time)

false

none

»» timeLockCalendar

body

string¦null

false

none

» parentBlockId

body

integer(int32)

false

none

» validate

body

boolean

false

none

Enumerated Values

Parameter

Value

»» calculationType

Mathematical

»» calculationType

Sorting

»» calculationType

TimeShift

»» calculationType

Category

»» calculationType

Symon

»»» constraintType

clause

»»» constraintType

constraint

»»» constraintType

expressionConstraint

»»» constraintType

likeConstraint

»»» constraintType

rowVersionConstraint

»»» constraintType

subQueryConstraint

»»»» expressionType

caseExpression

»»»» expressionType

dataField

»»»» expressionType

function

»»»» expressionType

ifExpression

»»»» expressionType

literal

»»»» literalType

Integer

»»»» literalType

Decimal

»»»» literalType

Date

»»»» literalType

DateTime

»»»» literalType

String

»»»» literalType

Float

»»»» literalType

Long

»»»» literalType

Null

»»»» literalType

Parameter

»»»» literalType

Guid

»»»» literalType

SystemUtcTime

»»»» literalType

Boolean

»»»» constraintType

clause

»»»» constraintType

constraint

»»»» constraintType

expressionConstraint

»»»» constraintType

likeConstraint

»»»» constraintType

rowVersionConstraint

»»»» constraintType

subQueryConstraint

»»»» expressionType

caseExpression

»»»» expressionType

dataField

»»»» expressionType

function

»»»» expressionType

ifExpression

»»»» expressionType

literal

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» literalType

Integer

»»»» literalType

Decimal

»»»» literalType

Date

»»»» literalType

DateTime

»»»» literalType

String

»»»» literalType

Float

»»»» literalType

Long

»»»» literalType

Null

»»»» literalType

Parameter

»»»» literalType

Guid

»»»» literalType

SystemUtcTime

»»»» literalType

Boolean

»»» type

String

»»» type

LongString

»»» type

MaxString

»»» type

Date

»»» type

DateTime

»»» type

Decimal

»»» type

Int

»»» type

Long

»»» type

Float

»»» type

BLOB

»»» type

Identity

»»» type

CLOB

»»» type

RowVersion

»»» type

UID

»»» type

VarCharMax

»»» type

Boolean

»» executionPaths

LimitAll

»» executionPaths

LimitOne

»» executionPaths

MaxDOP1

»» executionPaths

SingleThreadedMerge

»» executionPaths

DisableMerge

»» executionPaths

SQL2014Estimator

»» executionPaths

ForceClassic

»» executionPaths

DisablePostCalculationOptimization

»» executionPaths

UseIncrementalSyncback

»»» type

String

»»» type

LongString

»»» type

MaxString

»»» type

Date

»»» type

DateTime

»»» type

Decimal

»»» type

Int

»»» type

Long

»»» type

Float

»»» type

BLOB

»»» type

Identity

»»» type

CLOB

»»» type

RowVersion

»»» type

UID

»»» type

VarCharMax

»»» type

Boolean

»»»» type

String

»»»» type

Number

»»»» type

Boolean

»»»» type

Date

»» sortDirection

Ascending

»» sortDirection

Descending

»» rankType

Standard

»» rankType

Sequential

»» rankType

Dense

Responses

Status

Meaning

Description

Schema

202

Accepted

View Calculation preview

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/calculationpreviews", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/calculationpreviews");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "calculationToPreview": {
    "calculationId": 0,
    "calculationType": "Mathematical",
    "name": "string",
    "comment": "string",
    "hasOutputGroups": true,
    "source": "string",
    "usesLeftJoin": true,
    "calendar": "string",
    "timePartitionPath": "string",
    "timeLevel": "string",
    "resetLevel": "string",
    "timeStart": {},
    "timeEnd": {},
    "isCurrent": true,
    "outputTable": "string",
    "previewId": 0,
    "previewTable": "string",
    "rowVersion": {
      "rowVersion": 0
    },
    "restrictions": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "mainSourceRestrictions": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "partitions": [
      {}
    ],
    "lookups": [
      {}
    ],
    "unions": [
      {}
    ],
    "traceColumns": [
      {}
    ],
    "executionPaths": [
      "LimitAll"
    ],
    "references": {
      "property1": {},
      "property2": {}
    },
    "timeReferences": {
      "property1": {},
      "property2": {}
    },
    "sourceColumns": [
      {}
    ],
    "sourceKeyColumns": [
      {}
    ],
    "outputColumns": [
      {}
    ],
    "calculationDataId": 0,
    "formulas": {
      "property1": "string",
      "property2": "string"
    },
    "formulaOrder": {
      "property1": 0,
      "property2": 0
    },
    "pipeConnection": {
      "pipeID": "string",
      "inputID": "string",
      "outputID": "string",
      "outputName": "string",
      "lastValidated": "2019-08-24T14:15:22Z",
      "inputMapping": [],
      "outputMapping": []
    },
    "sortColumns": [
      {}
    ],
    "limit": 0,
    "sortDirection": "Ascending",
    "rankType": "Standard",
    "timeColumn": "string",
    "timeId": "string",
    "levelId": "string",
    "shift": 0,
    "categories": [
      {}
    ],
    "timeLockStart": "2019-08-24T14:15:22Z",
    "timeLockEnd": "2019-08-24T14:15:22Z",
    "timeLockCalendar": "string"
  },
  "parentBlockId": 0,
  "validate": true
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/calculationpreviews',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/calculationpreviews', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/calculationpreviews',
  params: {
  }, headers: headers

p JSON.parse(result)

Returns a preview of the results of the given preview ID.

Body parameter

{
  "calculationToPreview": {
    "calculationId": 0,
    "calculationType": "Mathematical",
    "name": "string",
    "comment": "string",
    "hasOutputGroups": true,
    "source": "string",
    "usesLeftJoin": true,
    "calendar": "string",
    "timePartitionPath": "string",
    "timeLevel": "string",
    "resetLevel": "string",
    "timeStart": {},
    "timeEnd": {},
    "isCurrent": true,
    "outputTable": "string",
    "previewId": 0,
    "previewTable": "string",
    "rowVersion": {
      "rowVersion": 0
    },
    "restrictions": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "mainSourceRestrictions": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "partitions": [
      {}
    ],
    "lookups": [
      {}
    ],
    "unions": [
      {}
    ],
    "traceColumns": [
      {}
    ],
    "executionPaths": [
      "LimitAll"
    ],
    "references": {
      "property1": {},
      "property2": {}
    },
    "timeReferences": {
      "property1": {},
      "property2": {}
    },
    "sourceColumns": [
      {}
    ],
    "sourceKeyColumns": [
      {}
    ],
    "outputColumns": [
      {}
    ],
    "calculationDataId": 0,
    "formulas": {
      "property1": "string",
      "property2": "string"
    },
    "formulaOrder": {
      "property1": 0,
      "property2": 0
    },
    "pipeConnection": {
      "pipeID": "string",
      "inputID": "string",
      "outputID": "string",
      "outputName": "string",
      "lastValidated": "2019-08-24T14:15:22Z",
      "inputMapping": [],
      "outputMapping": []
    },
    "sortColumns": [
      {}
    ],
    "limit": 0,
    "sortDirection": "Ascending",
    "rankType": "Standard",
    "timeColumn": "string",
    "timeId": "string",
    "levelId": "string",
    "shift": 0,
    "categories": [
      {}
    ],
    "timeLockStart": "2019-08-24T14:15:22Z",
    "timeLockEnd": "2019-08-24T14:15:22Z",
    "timeLockCalendar": "string"
  },
  "parentBlockId": 0,
  "validate": true
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

offset

query

integer(int32)

false

none

limit

query

integer(int32)

false

none

fields

query

string

false

none

filter

query

string

false

none

unique

query

boolean

false

none

body

body

Varicent.RESTAPI.v1.DTOs.Preview.PreviewStateDTO

false

none

» calculationToPreview

body

Varicent.RESTAPI.v1.DTOs.Calculations.CalculationDTO

false

none

»» calculationId

body

integer(int32)

false

none

»» calculationType

body

string

false

none

»» name

body

string¦null

false

none

»» comment

body

string¦null

false

none

»» hasOutputGroups

body

boolean

false

none

»» source

body

string¦null

false

none

»» usesLeftJoin

body

boolean

false

none

»» calendar

body

string¦null

false

none

»» timePartitionPath

body

string¦null

false

none

»» timeLevel

body

string¦null

false

none

»» resetLevel

body

string¦null

false

none

»» timeStart

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»» timeEnd

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»» isCurrent

body

boolean

false

none

»» outputTable

body

string¦null

false

none

»» previewId

body

integer(int32)

false

none

»» previewTable

body

string¦null

false

none

»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» rowVersion

body

integer(int64)

false

none

»» restrictions

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» constraintType

body

string

false

none

»»» op

body

string¦null

false

none

»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» expressionType

body

string

false

none

»»»» cases

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» op

body

string¦null

false

none

»»»» arguments

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» condition

body

any

false

none

»»»» trueValue

body

any

false

none

»»»» falseValue

body

any

false

none

»»»» isDate

body

boolean

false

none

»»»» literalType

body

string

false

none

»»»» value

body

any

false

none

»»» caseSensitive

body

boolean

false

none

»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»» constraintType

body

string

false

none

»»»» op

body

string¦null

false

none

»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» caseSensitive

body

boolean

false

none

»»»» constraints

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» literalRight

body

any

false

none

»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» right

body

any

false

none

»»»» expressionLeft

body

any

false

none

»»»» expressionRight

body

any

false

none

»»»» isPreciseDecimal

body

boolean

false

none

»»»» like

body

string¦null

false

none

»»»» escapeWildcards

body

boolean

false

none

»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»» table

body

string¦null

false

none

»»»» queryDefinitionRight

body

any

false

none

»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» expressionType

body

string

false

none

»»»» cases

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» op

body

string¦null

false

none

»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»» trueValue

body

any

false

none

»»»»» falseValue

body

any

false

none

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» isDate

body

boolean

false

none

»»»» literalType

body

string

false

none

»»»» value

body

any

false

none

»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»» isPreciseDecimal

body

boolean

false

none

»»» like

body

string¦null

false

none

»»» escapeWildcards

body

boolean

false

none

»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» table

body

string¦null

false

none

»»» queryDefinitionRight

body

any

false

none

»» mainSourceRestrictions

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» partitions

body

[Varicent.RESTAPI.v1.DTOs.Calculations.PartitionDefinitionDTO]¦null

false

none

»»» source

body

string¦null

false

none

»»» outputGroup

body

string¦null

false

none

»»» isAccumulating

body

boolean

false

none

»»» userDefinedColumnName

body

string¦null

false

none

»» lookups

body

[Varicent.RESTAPI.v1.DTOs.Calculations.LookupDTO]¦null

false

none

»»» name

body

string¦null

false

none

»»» source

body

string¦null

false

none

»»» restrictions

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» unions

body

[Varicent.RESTAPI.v1.DTOs.Calculations.UnionDefinitionDTO]¦null

false

none

»»» sourceAlias

body

string¦null

false

none

»»» sourceColumns

body

[string]¦null

false

none

»»» unionTable

body

string¦null

false

none

»»» unionColumns

body

[string]¦null

false

none

»» traceColumns

body

[Varicent.RESTAPI.v1.DTOs.Calculations.TraceColumnDTO]¦null

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» type

body

string

false

none

»» executionPaths

body

[string]¦null

false

none

»» references

body

object¦null

false

none

»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.DataItemDTO

false

none

»»»» path

body

RESTAPI.v1.DTOs.DataPathDTO

false

none

»»»»» path

body

[string]¦null

false

none

»»»» column

body

string¦null

false

none

»»»» alias

body

string¦null

false

none

»» timeReferences

body

object¦null

false

none

»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»»» levelId

body

string¦null

false

none

»»»» timeId

body

string¦null

false

none

»» sourceColumns

body

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

»»» name

body

string¦null

false

none

»»» type

body

string

false

none

»»» isKey

body

boolean

false

none

»»» nullable

body

boolean

false

none

»»» values

body

string¦null

false

none

»»» lockedPeriod

body

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

»»»» start

body

string(date-time)

false

none

»»»» end

body

string(date-time)

false

none

»»» referencedCol

body

string¦null

false

none

»»» picklistFilter

body

string¦null

false

none

»»» displayName

body

string¦null

false

none

»»» isELTPeriod

body

boolean¦null

false

none

»» sourceKeyColumns

body

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

»» outputColumns

body

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

»» calculationDataId

body

integer(int32)¦null

false

none

»» formulas

body

object¦null

false

none

»»» additionalProperties

body

string¦null

false

none

»» formulaOrder

body

object¦null

false

none

»»» additionalProperties

body

integer(int32)¦null

false

none

»» pipeConnection

body

Varicent.RESTAPI.v1.DTOs.Symon.PipeConnectionDTO

false

none

»»» pipeID

body

string¦null

false

none

»»» inputID

body

string¦null

false

none

»»» outputID

body

string¦null

false

none

»»» outputName

body

string¦null

false

none

»»» lastValidated

body

string(date-time)

false

none

»»» inputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»»»» source

body

string¦null

false

none

»»»» destination

body

string¦null

false

none

»»»» type

body

string

false

none

»»» outputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»» sortColumns

body

[Varicent.RESTAPI.v1.DTOs.DataItemDTO]¦null

false

none

»» limit

body

integer(int32)

false

none

»» sortDirection

body

string

false

none

»» rankType

body

string

false

none

»» timeColumn

body

string¦null

false

none

»» timeId

body

string¦null

false

none

»» levelId

body

string¦null

false

none

»» shift

body

integer(int32)

false

none

»» categories

body

[Varicent.RESTAPI.v1.DTOs.Calculations.CalculationCategoryDTO]¦null

false

none

»»» categoryId

body

integer(int32)

false

none

»»» name

body

string¦null

false

none

»»» clause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» timeLockStart

body

string(date-time)

false

none

»» timeLockEnd

body

string(date-time)

false

none

»» timeLockCalendar

body

string¦null

false

none

» parentBlockId

body

integer(int32)

false

none

» validate

body

boolean

false

none

Enumerated Values

Parameter

Value

»» calculationType

Mathematical

»» calculationType

Sorting

»» calculationType

TimeShift

»» calculationType

Category

»» calculationType

Symon

»»» constraintType

clause

»»» constraintType

constraint

»»» constraintType

expressionConstraint

»»» constraintType

likeConstraint

»»» constraintType

rowVersionConstraint

»»» constraintType

subQueryConstraint

»»»» expressionType

caseExpression

»»»» expressionType

dataField

»»»» expressionType

function

»»»» expressionType

ifExpression

»»»» expressionType

literal

»»»» literalType

Integer

»»»» literalType

Decimal

»»»» literalType

Date

»»»» literalType

DateTime

»»»» literalType

String

»»»» literalType

Float

»»»» literalType

Long

»»»» literalType

Null

»»»» literalType

Parameter

»»»» literalType

Guid

»»»» literalType

SystemUtcTime

»»»» literalType

Boolean

»»»» constraintType

clause

»»»» constraintType

constraint

»»»» constraintType

expressionConstraint

»»»» constraintType

likeConstraint

»»»» constraintType

rowVersionConstraint

»»»» constraintType

subQueryConstraint

»»»» expressionType

caseExpression

»»»» expressionType

dataField

»»»» expressionType

function

»»»» expressionType

ifExpression

»»»» expressionType

literal

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» literalType

Integer

»»»» literalType

Decimal

»»»» literalType

Date

»»»» literalType

DateTime

»»»» literalType

String

»»»» literalType

Float

»»»» literalType

Long

»»»» literalType

Null

»»»» literalType

Parameter

»»»» literalType

Guid

»»»» literalType

SystemUtcTime

»»»» literalType

Boolean

»»» type

String

»»» type

LongString

»»» type

MaxString

»»» type

Date

»»» type

DateTime

»»» type

Decimal

»»» type

Int

»»» type

Long

»»» type

Float

»»» type

BLOB

»»» type

Identity

»»» type

CLOB

»»» type

RowVersion

»»» type

UID

»»» type

VarCharMax

»»» type

Boolean

»» executionPaths

LimitAll

»» executionPaths

LimitOne

»» executionPaths

MaxDOP1

»» executionPaths

SingleThreadedMerge

»» executionPaths

DisableMerge

»» executionPaths

SQL2014Estimator

»» executionPaths

ForceClassic

»» executionPaths

DisablePostCalculationOptimization

»» executionPaths

UseIncrementalSyncback

»»» type

String

»»» type

LongString

»»» type

MaxString

»»» type

Date

»»» type

DateTime

»»» type

Decimal

»»» type

Int

»»» type

Long

»»» type

Float

»»» type

BLOB

»»» type

Identity

»»» type

CLOB

»»» type

RowVersion

»»» type

UID

»»» type

VarCharMax

»»» type

Boolean

»»»» type

String

»»»» type

Number

»»»» type

Boolean

»»»» type

Date

»» sortDirection

Ascending

»» sortDirection

Descending

»» rankType

Standard

»» rankType

Sequential

»» rankType

Dense

Responses

Status

Meaning

Description

Schema

200

OK

View Calculation preview

None

409

Conflict

Preview with given ID does not exist.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/calculationpreviews/{id}/data", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/calculationpreviews/{id}/data");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "calculationToPreview": {
    "calculationId": 0,
    "calculationType": "Mathematical",
    "name": "string",
    "comment": "string",
    "hasOutputGroups": true,
    "source": "string",
    "usesLeftJoin": true,
    "calendar": "string",
    "timePartitionPath": "string",
    "timeLevel": "string",
    "resetLevel": "string",
    "timeStart": {},
    "timeEnd": {},
    "isCurrent": true,
    "outputTable": "string",
    "previewId": 0,
    "previewTable": "string",
    "rowVersion": {
      "rowVersion": 0
    },
    "restrictions": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "mainSourceRestrictions": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "partitions": [
      {}
    ],
    "lookups": [
      {}
    ],
    "unions": [
      {}
    ],
    "traceColumns": [
      {}
    ],
    "executionPaths": [
      "LimitAll"
    ],
    "references": {
      "property1": {},
      "property2": {}
    },
    "timeReferences": {
      "property1": {},
      "property2": {}
    },
    "sourceColumns": [
      {}
    ],
    "sourceKeyColumns": [
      {}
    ],
    "outputColumns": [
      {}
    ],
    "calculationDataId": 0,
    "formulas": {
      "property1": "string",
      "property2": "string"
    },
    "formulaOrder": {
      "property1": 0,
      "property2": 0
    },
    "pipeConnection": {
      "pipeID": "string",
      "inputID": "string",
      "outputID": "string",
      "outputName": "string",
      "lastValidated": "2019-08-24T14:15:22Z",
      "inputMapping": [],
      "outputMapping": []
    },
    "sortColumns": [
      {}
    ],
    "limit": 0,
    "sortDirection": "Ascending",
    "rankType": "Standard",
    "timeColumn": "string",
    "timeId": "string",
    "levelId": "string",
    "shift": 0,
    "categories": [
      {}
    ],
    "timeLockStart": "2019-08-24T14:15:22Z",
    "timeLockEnd": "2019-08-24T14:15:22Z",
    "timeLockCalendar": "string"
  },
  "parentBlockId": 0,
  "validate": true
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/calculationpreviews/{id}/data',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/calculationpreviews/{id}/data', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/calculationpreviews/{id}/data',
  params: {
  }, headers: headers

p JSON.parse(result)

Returns a list of history with revision ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Calculation ID

Responses

Status

Meaning

Description

Schema

200

OK

View Calculation history

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.Calculations.CalculationHistoryDTO]

false

none

none

» revisionID

integer(int32)

false

none

none

» version

integer(int32)

false

none

none

» editor

string¦null

false

none

none

» editAt

string(date-time)

false

none

none

» name

string¦null

false

none

none

» changes

[string]¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/calculations/{id}/history", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/calculations/{id}/history");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/calculations/{id}/history',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/calculations/{id}/history', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/calculations/{id}/history',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "revisionID": 0,
    "version": 0,
    "editor": "string",
    "editAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "changes": [
      "Formula"
    ]
  }
]
[{"revisionID":0,"version":0,"editor":"string","editAt":"2019-08-24T14:15:22Z","name":"string","changes":["Formula"]}]

Get a calculation with calculation ID and revision ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Calculation ID

revision

path

integer(int32)

true

Revision

Responses

Status

Meaning

Description

Schema

200

OK

View Calculation history

Varicent.RESTAPI.v1.DTOs.Calculations.CalculationDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/calculations/{id}/history/{revision}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/calculations/{id}/history/{revision}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/calculations/{id}/history/{revision}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/calculations/{id}/history/{revision}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/calculations/{id}/history/{revision}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "calculationId": 0,
  "calculationType": "Mathematical",
  "name": "string",
  "comment": "string",
  "hasOutputGroups": true,
  "source": "string",
  "usesLeftJoin": true,
  "calendar": "string",
  "timePartitionPath": "string",
  "timeLevel": "string",
  "resetLevel": "string",
  "timeStart": {},
  "timeEnd": {},
  "isCurrent": true,
  "outputTable": "string",
  "previewId": 0,
  "previewTable": "string",
  "rowVersion": {
    "rowVersion": 0
  },
  "restrictions": {
    "constraintType": "clause",
    "op": "string",
    "dataFieldLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "caseSensitive": true,
    "constraints": [
      {}
    ],
    "literalRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "dataFieldRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "right": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "isPreciseDecimal": true,
    "like": "string",
    "escapeWildcards": true,
    "rowVersion": {
      "rowVersion": 0
    },
    "table": "string",
    "queryDefinitionRight": null
  },
  "mainSourceRestrictions": {
    "constraintType": "clause",
    "op": "string",
    "dataFieldLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "caseSensitive": true,
    "constraints": [
      {}
    ],
    "literalRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "dataFieldRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "right": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "isPreciseDecimal": true,
    "like": "string",
    "escapeWildcards": true,
    "rowVersion": {
      "rowVersion": 0
    },
    "table": "string",
    "queryDefinitionRight": null
  },
  "partitions": [
    {
      "source": "string",
      "outputGroup": "string",
      "isAccumulating": true,
      "userDefinedColumnName": "string"
    }
  ],
  "lookups": [
    {
      "name": "string",
      "source": "string",
      "restrictions": {}
    }
  ],
  "unions": [
    {
      "sourceAlias": "string",
      "sourceColumns": [],
      "unionTable": "string",
      "unionColumns": []
    }
  ],
  "traceColumns": [
    {
      "table": "string",
      "column": "string",
      "type": "String"
    }
  ],
  "executionPaths": [
    "LimitAll"
  ],
  "references": {
    "property1": {
      "path": {},
      "column": "string",
      "alias": "string"
    },
    "property2": {
      "path": {},
      "column": "string",
      "alias": "string"
    }
  },
  "timeReferences": {
    "property1": {
      "levelId": "string",
      "timeId": "string"
    },
    "property2": {
      "levelId": "string",
      "timeId": "string"
    }
  },
  "sourceColumns": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "sourceKeyColumns": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "outputColumns": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "calculationDataId": 0,
  "formulas": {
    "property1": "string",
    "property2": "string"
  },
  "formulaOrder": {
    "property1": 0,
    "property2": 0
  },
  "pipeConnection": {
    "pipeID": "string",
    "inputID": "string",
    "outputID": "string",
    "outputName": "string",
    "lastValidated": "2019-08-24T14:15:22Z",
    "inputMapping": [
      {}
    ],
    "outputMapping": [
      {}
    ]
  },
  "sortColumns": [
    {
      "path": {},
      "column": "string",
      "alias": "string"
    }
  ],
  "limit": 0,
  "sortDirection": "Ascending",
  "rankType": "Standard",
  "timeColumn": "string",
  "timeId": "string",
  "levelId": "string",
  "shift": 0,
  "categories": [
    {
      "categoryId": 0,
      "name": "string",
      "clause": {}
    }
  ],
  "timeLockStart": "2019-08-24T14:15:22Z",
  "timeLockEnd": "2019-08-24T14:15:22Z",
  "timeLockCalendar": "string"
}
{"calculationId":0,"calculationType":"Mathematical","name":"string","comment":"string","hasOutputGroups":true,"source":"string","usesLeftJoin":true,"calendar":"string","timePartitionPath":"string","timeLevel":"string","resetLevel":"string","timeStart":{},"timeEnd":{},"isCurrent":true,"outputTable":"string","previewId":0,"previewTable":"string","rowVersion":{"rowVersion":0},"restrictions":{"constraintType":"clause","op":"string","dataFieldLeft":{"expressionType":"caseExpression","cases":[],"table":"string","column":"string","op":"string","arguments":[],"condition":null,"trueValue":null,"falseValue":null,"isDate":true,"literalType":"Integer","value":null},"caseSensitive":true,"constraints":[{}],"literalRight":{"expressionType":"caseExpression","cases":[],"table":"string","column":"string","op":"string","arguments":[],"condition":{},"trueValue":{},"falseValue":{},"isDate":true,"literalType":"Integer","value":null},"dataFieldRight":{"expressionType":"caseExpression","cases":[],"table":"string","column":"string","op":"string","arguments":[],"condition":null,"trueValue":null,"falseValue":null,"isDate":true,"literalType":"Integer","value":null},"right":{"expressionType":"caseExpression","cases":[],"table":"string","column":"string","op":"string","arguments":[],"condition":{},"trueValue":null,"falseValue":null,"isDate":true,"literalType":"Integer","value":null},"expressionLeft":{"expressionType":"caseExpression","cases":[],"table":"string","column":"string","op":"string","arguments":[],"condition":{},"trueValue":null,"falseValue":null,"isDate":true,"literalType":"Integer","value":null},"expressionRight":{"expressionType":"caseExpression","cases":[],"table":"string","column":"string","op":"string","arguments":[],"condition":{},"trueValue":null,"falseValue":null,"isDate":true,"literalType":"Integer","value":null},"isPreciseDecimal":true,"like":"string","escapeWildcards":true,"rowVersion":{"rowVersion":0},"table":"string","queryDefinitionRight":null},"mainSourceRestrictions":{"constraintType":"clause","op":"string","dataFieldLeft":{"expressionType":"caseExpression","cases":[],"table":"string","column":"string","op":"string","arguments":[],"condition":null,"trueValue":null,"falseValue":null,"isDate":true,"literalType":"Integer","value":null},"caseSensitive":true,"constraints":[{}],"literalRight":{"expressionType":"caseExpression","cases":[],"table":"string","column":"string","op":"string","arguments":[],"condition":{},"trueValue":{},"falseValue":{},"isDate":true,"literalType":"Integer","value":null},"dataFieldRight":{"expressionType":"caseExpression","cases":[],"table":"string","column":"string","op":"string","arguments":[],"condition":null,"trueValue":null,"falseValue":null,"isDate":true,"literalType":"Integer","value":null},"right":{"expressionType":"caseExpression","cases":[],"table":"string","column":"string","op":"string","arguments":[],"condition":{},"trueValue":null,"falseValue":null,"isDate":true,"literalType":"Integer","value":null},"expressionLeft":{"expressionType":"caseExpression","cases":[],"table":"string","column":"string","op":"string","arguments":[],"condition":{},"trueValue":null,"falseValue":null,"isDate":true,"literalType":"Integer","value":null},"expressionRight":{"expressionType":"caseExpression","cases":[],"table":"string","column":"string","op":"string","arguments":[],"condition":{},"trueValue":null,"falseValue":null,"isDate":true,"literalType":"Integer","value":null},"isPreciseDecimal":true,"like":"string","escapeWildcards":true,"rowVersion":{"rowVersion":0},"table":"string","queryDefinitionRight":null},"partitions":[{"source":"string","outputGroup":"string","isAccumulating":true,"userDefinedColumnName":"string"}],"lookups":[{"name":"string","source":"string","restrictions":{}}],"unions":[{"sourceAlias":"string","sourceColumns":[],"unionTable":"string","unionColumns":[]}],"traceColumns":[{"table":"string","column":"string","type":"String"}],"executionPaths":["LimitAll"],"references":{"property1":{"path":{},"column":"string","alias":"string"},"property2":{"path":{},"column":"string","alias":"string"}},"timeReferences":{"property1":{"levelId":"string","timeId":"string"},"property2":{"levelId":"string","timeId":"string"}},"sourceColumns":[{"name":"string","type":"String","isKey":true,"nullable":true,"values":"string","lockedPeriod":{},"referencedCol":"string","picklistFilter":"string","displayName":"string","isELTPeriod":true}],"sourceKeyColumns":[{"name":"string","type":"String","isKey":true,"nullable":true,"values":"string","lockedPeriod":{},"referencedCol":"string","picklistFilter":"string","displayName":"string","isELTPeriod":true}],"outputColumns":[{"name":"string","type":"String","isKey":true,"nullable":true,"values":"string","lockedPeriod":{},"referencedCol":"string","picklistFilter":"string","displayName":"string","isELTPeriod":true}],"calculationDataId":0,"formulas":{"property1":"string","property2":"string"},"formulaOrder":{"property1":0,"property2":0},"pipeConnection":{"pipeID":"string","inputID":"string","outputID":"string","outputName":"string","lastValidated":"2019-08-24T14:15:22Z","inputMapping":[{}],"outputMapping":[{}]},"sortColumns":[{"path":{},"column":"string","alias":"string"}],"limit":0,"sortDirection":"Ascending","rankType":"Standard","timeColumn":"string","timeId":"string","levelId":"string","shift":0,"categories":[{"categoryId":0,"name":"string","clause":{}}],"timeLockStart":"2019-08-24T14:15:22Z","timeLockEnd":"2019-08-24T14:15:22Z","timeLockCalendar":"string"}

Get all earnings calculations.

Parameters

Name

In

Type

Required

Description

filter

query

string

false

####Supported operations

Detailed descriptions

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

name, type

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.NavigationCalculationElementDTO]

false

none

none

» parentBlockId

integer(int32)

false

none

none

» elementId

integer(int32)

false

none

none

» calculationId

integer(int32)

false

none

none

» calculationType

string¦null

false

none

none

» name

string¦null

false

none

none

» comment

string¦null

false

none

none

» isFavourite

boolean

false

none

none

» sourceTables

[string]¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/earningscalculations", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/earningscalculations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/earningscalculations',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/earningscalculations', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/earningscalculations',
  params: {
  }, headers: headers

p JSON.parse(result)

Get all elements that use a specific calculation.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get all elements that use a specific calculation.

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/calculations/{id}/dependents", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/calculations/{id}/dependents");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/calculations/{id}/dependents',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/calculations/{id}/dependents', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/calculations/{id}/dependents',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  null
]
[null]

CalculationsControllerV1_GetCalcStreams

Body parameter

[
  0
]

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Get calc streams for provided calc IDs

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

RESTAPI.v1.DTOs.DependencyInfoDTO

false

none

none

»» dependencies

object¦null

false

none

none

»»» Calendars

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»»» category

string

false

none

none

»»»» id

string¦null

false

none

none

»»»» name

string¦null

false

none

none

»»»» elementId

integer(int32)¦null

false

none

none

»»»» parentBlockId

integer(int32)¦null

false

none

none

»»»» displayName

string¦null

false

none

none

»»»» sources

[RESTAPI.v1.DTOs.WebReportSourceDependencyItemDTO]¦null

false

none

none

»»»»» type

string

false

none

none

»»»»» name

string¦null

false

none

none

»»» StarSchemas

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» Calculations

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» SavedImports

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» InputForms

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» TaskGroup

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» Plans

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» TailoredReports

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» Publications

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» PayeeGroups

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» Payees

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» Blocks

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» Ports

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» WebForms

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» WebFormFilters

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» WorkflowGroups

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» WebTab

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» Transformations

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» WebFormValidationRules

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» DataStores

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» BPMWorkflow

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» BPMSwimLane

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» BPMNode

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» BPMComponent

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» Views

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» Tables

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» PresenterReports

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» PickList

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» WebEditRestriction

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» PresenterReportDataSources

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» PresenterReportValueSources

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» PresenterReportRowFormSources

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» ScenarioWorkspace

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» Scheduler

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» RapidReport

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» DDE

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» Hierarchy

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» PresenterFlex

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» AdaptiveForms

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» ReportDataModelSource

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» PlanComponentSource

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» PlanBuilderCalculation

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

»»» PlanBuilderItem

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

Enumerated Values

Property

Value

category

Calendars

category

StarSchemas

category

Calculations

category

SavedImports

category

InputForms

category

TaskGroup

category

Plans

category

TailoredReports

category

Publications

category

PayeeGroups

category

Payees

category

Blocks

category

Ports

category

WebForms

category

WebFormFilters

category

WorkflowGroups

category

WebTab

category

Transformations

category

WebFormValidationRules

category

DataStores

category

BPMWorkflow

category

BPMSwimLane

category

BPMNode

category

BPMComponent

category

Views

category

Tables

category

PresenterReports

category

PickList

category

WebEditRestriction

category

PresenterReportDataSources

category

PresenterReportValueSources

category

PresenterReportRowFormSources

category

ScenarioWorkspace

category

Scheduler

category

RapidReport

category

DDE

category

Hierarchy

category

PresenterFlex

category

AdaptiveForms

category

ReportDataModelSource

category

PlanComponentSource

category

PlanBuilderCalculation

category

PlanBuilderItem

type

Query

type

InputRow

type

ValueScalar

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/diffs/streams", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/diffs/streams");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  0
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/diffs/streams',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/diffs/streams', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/diffs/streams',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "property1": {
    "dependencies": {
      "Calendars": [],
      "StarSchemas": [],
      "Calculations": [],
      "SavedImports": [],
      "InputForms": [],
      "TaskGroup": [],
      "Plans": [],
      "TailoredReports": [],
      "Publications": [],
      "PayeeGroups": [],
      "Payees": [],
      "Blocks": [],
      "Ports": [],
      "WebForms": [],
      "WebFormFilters": [],
      "WorkflowGroups": [],
      "WebTab": [],
      "Transformations": [],
      "WebFormValidationRules": [],
      "DataStores": [],
      "BPMWorkflow": [],
      "BPMSwimLane": [],
      "BPMNode": [],
      "BPMComponent": [],
      "Views": [],
      "Tables": [],
      "PresenterReports": [],
      "PickList": [],
      "WebEditRestriction": [],
      "PresenterReportDataSources": [],
      "PresenterReportValueSources": [],
      "PresenterReportRowFormSources": [],
      "ScenarioWorkspace": [],
      "Scheduler": [],
      "RapidReport": [],
      "DDE": [],
      "Hierarchy": [],
      "PresenterFlex": [],
      "AdaptiveForms": [],
      "ReportDataModelSource": [],
      "PlanComponentSource": [],
      "PlanBuilderCalculation": [],
      "PlanBuilderItem": []
    }
  },
  "property2": {
    "dependencies": {
      "Calendars": [],
      "StarSchemas": [],
      "Calculations": [],
      "SavedImports": [],
      "InputForms": [],
      "TaskGroup": [],
      "Plans": [],
      "TailoredReports": [],
      "Publications": [],
      "PayeeGroups": [],
      "Payees": [],
      "Blocks": [],
      "Ports": [],
      "WebForms": [],
      "WebFormFilters": [],
      "WorkflowGroups": [],
      "WebTab": [],
      "Transformations": [],
      "WebFormValidationRules": [],
      "DataStores": [],
      "BPMWorkflow": [],
      "BPMSwimLane": [],
      "BPMNode": [],
      "BPMComponent": [],
      "Views": [],
      "Tables": [],
      "PresenterReports": [],
      "PickList": [],
      "WebEditRestriction": [],
      "PresenterReportDataSources": [],
      "PresenterReportValueSources": [],
      "PresenterReportRowFormSources": [],
      "ScenarioWorkspace": [],
      "Scheduler": [],
      "RapidReport": [],
      "DDE": [],
      "Hierarchy": [],
      "PresenterFlex": [],
      "AdaptiveForms": [],
      "ReportDataModelSource": [],
      "PlanComponentSource": [],
      "PlanBuilderCalculation": [],
      "PlanBuilderItem": []
    }
  }
}
{"property1":{"dependencies":{"Calendars":[],"StarSchemas":[],"Calculations":[],"SavedImports":[],"InputForms":[],"TaskGroup":[],"Plans":[],"TailoredReports":[],"Publications":[],"PayeeGroups":[],"Payees":[],"Blocks":[],"Ports":[],"WebForms":[],"WebFormFilters":[],"WorkflowGroups":[],"WebTab":[],"Transformations":[],"WebFormValidationRules":[],"DataStores":[],"BPMWorkflow":[],"BPMSwimLane":[],"BPMNode":[],"BPMComponent":[],"Views":[],"Tables":[],"PresenterReports":[],"PickList":[],"WebEditRestriction":[],"PresenterReportDataSources":[],"PresenterReportValueSources":[],"PresenterReportRowFormSources":[],"ScenarioWorkspace":[],"Scheduler":[],"RapidReport":[],"DDE":[],"Hierarchy":[],"PresenterFlex":[],"AdaptiveForms":[],"ReportDataModelSource":[],"PlanComponentSource":[],"PlanBuilderCalculation":[],"PlanBuilderItem":[]}},"property2":{"dependencies":{"Calendars":[],"StarSchemas":[],"Calculations":[],"SavedImports":[],"InputForms":[],"TaskGroup":[],"Plans":[],"TailoredReports":[],"Publications":[],"PayeeGroups":[],"Payees":[],"Blocks":[],"Ports":[],"WebForms":[],"WebFormFilters":[],"WorkflowGroups":[],"WebTab":[],"Transformations":[],"WebFormValidationRules":[],"DataStores":[],"BPMWorkflow":[],"BPMSwimLane":[],"BPMNode":[],"BPMComponent":[],"Views":[],"Tables":[],"PresenterReports":[],"PickList":[],"WebEditRestriction":[],"PresenterReportDataSources":[],"PresenterReportValueSources":[],"PresenterReportRowFormSources":[],"ScenarioWorkspace":[],"Scheduler":[],"RapidReport":[],"DDE":[],"Hierarchy":[],"PresenterFlex":[],"AdaptiveForms":[],"ReportDataModelSource":[],"PlanComponentSource":[],"PlanBuilderCalculation":[],"PlanBuilderItem":[]}}}

CalculationsControllerV1_GetUnaggregatedCalcs

Responses

Status

Meaning

Description

Schema

200

OK

Get list of unaggregated calcs

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/diffs/unaggregatedcalcs", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/diffs/unaggregatedcalcs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/diffs/unaggregatedcalcs',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/diffs/unaggregatedcalcs', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/diffs/unaggregatedcalcs',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  "string"
]
["string"]

Get available calculation methods.

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

Enumerated Values

Property

Value

additionalProperties

LimitAll

additionalProperties

LimitOne

additionalProperties

MaxDOP1

additionalProperties

SingleThreadedMerge

additionalProperties

DisableMerge

additionalProperties

SQL2014Estimator

additionalProperties

ForceClassic

additionalProperties

DisablePostCalculationOptimization

additionalProperties

UseIncrementalSyncback

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/calculations/methods", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/calculations/methods");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/calculations/methods',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/calculations/methods', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/calculations/methods',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "property1": "LimitAll",
  "property2": "LimitAll"
}
{"property1":"LimitAll","property2":"LimitAll"}

Returns which of the calculations are locked from the provided list of calculation IDs.

Body parameter

[
  0
]

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Get which of the given calculations are locked

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/calculations/locked", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/calculations/locked");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  0
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/calculations/locked',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/calculations/locked', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/calculations/locked',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  "string"
]
["string"]

ComposerControllerV1_ProcessMultiEdits

Body parameter

[
  {
    "elementId": 0,
    "parentBlockId": 0,
    "bounds": {
      "location": {},
      "size": "string",
      "x": 0.1,
      "y": 0.1,
      "width": 0.1,
      "height": 0.1
    },
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "name": "string",
    "parentBlock": {
      "id": 0,
      "name": "string",
      "href": "string"
    },
    "isVisible": true,
    "version": {
      "rowVersion": 0
    }
  }
]

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Composer.ElementDTO

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Process Multi Edit DTOs

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Composer.ElementDTO]

false

none

none

» elementId

integer(int32)

false

none

none

» parentBlockId

integer(int32)¦null

false

none

none

» bounds

System.Drawing.RectangleF

false

none

none

»» location

System.Drawing.PointF

false

none

none

»»» isEmpty

boolean

false

read-only

none

»»» x

number(float)

false

none

none

»»» y

number(float)

false

none

none

»» size

string

false

none

none

»» x

number(float)

false

none

none

»» y

number(float)

false

none

none

»» width

number(float)

false

none

none

»» height

number(float)

false

none

none

»» left

number(float)

false

read-only

none

»» top

number(float)

false

read-only

none

»» right

number(float)

false

read-only

none

»» bottom

number(float)

false

read-only

none

»» isEmpty

boolean

false

read-only

none

» color

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

none

»» a

integer(int32)

false

none

none

»» b

integer(int32)

false

none

none

»» g

integer(int32)

false

none

none

»» r

integer(int32)

false

none

none

» name

string¦null

false

none

none

» parentBlock

Varicent.RESTAPI.v1.DTOs.Composer.ExpandableBlockElementDTO

false

none

none

»» id

integer(int32)

false

none

none

»» name

string¦null

false

none

none

»» href

string¦null

false

none

none

» isVisible

boolean

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/composer/processmultiedits", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/composer/processmultiedits");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "elementId": 0,
    "parentBlockId": 0,
    "bounds": {
      "location": {},
      "size": "string",
      "x": 0.1,
      "y": 0.1,
      "width": 0.1,
      "height": 0.1
    },
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "name": "string",
    "parentBlock": {
      "id": 0,
      "name": "string",
      "href": "string"
    },
    "isVisible": true,
    "version": {
      "rowVersion": 0
    }
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/composer/processmultiedits',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/composer/processmultiedits', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/composer/processmultiedits',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "elementId": 0,
    "parentBlockId": 0,
    "bounds": {
      "location": {},
      "size": "string",
      "x": 0.1,
      "y": 0.1,
      "width": 0.1,
      "height": 0.1,
      "left": 0.1,
      "top": 0.1,
      "right": 0.1,
      "bottom": 0.1,
      "isEmpty": true
    },
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "name": "string",
    "parentBlock": {
      "id": 0,
      "name": "string",
      "href": "string"
    },
    "isVisible": true,
    "version": {
      "rowVersion": 0
    }
  }
]
[{"elementId":0,"parentBlockId":0,"bounds":{"location":{},"size":"string","x":0.1,"y":0.1,"width":0.1,"height":0.1,"left":0.1,"top":0.1,"right":0.1,"bottom":0.1,"isEmpty":true},"color":{"a":0,"b":0,"g":0,"r":0},"name":"string","parentBlock":{"id":0,"name":"string","href":"string"},"isVisible":true,"version":{"rowVersion":0}}]

Runs all Scenario Workspace calculations

Responses

Status

Meaning

Description

Schema

200

OK

All Scenario Workspace calculations started.

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/workspaces/calculate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/workspaces/calculate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/workspaces/calculate',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/workspaces/calculate', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/workspaces/calculate',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "property1": "string",
  "property2": "string"
}
{"property1":"string","property2":"string"}

Runs Scenario Workspace calculation for given workspace ID

Parameters

Name

In

Type

Required

Description

workspaceId

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Scenario Workspace calculation started.

Inline

400

Bad Request

Scenario Workspace with given ID does not exist.

None

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/workspaces/{workspaceId}/calculate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/workspaces/{workspaceId}/calculate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/workspaces/{workspaceId}/calculate',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/workspaces/{workspaceId}/calculate', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/workspaces/{workspaceId}/calculate',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "property1": "string",
  "property2": "string"
}
{"property1":"string","property2":"string"}

Component

Get all documents for a given component.

Block ID

block-id-parameters">Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

orderBy

query

string

false

####Description

Detailed descriptions

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

name, ext, date

block-id-responses">Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

block-id-responseschema">Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.BlockDocumentDTO]

false

none

none

» id

integer(int32)

false

none

none

» blockID

integer(int32)

false

none

none

» name

string¦null

false

none

none

» file

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/components/{id}/documents", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/components/{id}/documents");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/components/{id}/documents',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/components/{id}/documents', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/components/{id}/documents',
  params: {
  }, headers: headers

p JSON.parse(result)

Add a document to a given component.

Block IDDocument to add

Body parameter

{
  "id": 0,
  "blockID": 0,
  "name": "string",
  "file": "string"
}

block-iddocument-to-add-parameters">Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.BlockDocumentDTO

false

none

» id

body

integer(int32)

false

none

» blockID

body

integer(int32)

false

none

» name

body

string¦null

false

none

» file

body

string¦null

false

none

block-iddocument-to-add-responses">Responses

Status

Meaning

Description

Schema

201

Created

Created

Varicent.RESTAPI.v1.DTOs.BlockDocumentDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/components/{id}/documents", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/components/{id}/documents");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "blockID": 0,
  "name": "string",
  "file": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/components/{id}/documents',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/components/{id}/documents', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/components/{id}/documents',
  params: {
  }, headers: headers

p JSON.parse(result)

Get the contents of a document for a given component.

Block ID /// Document id

block-id ///-document-id-parameters">Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

docid

path

integer(int32)

true

none

block-id ///-document-id-responses">Responses

Status

Meaning

Description

Schema

200

OK

Get the contents of a document for a given component

Inline

block-id ///-document-id-responseschema">Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/components/{id}/documents/{docid}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/components/{id}/documents/{docid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/components/{id}/documents/{docid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/components/{id}/documents/{docid}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/components/{id}/documents/{docid}',
  params: {
  }, headers: headers

p JSON.parse(result)

Delete a document from a given component.

Block IDDocument ID

block-iddocument-id-parameters">Parameters

Name

In

Type

Required

Description

blockId

path

integer(int32)

true

none

docId

path

integer(int32)

true

none

block-iddocument-id-responses">Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/components/{blockId}/documents/{docId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/components/{blockId}/documents/{docId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/components/{blockId}/documents/{docId}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/components/{blockId}/documents/{docId}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/components/{blockId}/documents/{docId}',
  params: {
  }

p JSON.parse(result)

Get calculations.

Parameters

Name

In

Type

Required

Description

filter

query

string

false

####Supported operations

orderBy

query

string

false

####Description

Detailed descriptions

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

name

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

name

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.BlockElementDTO]

false

none

none

» blockDefinition

Varicent.RESTAPI.v1.DTOs.BlockDefinitionDTO

false

none

none

»» isRoot

boolean

false

none

none

»» isWaypoint

boolean

false

none

none

»» isInsertionPoint

boolean

false

none

none

»» hasDocuments

boolean

false

none

none

»» autoArrange

boolean

false

none

none

»» blockId

integer(int32)

false

none

none

»» name

string¦null

false

none

none

»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»» rowVersion

integer(int64)

false

none

none

» elementId

integer(int32)

false

none

none

» parentBlockId

integer(int32)¦null

false

none

none

» bounds

System.Drawing.RectangleF

false

none

none

»» location

System.Drawing.PointF

false

none

none

»»» isEmpty

boolean

false

read-only

none

»»» x

number(float)

false

none

none

»»» y

number(float)

false

none

none

»» size

string

false

none

none

»» x

number(float)

false

none

none

»» y

number(float)

false

none

none

»» width

number(float)

false

none

none

»» height

number(float)

false

none

none

»» left

number(float)

false

read-only

none

»» top

number(float)

false

read-only

none

»» right

number(float)

false

read-only

none

»» bottom

number(float)

false

read-only

none

»» isEmpty

boolean

false

read-only

none

» color

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

none

»» a

integer(int32)

false

none

none

»» b

integer(int32)

false

none

none

»» g

integer(int32)

false

none

none

»» r

integer(int32)

false

none

none

» name

string¦null

false

none

none

» parentBlock

Varicent.RESTAPI.v1.DTOs.Composer.ExpandableBlockElementDTO

false

none

none

»» id

integer(int32)

false

none

none

»» name

string¦null

false

none

none

»» href

string¦null

false

none

none

» isVisible

boolean

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/components", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/components");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/components',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/components', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/components',
  params: {
  }, headers: headers

p JSON.parse(result)

ComponentsControllerV1_Post

Body parameter

{
  "blockDefinition": {
    "isRoot": true,
    "isWaypoint": true,
    "isInsertionPoint": true,
    "hasDocuments": true,
    "autoArrange": true,
    "blockId": 0,
    "name": "string",
    "rowVersion": {
      "rowVersion": 0
    }
  },
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.BlockElementDTO

false

none

» blockDefinition

body

Varicent.RESTAPI.v1.DTOs.BlockDefinitionDTO

false

none

»» isRoot

body

boolean

false

none

»» isWaypoint

body

boolean

false

none

»» isInsertionPoint

body

boolean

false

none

»» hasDocuments

body

boolean

false

none

»» autoArrange

body

boolean

false

none

»» blockId

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» rowVersion

body

integer(int64)

false

none

» elementId

body

integer(int32)

false

none

» parentBlockId

body

integer(int32)¦null

false

none

» bounds

body

System.Drawing.RectangleF

false

none

»» location

body

System.Drawing.PointF

false

none

»»» isEmpty

body

boolean

false

none

»»» x

body

number(float)

false

none

»»» y

body

number(float)

false

none

»» size

body

string

false

none

»» x

body

number(float)

false

none

»» y

body

number(float)

false

none

»» width

body

number(float)

false

none

»» height

body

number(float)

false

none

»» left

body

number(float)

false

none

»» top

body

number(float)

false

none

»» right

body

number(float)

false

none

»» bottom

body

number(float)

false

none

»» isEmpty

body

boolean

false

none

» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»» a

body

integer(int32)

false

none

»» b

body

integer(int32)

false

none

»» g

body

integer(int32)

false

none

»» r

body

integer(int32)

false

none

» name

body

string¦null

false

none

» parentBlock

body

Varicent.RESTAPI.v1.DTOs.Composer.ExpandableBlockElementDTO

false

none

»» id

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» href

body

string¦null

false

none

» isVisible

body

boolean

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Create block

Varicent.RESTAPI.v1.DTOs.BlockElementDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/components", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/components");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "blockDefinition": {
    "isRoot": true,
    "isWaypoint": true,
    "isInsertionPoint": true,
    "hasDocuments": true,
    "autoArrange": true,
    "blockId": 0,
    "name": "string",
    "rowVersion": {
      "rowVersion": 0
    }
  },
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/components',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/components', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/components',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "blockDefinition": {
    "isRoot": true,
    "isWaypoint": true,
    "isInsertionPoint": true,
    "hasDocuments": true,
    "autoArrange": true,
    "blockId": 0,
    "name": "string",
    "rowVersion": {
      "rowVersion": 0
    }
  },
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "isEmpty": true,
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1,
    "left": 0.1,
    "top": 0.1,
    "right": 0.1,
    "bottom": 0.1,
    "isEmpty": true
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}
{"blockDefinition":{"isRoot":true,"isWaypoint":true,"isInsertionPoint":true,"hasDocuments":true,"autoArrange":true,"blockId":0,"name":"string","rowVersion":{"rowVersion":0}},"elementId":0,"parentBlockId":0,"bounds":{"location":{"isEmpty":true,"x":0.1,"y":0.1},"size":"string","x":0.1,"y":0.1,"width":0.1,"height":0.1,"left":0.1,"top":0.1,"right":0.1,"bottom":0.1,"isEmpty":true},"color":{"a":0,"b":0,"g":0,"r":0},"name":"string","parentBlock":{"id":0,"name":"string","href":"string"},"isVisible":true,"version":{"rowVersion":0}}

ComponentsControllerV1_Get

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get Block by ID

Varicent.RESTAPI.v1.DTOs.BlockElementDTO

404

Not Found

Block does not exist

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/components/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/components/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/components/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/components/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/components/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "blockDefinition": {
    "isRoot": true,
    "isWaypoint": true,
    "isInsertionPoint": true,
    "hasDocuments": true,
    "autoArrange": true,
    "blockId": 0,
    "name": "string",
    "rowVersion": {
      "rowVersion": 0
    }
  },
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "isEmpty": true,
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1,
    "left": 0.1,
    "top": 0.1,
    "right": 0.1,
    "bottom": 0.1,
    "isEmpty": true
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}
{"blockDefinition":{"isRoot":true,"isWaypoint":true,"isInsertionPoint":true,"hasDocuments":true,"autoArrange":true,"blockId":0,"name":"string","rowVersion":{"rowVersion":0}},"elementId":0,"parentBlockId":0,"bounds":{"location":{"isEmpty":true,"x":0.1,"y":0.1},"size":"string","x":0.1,"y":0.1,"width":0.1,"height":0.1,"left":0.1,"top":0.1,"right":0.1,"bottom":0.1,"isEmpty":true},"color":{"a":0,"b":0,"g":0,"r":0},"name":"string","parentBlock":{"id":0,"name":"string","href":"string"},"isVisible":true,"version":{"rowVersion":0}}

ComponentsControllerV1_Patch

Body parameter

{
  "name": "string",
  "autoArrange": true,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

RESTAPI.v1.DTOs.Composer.ComponentPatchDTO

false

none

» name

body

string¦null

false

none

» autoArrange

body

boolean¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Patch Block by ID

Varicent.RESTAPI.v1.DTOs.BlockElementDTO

404

Not Found

Block does not exist

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/components/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/components/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "name": "string",
  "autoArrange": true,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/components/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/components/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/components/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "blockDefinition": {
    "isRoot": true,
    "isWaypoint": true,
    "isInsertionPoint": true,
    "hasDocuments": true,
    "autoArrange": true,
    "blockId": 0,
    "name": "string",
    "rowVersion": {
      "rowVersion": 0
    }
  },
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "isEmpty": true,
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1,
    "left": 0.1,
    "top": 0.1,
    "right": 0.1,
    "bottom": 0.1,
    "isEmpty": true
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}
{"blockDefinition":{"isRoot":true,"isWaypoint":true,"isInsertionPoint":true,"hasDocuments":true,"autoArrange":true,"blockId":0,"name":"string","rowVersion":{"rowVersion":0}},"elementId":0,"parentBlockId":0,"bounds":{"location":{"isEmpty":true,"x":0.1,"y":0.1},"size":"string","x":0.1,"y":0.1,"width":0.1,"height":0.1,"left":0.1,"top":0.1,"right":0.1,"bottom":0.1,"isEmpty":true},"color":{"a":0,"b":0,"g":0,"r":0},"name":"string","parentBlock":{"id":0,"name":"string","href":"string"},"isVisible":true,"version":{"rowVersion":0}}

ComponentsControllerV1_Delete

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Delete Block by ID

None

404

Not Found

Block does not exist

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/components/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/components/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/components/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/components/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/components/{id}',
  params: {
  }

p JSON.parse(result)

Composer

Gets the full schema of the visible data sources in the component.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Composer block ID

selectedComponentId

query

integer(int32)

false

Selected component Id which excludes its output connections from data sources

includeGlobals

query

boolean

false

Defaults to true. If false, doesn’t return datastores or global tables at all.

includeExtendedTableColumns

query

boolean

false

Defaults to false. If true, returns any extended table columns for extended tables.

includeWebOptimized

query

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Composer.DataSourceSchemaDTO]

false

none

none

» displayName

string¦null

false

none

none

» details

Varicent.RESTAPI.v1.DTOs.ExpandableResourceDTO

false

none

none

»» href

string¦null

false

none

none

» type

string

false

none

none

» fullTableSchema

Varicent.RESTAPI.v1.DTOs.FullTableSchemaDTO

false

none

none

»» columns

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

none

»»» name

string¦null

false

none

none

»»» type

string

false

none

none

»»» isKey

boolean

false

none

none

»»» nullable

boolean

false

none

none

»»» values

string¦null

false

none

none

»»» lockedPeriod

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

none

»»»» start

string(date-time)

false

none

none

»»»» end

string(date-time)

false

none

none

»»» referencedCol

string¦null

false

none

none

»»» picklistFilter

string¦null

false

none

none

»»» displayName

string¦null

false

none

none

»»» isELTPeriod

boolean¦null

false

none

none

»» table

string¦null

false

none

none

»» name

string¦null

false

none

none

»» referencedSources

[string]¦null

false

none

none

»» referencedTimes

[Varicent.RESTAPI.v1.DTOs.FrequencyDTO]¦null

false

none

none

»»» levelId

string¦null

false

none

none

»»» timeId

string¦null

false

none

none

»» referencedSourcesDictionary

object¦null

false

none

none

»»» additionalProperties

string

false

none

none

»» referencedTimesDictionary

object¦null

false

none

none

»»» additionalProperties

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

none

» tableDefinition

Varicent.RESTAPI.v1.DTOs.TableDefinitionDTO

false

none

none

»» table

Varicent.RESTAPI.v1.DTOs.CustomTableDTO

false

none

none

»»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»» rowVersion

integer(int64)

false

none

none

»»» name

string¦null

false

none

none

»»» tableType

string

false

none

none

»»» effectiveDated

boolean

false

none

none

»»» workflowObjectID

integer(int32)

false

none

none

»»» hierarchyMetadata

RESTAPI.v1.DTOs.Hierarchy.HierarchyMetadataDTO

false

none

none

»»»» tableName

string¦null

false

none

none

»»»» idColumnName

string¦null

false

none

none

»»»» parentColumnName

string¦null

false

none

none

»»» lastUpdatedTracking

boolean¦null

false

none

none

»» columns

[Varicent.RESTAPI.v1.DTOs.ColumnDefinitionDTO]¦null

false

none

none

»»» column

Varicent.RESTAPI.v1.DTOs.CustomColumnDTO

false

none

none

»»»» name

string¦null

false

none

none

»»»» type

string

false

none

none

»»»» referencedTable

string¦null

false

none

none

»»»» referencedName

string¦null

false

none

none

»»»» source

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

»»»»» query

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

»»»»»» selectItems

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

none

»»»»»»» alias

string¦null

false

none

none

»»»»»»» column

string¦null

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» customSelect

string¦null

false

none

none

»»»»»»» dataType

string

false

none

none

»»»»»»» type

string

false

none

none

»»»»»»» value

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»»»»» expressionType

string

false

none

none

»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» table

string¦null

false

none

none

»»»»»»»» column

string¦null

false

none

none

»»»»»»»» op

string¦null

false

none

none

»»»»»»»» arguments

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

none

[DTO version of IExpression]

»»»»»»»»» expressionType

string

false

none

none

»»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»» table

string¦null

false

none

none

»»»»»»»»» column

string¦null

false

none

none

»»»»»»»»» op

string¦null

false

none

none

»»»»»»»»» arguments

array¦null

false

none

none

»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»»»»»» constraintType

string

false

none

none

»»»»»»»»»» op

string¦null

false

none

none

»»»»»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»»»»» expressionType

string

false

none

none

»»»»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»»»» table

string¦null

false

none

none

»»»»»»»»»»» column

string¦null

false

none

none

»»»»»»»»»»» op

string¦null

false

none

none

»»»»»»»»»»» arguments

array¦null

false

none

none

»»»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»»»» condition

any

false

none

none

»»»»»»»»»»» trueValue

any

false

none

none

»»»»»»»»»»» falseValue

any

false

none

none

»»»»»»»»»»» isDate

boolean

false

none

none

»»»»»»»»»»» literalType

string

false

none

none

»»»»»»»»»»» value

any

false

none

none

»»»»»»»»»» caseSensitive

boolean

false

none

none

»»»»»»»»»» constraints

array¦null

false

none

none

»»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»»» literalRight

any

false

none

none

»»»»»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»»»» right

any

false

none

none

»»»»»»»»»» expressionLeft

any

false

none

none

»»»»»»»»»» expressionRight

any

false

none

none

»»»»»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»»»»»» like

string¦null

false

none

none

»»»»»»»»»» escapeWildcards

boolean

false

none

none

»»»»»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»»»»» table

string¦null

false

none

none

»»»»»»»»»» queryDefinitionRight

any

false

none

none

»»»»»»»»» trueValue

any

false

none

none

»»»»»»»»» falseValue

any

false

none

none

»»»»»»»»» isDate

boolean

false

none

none

»»»»»»»»» literalType

string

false

none

none

»»»»»»»»» value

any

false

none

none

»»»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»»»» trueValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»»» falseValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»»» isDate

boolean

false

none

none

»»»»»»»» literalType

string

false

none

none

»»»»»»»» value

any

false

none

none

»»»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»»»»» namespaceTable

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

none

»»»»»»»» m_namespace

string¦null

false

none

none

»»»»»»»» name

string¦null

false

none

none

»»»»»»» query

any

false

none

none

»»»»»»» alias

string¦null

false

none

none

»»»»»»» sourceType

string

false

none

none

»»»»»» joins

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

none

»»»»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»»»»» joinType

string

false

none

none

»»»»»»» onClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»»»»» constraintType

string

false

none

none

»»»»»»»» op

string¦null

false

none

none

»»»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»» caseSensitive

boolean

false

none

none

»»»»»»»» constraints

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

none

[DTO version of IConstraint]

»»»»»»»» literalRight

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»» right

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»»» expressionLeft

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»»» expressionRight

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»»»» like

string¦null

false

none

none

»»»»»»»» escapeWildcards

boolean

false

none

none

»»»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»»» table

string¦null

false

none

none

»»»»»»»» queryDefinitionRight

any

false

none

none

»»»»»» whereClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»»» order

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» column

string¦null

false

none

none

»»»»»»» direction

string

false

none

none

»»»»»» group

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» column

string¦null

false

none

none

»»»»»» havingClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»»» distinct

boolean

false

none

none

»»»»»» unionWith

any

false

none

none

»»»»»» exceptWith

any

false

none

none

»»»»» sourceNames

object¦null

false

none

none

»»»»»» additionalProperties

string¦null

false

none

none

»»»» pickListParams

[Varicent.RESTAPI.v1.DTOs.PickListParamDTO]¦null

false

none

none

»»»»» joinAlias

string¦null

false

none

none

»»»»» joinColumn

string¦null

false

none

none

»»»»» op

string

false

none

none

»»»» isKey

boolean

false

none

none

»»» isRemovable

boolean

false

none

none

»»» isNullable

boolean

false

none

none

»»» referencedColumn

string¦null

false

none

none

»» time

Varicent.RESTAPI.v1.DTOs.TableTimeDTO

false

none

none

»»» timeId

string¦null

false

none

none

»»» dateColumn

string¦null

false

none

none

»»» lockedOn

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

»»» min

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

»»» max

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

» calculationDefinition

Varicent.RESTAPI.v1.DTOs.CalculationDefinitionDTO

false

none

none

»» calculationId

integer(int32)

false

none

none

»» calculationType

string

false

none

none

»» planBuilderCalculationId

string¦null

false

none

none

Enumerated Values

Property

Value

type

Table

type

Calculation

type

DataStore

type

Port

type

Symon

type

PlanBuilderCalculation

type

String

type

LongString

type

MaxString

type

Date

type

DateTime

type

Decimal

type

Int

type

Long

type

Float

type

BLOB

type

Identity

type

CLOB

type

RowVersion

type

UID

type

VarCharMax

type

Boolean

tableType

System

tableType

Dimension

tableType

Structural

tableType

Lookup

tableType

Data

tableType

View

tableType

Custom

tableType

StarSchema

tableType

ExportTable

tableType

CreditingRule

tableType

AssignTable

tableType

PlcmCustomTable

tableType

PlcmStructuralTable

tableType

PlcmTable

tableType

DataSource

tableType

Cached

tableType

MaterializedView

type

Text

type

Date

type

List

type

Numeric

type

Email

type

Url

type

Comment

type

DateTime

dataType

Int

dataType

Decimal

dataType

DateTime

dataType

None

dataType

String

type

SelectAll

type

SelectItem

type

SelectLiteral

type

SelectCustom

type

SelectExpression

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

sourceType

Table

sourceType

Query

joinType

Inner

joinType

Left

joinType

Right

joinType

Cross

joinType

CrossApply

joinType

OuterApply

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

direction

Ascending

direction

Descending

direction

AscendingNullsFirst

direction

DescendingNullsLast

op

LessThan

op

LessThanEquals

op

Equals

op

NotEquals

op

GreaterThan

op

GreaterThanEquals

op

IsNull

op

IsNotNull

op

In

op

NotIn

calculationType

Mathematical

calculationType

Sorting

calculationType

TimeShift

calculationType

Category

calculationType

Symon

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/composer/{id}/datasources", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/composer/{id}/datasources");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/composer/{id}/datasources',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/composer/{id}/datasources', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/composer/{id}/datasources',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "displayName": "string",
    "details": {
      "href": "string"
    },
    "type": "Table",
    "fullTableSchema": {
      "columns": [],
      "table": "string",
      "name": "string",
      "referencedSources": [],
      "referencedTimes": [],
      "referencedSourcesDictionary": {},
      "referencedTimesDictionary": {}
    },
    "tableDefinition": {
      "table": {},
      "columns": [],
      "time": {}
    },
    "calculationDefinition": {
      "calculationId": 0,
      "calculationType": "Mathematical",
      "planBuilderCalculationId": "string"
    }
  }
]
[{"displayName":"string","details":{"href":"string"},"type":"Table","fullTableSchema":{"columns":[],"table":"string","name":"string","referencedSources":[],"referencedTimes":[],"referencedSourcesDictionary":{},"referencedTimesDictionary":{}},"tableDefinition":{"table":{},"columns":[],"time":{}},"calculationDefinition":{"calculationId":0,"calculationType":"Mathematical","planBuilderCalculationId":"string"}}]

Returns table schemas that are directly referenced by the given sourceNames up to the given depth.

Depth is the number of levels of references to return. Allowed values are 1, 2, 3. Setting IncludeExtendedTableColumns to true will include extended table columns if table is extended.

Body parameter

{
  "sourceNames": [
    "string"
  ],
  "depth": 0,
  "includeExtendedTableColumns": true,
  "includeLastUpdatedTrackingColumns": true
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.GetDataSourceSchemasDTO

false

none

» sourceNames

body

[string]¦null

false

none

» depth

body

integer(int32)

false

none

» includeExtendedTableColumns

body

boolean

false

none

» includeLastUpdatedTrackingColumns

body

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Composer.DataSourceSchemaDTO]

false

none

none

» displayName

string¦null

false

none

none

» details

Varicent.RESTAPI.v1.DTOs.ExpandableResourceDTO

false

none

none

»» href

string¦null

false

none

none

» type

string

false

none

none

» fullTableSchema

Varicent.RESTAPI.v1.DTOs.FullTableSchemaDTO

false

none

none

»» columns

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

none

»»» name

string¦null

false

none

none

»»» type

string

false

none

none

»»» isKey

boolean

false

none

none

»»» nullable

boolean

false

none

none

»»» values

string¦null

false

none

none

»»» lockedPeriod

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

none

»»»» start

string(date-time)

false

none

none

»»»» end

string(date-time)

false

none

none

»»» referencedCol

string¦null

false

none

none

»»» picklistFilter

string¦null

false

none

none

»»» displayName

string¦null

false

none

none

»»» isELTPeriod

boolean¦null

false

none

none

»» table

string¦null

false

none

none

»» name

string¦null

false

none

none

»» referencedSources

[string]¦null

false

none

none

»» referencedTimes

[Varicent.RESTAPI.v1.DTOs.FrequencyDTO]¦null

false

none

none

»»» levelId

string¦null

false

none

none

»»» timeId

string¦null

false

none

none

»» referencedSourcesDictionary

object¦null

false

none

none

»»» additionalProperties

string

false

none

none

»» referencedTimesDictionary

object¦null

false

none

none

»»» additionalProperties

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

none

» tableDefinition

Varicent.RESTAPI.v1.DTOs.TableDefinitionDTO

false

none

none

»» table

Varicent.RESTAPI.v1.DTOs.CustomTableDTO

false

none

none

»»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»» rowVersion

integer(int64)

false

none

none

»»» name

string¦null

false

none

none

»»» tableType

string

false

none

none

»»» effectiveDated

boolean

false

none

none

»»» workflowObjectID

integer(int32)

false

none

none

»»» hierarchyMetadata

RESTAPI.v1.DTOs.Hierarchy.HierarchyMetadataDTO

false

none

none

»»»» tableName

string¦null

false

none

none

»»»» idColumnName

string¦null

false

none

none

»»»» parentColumnName

string¦null

false

none

none

»»» lastUpdatedTracking

boolean¦null

false

none

none

»» columns

[Varicent.RESTAPI.v1.DTOs.ColumnDefinitionDTO]¦null

false

none

none

»»» column

Varicent.RESTAPI.v1.DTOs.CustomColumnDTO

false

none

none

»»»» name

string¦null

false

none

none

»»»» type

string

false

none

none

»»»» referencedTable

string¦null

false

none

none

»»»» referencedName

string¦null

false

none

none

»»»» source

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

»»»»» query

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

»»»»»» selectItems

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

none

»»»»»»» alias

string¦null

false

none

none

»»»»»»» column

string¦null

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» customSelect

string¦null

false

none

none

»»»»»»» dataType

string

false

none

none

»»»»»»» type

string

false

none

none

»»»»»»» value

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»»»»» expressionType

string

false

none

none

»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» table

string¦null

false

none

none

»»»»»»»» column

string¦null

false

none

none

»»»»»»»» op

string¦null

false

none

none

»»»»»»»» arguments

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

none

[DTO version of IExpression]

»»»»»»»»» expressionType

string

false

none

none

»»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»» table

string¦null

false

none

none

»»»»»»»»» column

string¦null

false

none

none

»»»»»»»»» op

string¦null

false

none

none

»»»»»»»»» arguments

array¦null

false

none

none

»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»»»»»» constraintType

string

false

none

none

»»»»»»»»»» op

string¦null

false

none

none

»»»»»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»»»»» expressionType

string

false

none

none

»»»»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»»»» table

string¦null

false

none

none

»»»»»»»»»»» column

string¦null

false

none

none

»»»»»»»»»»» op

string¦null

false

none

none

»»»»»»»»»»» arguments

array¦null

false

none

none

»»»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»»»» condition

any

false

none

none

»»»»»»»»»»» trueValue

any

false

none

none

»»»»»»»»»»» falseValue

any

false

none

none

»»»»»»»»»»» isDate

boolean

false

none

none

»»»»»»»»»»» literalType

string

false

none

none

»»»»»»»»»»» value

any

false

none

none

»»»»»»»»»» caseSensitive

boolean

false

none

none

»»»»»»»»»» constraints

array¦null

false

none

none

»»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»»» literalRight

any

false

none

none

»»»»»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»»»» right

any

false

none

none

»»»»»»»»»» expressionLeft

any

false

none

none

»»»»»»»»»» expressionRight

any

false

none

none

»»»»»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»»»»»» like

string¦null

false

none

none

»»»»»»»»»» escapeWildcards

boolean

false

none

none

»»»»»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»»»»» table

string¦null

false

none

none

»»»»»»»»»» queryDefinitionRight

any

false

none

none

»»»»»»»»» trueValue

any

false

none

none

»»»»»»»»» falseValue

any

false

none

none

»»»»»»»»» isDate

boolean

false

none

none

»»»»»»»»» literalType

string

false

none

none

»»»»»»»»» value

any

false

none

none

»»»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»»»» trueValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»»» falseValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»»» isDate

boolean

false

none

none

»»»»»»»» literalType

string

false

none

none

»»»»»»»» value

any

false

none

none

»»»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»»»»» namespaceTable

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

none

»»»»»»»» m_namespace

string¦null

false

none

none

»»»»»»»» name

string¦null

false

none

none

»»»»»»» query

any

false

none

none

»»»»»»» alias

string¦null

false

none

none

»»»»»»» sourceType

string

false

none

none

»»»»»» joins

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

none

»»»»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»»»»» joinType

string

false

none

none

»»»»»»» onClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»»»»» constraintType

string

false

none

none

»»»»»»»» op

string¦null

false

none

none

»»»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»» caseSensitive

boolean

false

none

none

»»»»»»»» constraints

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

none

[DTO version of IConstraint]

»»»»»»»» literalRight

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»» right

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»»» expressionLeft

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»»» expressionRight

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»»»» like

string¦null

false

none

none

»»»»»»»» escapeWildcards

boolean

false

none

none

»»»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»»» table

string¦null

false

none

none

»»»»»»»» queryDefinitionRight

any

false

none

none

»»»»»» whereClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»»» order

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» column

string¦null

false

none

none

»»»»»»» direction

string

false

none

none

»»»»»» group

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» column

string¦null

false

none

none

»»»»»» havingClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»»» distinct

boolean

false

none

none

»»»»»» unionWith

any

false

none

none

»»»»»» exceptWith

any

false

none

none

»»»»» sourceNames

object¦null

false

none

none

»»»»»» additionalProperties

string¦null

false

none

none

»»»» pickListParams

[Varicent.RESTAPI.v1.DTOs.PickListParamDTO]¦null

false

none

none

»»»»» joinAlias

string¦null

false

none

none

»»»»» joinColumn

string¦null

false

none

none

»»»»» op

string

false

none

none

»»»» isKey

boolean

false

none

none

»»» isRemovable

boolean

false

none

none

»»» isNullable

boolean

false

none

none

»»» referencedColumn

string¦null

false

none

none

»» time

Varicent.RESTAPI.v1.DTOs.TableTimeDTO

false

none

none

»»» timeId

string¦null

false

none

none

»»» dateColumn

string¦null

false

none

none

»»» lockedOn

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

»»» min

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

»»» max

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

» calculationDefinition

Varicent.RESTAPI.v1.DTOs.CalculationDefinitionDTO

false

none

none

»» calculationId

integer(int32)

false

none

none

»» calculationType

string

false

none

none

»» planBuilderCalculationId

string¦null

false

none

none

Enumerated Values

Property

Value

type

Table

type

Calculation

type

DataStore

type

Port

type

Symon

type

PlanBuilderCalculation

type

String

type

LongString

type

MaxString

type

Date

type

DateTime

type

Decimal

type

Int

type

Long

type

Float

type

BLOB

type

Identity

type

CLOB

type

RowVersion

type

UID

type

VarCharMax

type

Boolean

tableType

System

tableType

Dimension

tableType

Structural

tableType

Lookup

tableType

Data

tableType

View

tableType

Custom

tableType

StarSchema

tableType

ExportTable

tableType

CreditingRule

tableType

AssignTable

tableType

PlcmCustomTable

tableType

PlcmStructuralTable

tableType

PlcmTable

tableType

DataSource

tableType

Cached

tableType

MaterializedView

type

Text

type

Date

type

List

type

Numeric

type

Email

type

Url

type

Comment

type

DateTime

dataType

Int

dataType

Decimal

dataType

DateTime

dataType

None

dataType

String

type

SelectAll

type

SelectItem

type

SelectLiteral

type

SelectCustom

type

SelectExpression

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

sourceType

Table

sourceType

Query

joinType

Inner

joinType

Left

joinType

Right

joinType

Cross

joinType

CrossApply

joinType

OuterApply

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

direction

Ascending

direction

Descending

direction

AscendingNullsFirst

direction

DescendingNullsLast

op

LessThan

op

LessThanEquals

op

Equals

op

NotEquals

op

GreaterThan

op

GreaterThanEquals

op

IsNull

op

IsNotNull

op

In

op

NotIn

calculationType

Mathematical

calculationType

Sorting

calculationType

TimeShift

calculationType

Category

calculationType

Symon

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/datasourceschemas", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/datasourceschemas");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "sourceNames": [
    "string"
  ],
  "depth": 0,
  "includeExtendedTableColumns": true,
  "includeLastUpdatedTrackingColumns": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/datasourceschemas',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/datasourceschemas', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/datasourceschemas',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "displayName": "string",
    "details": {
      "href": "string"
    },
    "type": "Table",
    "fullTableSchema": {
      "columns": [],
      "table": "string",
      "name": "string",
      "referencedSources": [],
      "referencedTimes": [],
      "referencedSourcesDictionary": {},
      "referencedTimesDictionary": {}
    },
    "tableDefinition": {
      "table": {},
      "columns": [],
      "time": {}
    },
    "calculationDefinition": {
      "calculationId": 0,
      "calculationType": "Mathematical",
      "planBuilderCalculationId": "string"
    }
  }
]
[{"displayName":"string","details":{"href":"string"},"type":"Table","fullTableSchema":{"columns":[],"table":"string","name":"string","referencedSources":[],"referencedTimes":[],"referencedSourcesDictionary":{},"referencedTimesDictionary":{}},"tableDefinition":{"table":{},"columns":[],"time":{}},"calculationDefinition":{"calculationId":0,"calculationType":"Mathematical","planBuilderCalculationId":"string"}}]

Returns the first few sources of each category (tables, caculations, and so on) from the entire model.

Parameters

Name

In

Type

Required

Description

filter

query

string

false

####Supported operations

excludeSystemDataSource

query

boolean

false

none

excludeWorkflowSystemDataSource

query

boolean

false

none

excludePorts

query

boolean

false

none

excludeViews

query

boolean

false

none

limit

query

integer(int32)

false

Maximum number of sources returned per category (tables, caculations, and so on).

includeExtendedTableColumns

query

boolean

false

Defaults to false. If true, returns any extended table columns for extended tables.

excludeCustomDataStore

query

boolean

false

none

includeLastUpdatedTrackingColumns

query

boolean

false

none

Detailed descriptions

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

name

limit: Maximum number of sources returned per category (tables, caculations, and so on). Defaults to 50. Changing the default is NOT recommended and will result in major performance loss. Number of records to retrieve.

Default: 100

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Composer.DataSourceSchemaDTO]

false

none

none

» displayName

string¦null

false

none

none

» details

Varicent.RESTAPI.v1.DTOs.ExpandableResourceDTO

false

none

none

»» href

string¦null

false

none

none

» type

string

false

none

none

» fullTableSchema

Varicent.RESTAPI.v1.DTOs.FullTableSchemaDTO

false

none

none

»» columns

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

none

»»» name

string¦null

false

none

none

»»» type

string

false

none

none

»»» isKey

boolean

false

none

none

»»» nullable

boolean

false

none

none

»»» values

string¦null

false

none

none

»»» lockedPeriod

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

none

»»»» start

string(date-time)

false

none

none

»»»» end

string(date-time)

false

none

none

»»» referencedCol

string¦null

false

none

none

»»» picklistFilter

string¦null

false

none

none

»»» displayName

string¦null

false

none

none

»»» isELTPeriod

boolean¦null

false

none

none

»» table

string¦null

false

none

none

»» name

string¦null

false

none

none

»» referencedSources

[string]¦null

false

none

none

»» referencedTimes

[Varicent.RESTAPI.v1.DTOs.FrequencyDTO]¦null

false

none

none

»»» levelId

string¦null

false

none

none

»»» timeId

string¦null

false

none

none

»» referencedSourcesDictionary

object¦null

false

none

none

»»» additionalProperties

string

false

none

none

»» referencedTimesDictionary

object¦null

false

none

none

»»» additionalProperties

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

none

» tableDefinition

Varicent.RESTAPI.v1.DTOs.TableDefinitionDTO

false

none

none

»» table

Varicent.RESTAPI.v1.DTOs.CustomTableDTO

false

none

none

»»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»» rowVersion

integer(int64)

false

none

none

»»» name

string¦null

false

none

none

»»» tableType

string

false

none

none

»»» effectiveDated

boolean

false

none

none

»»» workflowObjectID

integer(int32)

false

none

none

»»» hierarchyMetadata

RESTAPI.v1.DTOs.Hierarchy.HierarchyMetadataDTO

false

none

none

»»»» tableName

string¦null

false

none

none

»»»» idColumnName

string¦null

false

none

none

»»»» parentColumnName

string¦null

false

none

none

»»» lastUpdatedTracking

boolean¦null

false

none

none

»» columns

[Varicent.RESTAPI.v1.DTOs.ColumnDefinitionDTO]¦null

false

none

none

»»» column

Varicent.RESTAPI.v1.DTOs.CustomColumnDTO

false

none

none

»»»» name

string¦null

false

none

none

»»»» type

string

false

none

none

»»»» referencedTable

string¦null

false

none

none

»»»» referencedName

string¦null

false

none

none

»»»» source

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

»»»»» query

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

»»»»»» selectItems

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

none

»»»»»»» alias

string¦null

false

none

none

»»»»»»» column

string¦null

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» customSelect

string¦null

false

none

none

»»»»»»» dataType

string

false

none

none

»»»»»»» type

string

false

none

none

»»»»»»» value

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»»»»» expressionType

string

false

none

none

»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» table

string¦null

false

none

none

»»»»»»»» column

string¦null

false

none

none

»»»»»»»» op

string¦null

false

none

none

»»»»»»»» arguments

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

none

[DTO version of IExpression]

»»»»»»»»» expressionType

string

false

none

none

»»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»» table

string¦null

false

none

none

»»»»»»»»» column

string¦null

false

none

none

»»»»»»»»» op

string¦null

false

none

none

»»»»»»»»» arguments

array¦null

false

none

none

»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»»»»»» constraintType

string

false

none

none

»»»»»»»»»» op

string¦null

false

none

none

»»»»»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»»»»» expressionType

string

false

none

none

»»»»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»»»» table

string¦null

false

none

none

»»»»»»»»»»» column

string¦null

false

none

none

»»»»»»»»»»» op

string¦null

false

none

none

»»»»»»»»»»» arguments

array¦null

false

none

none

»»»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»»»» condition

any

false

none

none

»»»»»»»»»»» trueValue

any

false

none

none

»»»»»»»»»»» falseValue

any

false

none

none

»»»»»»»»»»» isDate

boolean

false

none

none

»»»»»»»»»»» literalType

string

false

none

none

»»»»»»»»»»» value

any

false

none

none

»»»»»»»»»» caseSensitive

boolean

false

none

none

»»»»»»»»»» constraints

array¦null

false

none

none

»»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»»» literalRight

any

false

none

none

»»»»»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»»»» right

any

false

none

none

»»»»»»»»»» expressionLeft

any

false

none

none

»»»»»»»»»» expressionRight

any

false

none

none

»»»»»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»»»»»» like

string¦null

false

none

none

»»»»»»»»»» escapeWildcards

boolean

false

none

none

»»»»»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»»»»» table

string¦null

false

none

none

»»»»»»»»»» queryDefinitionRight

any

false

none

none

»»»»»»»»» trueValue

any

false

none

none

»»»»»»»»» falseValue

any

false

none

none

»»»»»»»»» isDate

boolean

false

none

none

»»»»»»»»» literalType

string

false

none

none

»»»»»»»»» value

any

false

none

none

»»»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»»»» trueValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»»» falseValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»»» isDate

boolean

false

none

none

»»»»»»»» literalType

string

false

none

none

»»»»»»»» value

any

false

none

none

»»»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»»»»» namespaceTable

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

none

»»»»»»»» m_namespace

string¦null

false

none

none

»»»»»»»» name

string¦null

false

none

none

»»»»»»» query

any

false

none

none

»»»»»»» alias

string¦null

false

none

none

»»»»»»» sourceType

string

false

none

none

»»»»»» joins

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

none

»»»»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»»»»» joinType

string

false

none

none

»»»»»»» onClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»»»»» constraintType

string

false

none

none

»»»»»»»» op

string¦null

false

none

none

»»»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»» caseSensitive

boolean

false

none

none

»»»»»»»» constraints

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

none

[DTO version of IConstraint]

»»»»»»»» literalRight

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»» right

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»»» expressionLeft

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»»» expressionRight

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»»»» like

string¦null

false

none

none

»»»»»»»» escapeWildcards

boolean

false

none

none

»»»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»»» table

string¦null

false

none

none

»»»»»»»» queryDefinitionRight

any

false

none

none

»»»»»» whereClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»»» order

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» column

string¦null

false

none

none

»»»»»»» direction

string

false

none

none

»»»»»» group

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» column

string¦null

false

none

none

»»»»»» havingClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»»» distinct

boolean

false

none

none

»»»»»» unionWith

any

false

none

none

»»»»»» exceptWith

any

false

none

none

»»»»» sourceNames

object¦null

false

none

none

»»»»»» additionalProperties

string¦null

false

none

none

»»»» pickListParams

[Varicent.RESTAPI.v1.DTOs.PickListParamDTO]¦null

false

none

none

»»»»» joinAlias

string¦null

false

none

none

»»»»» joinColumn

string¦null

false

none

none

»»»»» op

string

false

none

none

»»»» isKey

boolean

false

none

none

»»» isRemovable

boolean

false

none

none

»»» isNullable

boolean

false

none

none

»»» referencedColumn

string¦null

false

none

none

»» time

Varicent.RESTAPI.v1.DTOs.TableTimeDTO

false

none

none

»»» timeId

string¦null

false

none

none

»»» dateColumn

string¦null

false

none

none

»»» lockedOn

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

»»» min

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

»»» max

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

» calculationDefinition

Varicent.RESTAPI.v1.DTOs.CalculationDefinitionDTO

false

none

none

»» calculationId

integer(int32)

false

none

none

»» calculationType

string

false

none

none

»» planBuilderCalculationId

string¦null

false

none

none

Enumerated Values

Property

Value

type

Table

type

Calculation

type

DataStore

type

Port

type

Symon

type

PlanBuilderCalculation

type

String

type

LongString

type

MaxString

type

Date

type

DateTime

type

Decimal

type

Int

type

Long

type

Float

type

BLOB

type

Identity

type

CLOB

type

RowVersion

type

UID

type

VarCharMax

type

Boolean

tableType

System

tableType

Dimension

tableType

Structural

tableType

Lookup

tableType

Data

tableType

View

tableType

Custom

tableType

StarSchema

tableType

ExportTable

tableType

CreditingRule

tableType

AssignTable

tableType

PlcmCustomTable

tableType

PlcmStructuralTable

tableType

PlcmTable

tableType

DataSource

tableType

Cached

tableType

MaterializedView

type

Text

type

Date

type

List

type

Numeric

type

Email

type

Url

type

Comment

type

DateTime

dataType

Int

dataType

Decimal

dataType

DateTime

dataType

None

dataType

String

type

SelectAll

type

SelectItem

type

SelectLiteral

type

SelectCustom

type

SelectExpression

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

sourceType

Table

sourceType

Query

joinType

Inner

joinType

Left

joinType

Right

joinType

Cross

joinType

CrossApply

joinType

OuterApply

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

direction

Ascending

direction

Descending

direction

AscendingNullsFirst

direction

DescendingNullsLast

op

LessThan

op

LessThanEquals

op

Equals

op

NotEquals

op

GreaterThan

op

GreaterThanEquals

op

IsNull

op

IsNotNull

op

In

op

NotIn

calculationType

Mathematical

calculationType

Sorting

calculationType

TimeShift

calculationType

Category

calculationType

Symon

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/composer/datasources", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/composer/datasources");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/composer/datasources',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/composer/datasources', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/composer/datasources',
  params: {
  }, headers: headers

p JSON.parse(result)

This is called upon saving multi edit changes

Body parameter

[
  {
    "elementId": 0,
    "parentBlockId": 0,
    "bounds": {
      "location": {},
      "size": "string",
      "x": 0.1,
      "y": 0.1,
      "width": 0.1,
      "height": 0.1
    },
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "name": "string",
    "parentBlock": {
      "id": 0,
      "name": "string",
      "href": "string"
    },
    "isVisible": true,
    "version": {
      "rowVersion": 0
    }
  }
]

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Composer.ElementDTO

false

ElementDTO

Responses

Status

Meaning

Description

Schema

200

OK

Submit multi edit changes

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Composer.ElementDTO]

false

none

none

» elementId

integer(int32)

false

none

none

» parentBlockId

integer(int32)¦null

false

none

none

» bounds

System.Drawing.RectangleF

false

none

none

»» location

System.Drawing.PointF

false

none

none

»»» isEmpty

boolean

false

read-only

none

»»» x

number(float)

false

none

none

»»» y

number(float)

false

none

none

»» size

string

false

none

none

»» x

number(float)

false

none

none

»» y

number(float)

false

none

none

»» width

number(float)

false

none

none

»» height

number(float)

false

none

none

»» left

number(float)

false

read-only

none

»» top

number(float)

false

read-only

none

»» right

number(float)

false

read-only

none

»» bottom

number(float)

false

read-only

none

»» isEmpty

boolean

false

read-only

none

» color

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

none

»» a

integer(int32)

false

none

none

»» b

integer(int32)

false

none

none

»» g

integer(int32)

false

none

none

»» r

integer(int32)

false

none

none

» name

string¦null

false

none

none

» parentBlock

Varicent.RESTAPI.v1.DTOs.Composer.ExpandableBlockElementDTO

false

none

none

»» id

integer(int32)

false

none

none

»» name

string¦null

false

none

none

»» href

string¦null

false

none

none

» isVisible

boolean

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/composer/multiedits", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/composer/multiedits");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "elementId": 0,
    "parentBlockId": 0,
    "bounds": {
      "location": {},
      "size": "string",
      "x": 0.1,
      "y": 0.1,
      "width": 0.1,
      "height": 0.1
    },
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "name": "string",
    "parentBlock": {
      "id": 0,
      "name": "string",
      "href": "string"
    },
    "isVisible": true,
    "version": {
      "rowVersion": 0
    }
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/composer/multiedits',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/composer/multiedits', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/composer/multiedits',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "elementId": 0,
    "parentBlockId": 0,
    "bounds": {
      "location": {},
      "size": "string",
      "x": 0.1,
      "y": 0.1,
      "width": 0.1,
      "height": 0.1,
      "left": 0.1,
      "top": 0.1,
      "right": 0.1,
      "bottom": 0.1,
      "isEmpty": true
    },
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "name": "string",
    "parentBlock": {
      "id": 0,
      "name": "string",
      "href": "string"
    },
    "isVisible": true,
    "version": {
      "rowVersion": 0
    }
  }
]
[{"elementId":0,"parentBlockId":0,"bounds":{"location":{},"size":"string","x":0.1,"y":0.1,"width":0.1,"height":0.1,"left":0.1,"top":0.1,"right":0.1,"bottom":0.1,"isEmpty":true},"color":{"a":0,"b":0,"g":0,"r":0},"name":"string","parentBlock":{"id":0,"name":"string","href":"string"},"isVisible":true,"version":{"rowVersion":0}}]

Get Salesforce.com table names with a given username and password.

Body parameter

{
  "username": "string",
  "password": "string",
  "token": "string",
  "sandbox": true
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Composer.DataImport.SalesforceConfigDTO

false

none

» username

body

string¦null

false

none

» password

body

string¦null

false

none

» token

body

string¦null

false

none

» sandbox

body

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Get Salesforce.com table names given username and password.

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.Composer.SalesforceTableNameDTO]

false

none

none

» filename

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/composer/salesforce/tables", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/composer/salesforce/tables");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "username": "string",
  "password": "string",
  "token": "string",
  "sandbox": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/composer/salesforce/tables',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/composer/salesforce/tables', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/composer/salesforce/tables',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "filename": "string"
  }
]
[{"filename":"string"}]

Get Salesforce.com table schema.

Body parameter

{
  "username": "string",
  "password": "string",
  "token": "string",
  "sandbox": true
}

Parameters

Name

In

Type

Required

Description

table

path

string

true

none

body

body

RESTAPI.v1.DTOs.Composer.DataImport.SalesforceConfigDTO

false

none

» username

body

string¦null

false

none

» password

body

string¦null

false

none

» token

body

string¦null

false

none

» sandbox

body

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Get Salesforce.com table schema.

RESTAPI.v1.DTOs.Composer.DataImport.SalesforceTableSchemaDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/composer/salesforce/tables/schema/{table}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/composer/salesforce/tables/schema/{table}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "username": "string",
  "password": "string",
  "token": "string",
  "sandbox": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/composer/salesforce/tables/schema/{table}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/composer/salesforce/tables/schema/{table}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/composer/salesforce/tables/schema/{table}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "dsr": {
    "actionOverrides": [
      {}
    ],
    "activateable": true,
    "childRelationships": [
      {}
    ],
    "compactLayoutable": true,
    "createable": true,
    "custom": true,
    "customSetting": true,
    "dataTranslationEnabled": true,
    "dataTranslationEnabledSpecified": true,
    "deepCloneable": true,
    "defaultImplementation": "string",
    "deletable": true,
    "deprecatedAndHidden": true,
    "feedEnabled": true,
    "fields": [
      {}
    ],
    "hasSubtypes": true,
    "idEnabled": true,
    "implementedBy": "string",
    "implementsInterfaces": "string",
    "isInterface": true,
    "isSubtype": true,
    "keyPrefix": "string",
    "label": "string",
    "labelPlural": "string",
    "layoutable": true,
    "mergeable": true,
    "mruEnabled": true,
    "name": "string",
    "namedLayoutInfos": [
      {}
    ],
    "networkScopeFieldName": "string",
    "queryable": true,
    "recordTypeInfos": [
      {}
    ],
    "replicateable": true,
    "retrieveable": true,
    "searchLayoutable": true,
    "searchLayoutableSpecified": true,
    "searchable": true,
    "supportedScopes": [
      {}
    ],
    "triggerable": true,
    "triggerableSpecified": true,
    "undeletable": true,
    "updateable": true,
    "urlDetail": "string",
    "urlEdit": "string",
    "urlNew": "string"
  },
  "columns": {
    "property1": {
      "field": {}
    },
    "property2": {
      "field": {}
    }
  }
}
{"dsr":{"actionOverrides":[{}],"activateable":true,"childRelationships":[{}],"compactLayoutable":true,"createable":true,"custom":true,"customSetting":true,"dataTranslationEnabled":true,"dataTranslationEnabledSpecified":true,"deepCloneable":true,"defaultImplementation":"string","deletable":true,"deprecatedAndHidden":true,"feedEnabled":true,"fields":[{}],"hasSubtypes":true,"idEnabled":true,"implementedBy":"string","implementsInterfaces":"string","isInterface":true,"isSubtype":true,"keyPrefix":"string","label":"string","labelPlural":"string","layoutable":true,"mergeable":true,"mruEnabled":true,"name":"string","namedLayoutInfos":[{}],"networkScopeFieldName":"string","queryable":true,"recordTypeInfos":[{}],"replicateable":true,"retrieveable":true,"searchLayoutable":true,"searchLayoutableSpecified":true,"searchable":true,"supportedScopes":[{}],"triggerable":true,"triggerableSpecified":true,"undeletable":true,"updateable":true,"urlDetail":"string","urlEdit":"string","urlNew":"string"},"columns":{"property1":{"field":{}},"property2":{"field":{}}}}

Get a full table schema with a given table name.

Parameters

Name

In

Type

Required

Description

table

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get full table schema given table name.

Varicent.RESTAPI.v1.DTOs.FullTableSchemaDTO

404

Not Found

Table does not exist.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/composer/fulltableschema/{table}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/composer/fulltableschema/{table}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/composer/fulltableschema/{table}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/composer/fulltableschema/{table}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/composer/fulltableschema/{table}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "columns": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "table": "string",
  "name": "string",
  "referencedSources": [
    "string"
  ],
  "referencedTimes": [
    {
      "levelId": "string",
      "timeId": "string"
    }
  ],
  "referencedSourcesDictionary": {
    "property1": "string",
    "property2": "string"
  },
  "referencedTimesDictionary": {
    "property1": {
      "levelId": "string",
      "timeId": "string"
    },
    "property2": {
      "levelId": "string",
      "timeId": "string"
    }
  }
}
{"columns":[{"name":"string","type":"String","isKey":true,"nullable":true,"values":"string","lockedPeriod":{},"referencedCol":"string","picklistFilter":"string","displayName":"string","isELTPeriod":true}],"table":"string","name":"string","referencedSources":["string"],"referencedTimes":[{"levelId":"string","timeId":"string"}],"referencedSourcesDictionary":{"property1":"string","property2":"string"},"referencedTimesDictionary":{"property1":{"levelId":"string","timeId":"string"},"property2":{"levelId":"string","timeId":"string"}}}

Get all imports.

Responses

Status

Meaning

Description

Schema

200

OK

Get all imports.

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.Composer.DataImport.ImportParamsDTO]

false

none

none

» name

string¦null

false

none

none

» importType

string

false

none

none

» hasHeader

boolean

false

none

none

» table

string¦null

false

none

none

» columnMatchings

RESTAPI.v1.DTOs.ColumnMatchingsDTO

false

none

none

»» columns

[string]¦null

false

none

none

»» matched

[string]¦null

false

none

none

» dateFormat

string

false

none

none

» listSubitems

[string]¦null

false

none

none

» subitemMap

object¦null

false

none

none

»» additionalProperties

RESTAPI.v1.DTOs.Composer.DataImport.SubitemDTO

false

none

none

»»» name

[string]¦null

false

none

none

»»» fieldName

[string]¦null

false

none

none

»»» type

string

false

none

none

»»» delimiter

string¦null

false

none

none

»»» segment

integer(int32)

false

none

none

»»» selection

[string]¦null

false

none

none

»»» fieldIndices

[integer]¦null

false

none

none

» addMember

boolean

false

none

none

» updateExistingRows

boolean

false

none

none

» tableType

string

false

none

none

» isLocal

boolean

false

none

none

» localCulture

System.IFormatProvider

false

none

none

» useIncrementalImport

boolean

false

none

none

» culture

string¦null

false

none

none

» tableEffectiveDated

boolean

false

none

none

» isODBCTextDriver

boolean

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

» fileOverwrite

boolean

false

none

none

» importId

integer(int32)

false

none

none

» filename

string¦null

false

none

none

» localPath

string¦null

false

none

none

» username

string¦null

false

none

none

» password

string¦null

false

none

none

» delimiter

string

false

none

none

» sheetName

string¦null

false

none

none

» cellRange

string¦null

false

none

none

» query

string¦null

false

none

none

» queryTimeout

integer(int32)

false

none

none

» connectionString

string¦null

false

none

none

» useAdvanced

boolean

false

none

none

» model

string¦null

false

none

none

» importMethod

integer(int32)

false

none

none

» sourceTableName

string¦null

false

none

none

» securityToken

string¦null

false

none

none

» customColumns

[string]¦null

false

none

none

» userSelected

boolean

false

none

none

» sandbox

boolean

false

none

none

» fileLocation

string¦null

false

none

none

» codePage

integer(int32)

false

none

none

» ignoreFirst

boolean

false

none

none

» ignoreLast

boolean

false

none

none

» recordLength

integer(int32)

false

none

none

» fields

[RESTAPI.v1.DTOs.Composer.DataImport.EBCDICFieldDTO]¦null

false

none

none

»» name

string¦null

false

none

none

»» offset

integer(int32)

false

none

none

»» length

integer(int32)

false

none

none

»» dataType

string

false

none

none

» selectRowNode

string¦null

false

none

none

» pipeConnection

Varicent.RESTAPI.v1.DTOs.Symon.PipeConnectionDTO

false

none

none

»» pipeID

string¦null

false

none

none

»» inputID

string¦null

false

none

none

»» outputID

string¦null

false

none

none

»» outputName

string¦null

false

none

none

»» lastValidated

string(date-time)

false

none

none

»» inputMapping

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

none

»»» source

string¦null

false

none

none

»»» destination

string¦null

false

none

none

»»» type

string

false

none

none

»» outputMapping

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

none

» inputTable

string¦null

false

none

none

» uploadStage

boolean

false

none

none

» predictStage

boolean

false

none

none

» downloadStage

boolean

false

none

none

» symonImportType

string

false

none

none

» refreshAllPipeDatasources

boolean

false

none

none

» connectorID

string¦null

false

none

none

» streamID

string¦null

false

none

none

» importConfig

any

false

none

none

» outputMapping

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

none

» cosLocations

[RESTAPI.v1.DTOs.Symon.CosLocationDTO]¦null

false

none

none

»» bucket

string¦null

false

none

none

»» key

string¦null

false

none

none

» cosCredentials

RESTAPI.v1.DTOs.Composer.DataImport.CosCredentialsDTO

false

none

none

»» endpoint

string¦null

false

none

none

»» accessKey

string¦null

false

none

none

»» secretKey

string¦null

false

none

none

»» sessionToken

string¦null

false

none

none

»» taskAuthToken

string¦null

false

none

none

»» taskAuthEndpoint

string¦null

false

none

none

»» taskAuthExpiration

string¦null

false

none

none

Enumerated Values

Property

Value

importType

None

importType

Text

importType

Excel

importType

DBImport

importType

Salesforce

importType

MSCRM

importType

EBCDICText

importType

TerrAlign

importType

XML

importType

ODBCImport

importType

SymonImport

importType

SymonConnectorImport

importType

Cos

importType

SQLServer

importType

Dynamics

importType

GoogleSheets

importType

MySql

importType

AmazonAurora

importType

AmazonS3

importType

Snowflake

importType

Shopify

importType

Hubspot

importType

Oracle

importType

AmazonRedshift

importType

Workday

dateFormat

Default

dateFormat

DayFirst

dateFormat

MonthFirst

type

Delimited

type

Selection

type

Merged

tableType

System

tableType

Dimension

tableType

Structural

tableType

Lookup

tableType

Data

tableType

View

tableType

Custom

tableType

StarSchema

tableType

ExportTable

tableType

CreditingRule

tableType

AssignTable

tableType

PlcmCustomTable

tableType

PlcmStructuralTable

tableType

PlcmTable

tableType

DataSource

tableType

Cached

tableType

MaterializedView

dataType

String

dataType

Decimal

type

String

type

Number

type

Boolean

type

Date

symonImportType

None

symonImportType

Text

symonImportType

Excel

symonImportType

DBImport

symonImportType

Salesforce

symonImportType

MSCRM

symonImportType

EBCDICText

symonImportType

TerrAlign

symonImportType

XML

symonImportType

ODBCImport

symonImportType

SymonImport

symonImportType

SymonConnectorImport

symonImportType

Cos

symonImportType

SQLServer

symonImportType

Dynamics

symonImportType

GoogleSheets

symonImportType

MySql

symonImportType

AmazonAurora

symonImportType

AmazonS3

symonImportType

Snowflake

symonImportType

Shopify

symonImportType

Hubspot

symonImportType

Oracle

symonImportType

AmazonRedshift

symonImportType

Workday

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/imports", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/imports");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/imports',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/imports', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/imports',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "name": "string",
    "importType": "None",
    "hasHeader": true,
    "table": "string",
    "columnMatchings": {
      "columns": [],
      "matched": []
    },
    "dateFormat": "Default",
    "listSubitems": [
      "string"
    ],
    "subitemMap": {
      "property1": {},
      "property2": {}
    },
    "addMember": true,
    "updateExistingRows": true,
    "tableType": "System",
    "isLocal": true,
    "localCulture": {},
    "useIncrementalImport": true,
    "culture": "string",
    "tableEffectiveDated": true,
    "isODBCTextDriver": true,
    "version": {
      "rowVersion": 0
    },
    "fileOverwrite": true,
    "importId": 0,
    "filename": "string",
    "localPath": "string",
    "username": "string",
    "password": "string",
    "delimiter": "string",
    "sheetName": "string",
    "cellRange": "string",
    "query": "string",
    "queryTimeout": 0,
    "connectionString": "string",
    "useAdvanced": true,
    "model": "string",
    "importMethod": 0,
    "sourceTableName": "string",
    "securityToken": "string",
    "customColumns": [
      "string"
    ],
    "userSelected": true,
    "sandbox": true,
    "fileLocation": "string",
    "codePage": 0,
    "ignoreFirst": true,
    "ignoreLast": true,
    "recordLength": 0,
    "fields": [
      {}
    ],
    "selectRowNode": "string",
    "pipeConnection": {
      "pipeID": "string",
      "inputID": "string",
      "outputID": "string",
      "outputName": "string",
      "lastValidated": "2019-08-24T14:15:22Z",
      "inputMapping": [],
      "outputMapping": []
    },
    "inputTable": "string",
    "uploadStage": true,
    "predictStage": true,
    "downloadStage": true,
    "symonImportType": "None",
    "refreshAllPipeDatasources": true,
    "connectorID": "string",
    "streamID": "string",
    "importConfig": null,
    "outputMapping": [
      {}
    ],
    "cosLocations": [
      {}
    ],
    "cosCredentials": {
      "endpoint": "string",
      "accessKey": "string",
      "secretKey": "string",
      "sessionToken": "string",
      "taskAuthToken": "string",
      "taskAuthEndpoint": "string",
      "taskAuthExpiration": "string"
    }
  }
]
[{"name":"string","importType":"None","hasHeader":true,"table":"string","columnMatchings":{"columns":[],"matched":[]},"dateFormat":"Default","listSubitems":["string"],"subitemMap":{"property1":{},"property2":{}},"addMember":true,"updateExistingRows":true,"tableType":"System","isLocal":true,"localCulture":{},"useIncrementalImport":true,"culture":"string","tableEffectiveDated":true,"isODBCTextDriver":true,"version":{"rowVersion":0},"fileOverwrite":true,"importId":0,"filename":"string","localPath":"string","username":"string","password":"string","delimiter":"string","sheetName":"string","cellRange":"string","query":"string","queryTimeout":0,"connectionString":"string","useAdvanced":true,"model":"string","importMethod":0,"sourceTableName":"string","securityToken":"string","customColumns":["string"],"userSelected":true,"sandbox":true,"fileLocation":"string","codePage":0,"ignoreFirst":true,"ignoreLast":true,"recordLength":0,"fields":[{}],"selectRowNode":"string","pipeConnection":{"pipeID":"string","inputID":"string","outputID":"string","outputName":"string","lastValidated":"2019-08-24T14:15:22Z","inputMapping":[],"outputMapping":[]},"inputTable":"string","uploadStage":true,"predictStage":true,"downloadStage":true,"symonImportType":"None","refreshAllPipeDatasources":true,"connectorID":"string","streamID":"string","importConfig":null,"outputMapping":[{}],"cosLocations":[{}],"cosCredentials":{"endpoint":"string","accessKey":"string","secretKey":"string","sessionToken":"string","taskAuthToken":"string","taskAuthEndpoint":"string","taskAuthExpiration":"string"}}]

Insert an import.

Body parameter

{
  "name": "string",
  "importType": "None",
  "hasHeader": true,
  "table": "string",
  "columnMatchings": {
    "columns": [
      "string"
    ],
    "matched": [
      "string"
    ]
  },
  "dateFormat": "Default",
  "listSubitems": [
    "string"
  ],
  "subitemMap": {
    "property1": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    },
    "property2": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    }
  },
  "addMember": true,
  "updateExistingRows": true,
  "tableType": "System",
  "isLocal": true,
  "localCulture": {},
  "useIncrementalImport": true,
  "culture": "string",
  "tableEffectiveDated": true,
  "isODBCTextDriver": true,
  "version": {
    "rowVersion": 0
  },
  "fileOverwrite": true,
  "importId": 0,
  "filename": "string",
  "localPath": "string",
  "username": "string",
  "password": "string",
  "delimiter": "string",
  "sheetName": "string",
  "cellRange": "string",
  "query": "string",
  "queryTimeout": 0,
  "connectionString": "string",
  "useAdvanced": true,
  "model": "string",
  "importMethod": 0,
  "sourceTableName": "string",
  "securityToken": "string",
  "customColumns": [
    "string"
  ],
  "userSelected": true,
  "sandbox": true,
  "fileLocation": "string",
  "codePage": 0,
  "ignoreFirst": true,
  "ignoreLast": true,
  "recordLength": 0,
  "fields": [
    {
      "name": "string",
      "offset": 0,
      "length": 0,
      "dataType": "String"
    }
  ],
  "selectRowNode": "string",
  "pipeConnection": {
    "pipeID": "string",
    "inputID": "string",
    "outputID": "string",
    "outputName": "string",
    "lastValidated": "2019-08-24T14:15:22Z",
    "inputMapping": [
      {}
    ],
    "outputMapping": [
      {}
    ]
  },
  "inputTable": "string",
  "uploadStage": true,
  "predictStage": true,
  "downloadStage": true,
  "symonImportType": "None",
  "refreshAllPipeDatasources": true,
  "connectorID": "string",
  "streamID": "string",
  "importConfig": null,
  "outputMapping": [
    {
      "source": "string",
      "destination": "string",
      "type": "String"
    }
  ]
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v2.DTOs.Composer.DataImport.ImportParamsDTO

false

none

» name

body

string¦null

false

none

» importType

body

string

false

none

» hasHeader

body

boolean

false

none

» table

body

string¦null

false

none

» columnMatchings

body

RESTAPI.v1.DTOs.ColumnMatchingsDTO

false

none

»» columns

body

[string]¦null

false

none

»» matched

body

[string]¦null

false

none

» dateFormat

body

string

false

none

» listSubitems

body

[string]¦null

false

none

» subitemMap

body

object¦null

false

none

»» additionalProperties

body

RESTAPI.v1.DTOs.Composer.DataImport.SubitemDTO

false

none

»»» name

body

[string]¦null

false

none

»»» fieldName

body

[string]¦null

false

none

»»» type

body

string

false

none

»»» delimiter

body

string¦null

false

none

»»» segment

body

integer(int32)

false

none

»»» selection

body

[string]¦null

false

none

»»» fieldIndices

body

[integer]¦null

false

none

» addMember

body

boolean

false

none

» updateExistingRows

body

boolean

false

none

» tableType

body

string

false

none

» isLocal

body

boolean

false

none

» localCulture

body

System.IFormatProvider

false

none

» useIncrementalImport

body

boolean

false

none

» culture

body

string¦null

false

none

» tableEffectiveDated

body

boolean

false

none

» isODBCTextDriver

body

boolean

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

» fileOverwrite

body

boolean

false

none

» importId

body

integer(int32)

false

none

» filename

body

string¦null

false

none

» localPath

body

string¦null

false

none

» username

body

string¦null

false

none

» password

body

string¦null

false

none

» delimiter

body

string

false

none

» sheetName

body

string¦null

false

none

» cellRange

body

string¦null

false

none

» query

body

string¦null

false

none

» queryTimeout

body

integer(int32)

false

none

» connectionString

body

string¦null

false

none

» useAdvanced

body

boolean

false

none

» model

body

string¦null

false

none

» importMethod

body

integer(int32)

false

none

» sourceTableName

body

string¦null

false

none

» securityToken

body

string¦null

false

none

» customColumns

body

[string]¦null

false

none

» userSelected

body

boolean

false

none

» sandbox

body

boolean

false

none

» fileLocation

body

string¦null

false

none

» codePage

body

integer(int32)

false

none

» ignoreFirst

body

boolean

false

none

» ignoreLast

body

boolean

false

none

» recordLength

body

integer(int32)

false

none

» fields

body

[RESTAPI.v1.DTOs.Composer.DataImport.EBCDICFieldDTO]¦null

false

none

»» name

body

string¦null

false

none

»» offset

body

integer(int32)

false

none

»» length

body

integer(int32)

false

none

»» dataType

body

string

false

none

» selectRowNode

body

string¦null

false

none

» pipeConnection

body

Varicent.RESTAPI.v1.DTOs.Symon.PipeConnectionDTO

false

none

»» pipeID

body

string¦null

false

none

»» inputID

body

string¦null

false

none

»» outputID

body

string¦null

false

none

»» outputName

body

string¦null

false

none

»» lastValidated

body

string(date-time)

false

none

»» inputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»»» source

body

string¦null

false

none

»»» destination

body

string¦null

false

none

»»» type

body

string

false

none

»» outputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

» inputTable

body

string¦null

false

none

» uploadStage

body

boolean

false

none

» predictStage

body

boolean

false

none

» downloadStage

body

boolean

false

none

» symonImportType

body

string

false

none

» refreshAllPipeDatasources

body

boolean

false

none

» connectorID

body

string¦null

false

none

» streamID

body

string¦null

false

none

» importConfig

body

any

false

none

» outputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

Enumerated Values

Parameter

Value

» importType

None

» importType

Text

» importType

Excel

» importType

DBImport

» importType

Salesforce

» importType

MSCRM

» importType

EBCDICText

» importType

TerrAlign

» importType

XML

» importType

ODBCImport

» importType

SymonImport

» importType

SymonConnectorImport

» importType

Cos

» importType

SQLServer

» importType

Dynamics

» importType

GoogleSheets

» importType

MySql

» importType

AmazonAurora

» importType

AmazonS3

» importType

Snowflake

» importType

Shopify

» importType

Hubspot

» importType

Oracle

» importType

AmazonRedshift

» importType

Workday

» dateFormat

Default

» dateFormat

DayFirst

» dateFormat

MonthFirst

»»» type

Delimited

»»» type

Selection

»»» type

Merged

» tableType

System

» tableType

Dimension

» tableType

Structural

» tableType

Lookup

» tableType

Data

» tableType

View

» tableType

Custom

» tableType

StarSchema

» tableType

ExportTable

» tableType

CreditingRule

» tableType

AssignTable

» tableType

PlcmCustomTable

» tableType

PlcmStructuralTable

» tableType

PlcmTable

» tableType

DataSource

» tableType

Cached

» tableType

MaterializedView

»» dataType

String

»» dataType

Decimal

»»» type

String

»»» type

Number

»»» type

Boolean

»»» type

Date

» symonImportType

None

» symonImportType

Text

» symonImportType

Excel

» symonImportType

DBImport

» symonImportType

Salesforce

» symonImportType

MSCRM

» symonImportType

EBCDICText

» symonImportType

TerrAlign

» symonImportType

XML

» symonImportType

ODBCImport

» symonImportType

SymonImport

» symonImportType

SymonConnectorImport

» symonImportType

Cos

» symonImportType

SQLServer

» symonImportType

Dynamics

» symonImportType

GoogleSheets

» symonImportType

MySql

» symonImportType

AmazonAurora

» symonImportType

AmazonS3

» symonImportType

Snowflake

» symonImportType

Shopify

» symonImportType

Hubspot

» symonImportType

Oracle

» symonImportType

AmazonRedshift

» symonImportType

Workday

Responses

Status

Meaning

Description

Schema

201

Created

Insert an import

RESTAPI.v2.DTOs.Composer.DataImport.ImportParamsDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v2/imports", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v2/imports");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "name": "string",
  "importType": "None",
  "hasHeader": true,
  "table": "string",
  "columnMatchings": {
    "columns": [
      "string"
    ],
    "matched": [
      "string"
    ]
  },
  "dateFormat": "Default",
  "listSubitems": [
    "string"
  ],
  "subitemMap": {
    "property1": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    },
    "property2": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    }
  },
  "addMember": true,
  "updateExistingRows": true,
  "tableType": "System",
  "isLocal": true,
  "localCulture": {},
  "useIncrementalImport": true,
  "culture": "string",
  "tableEffectiveDated": true,
  "isODBCTextDriver": true,
  "version": {
    "rowVersion": 0
  },
  "fileOverwrite": true,
  "importId": 0,
  "filename": "string",
  "localPath": "string",
  "username": "string",
  "password": "string",
  "delimiter": "string",
  "sheetName": "string",
  "cellRange": "string",
  "query": "string",
  "queryTimeout": 0,
  "connectionString": "string",
  "useAdvanced": true,
  "model": "string",
  "importMethod": 0,
  "sourceTableName": "string",
  "securityToken": "string",
  "customColumns": [
    "string"
  ],
  "userSelected": true,
  "sandbox": true,
  "fileLocation": "string",
  "codePage": 0,
  "ignoreFirst": true,
  "ignoreLast": true,
  "recordLength": 0,
  "fields": [
    {
      "name": "string",
      "offset": 0,
      "length": 0,
      "dataType": "String"
    }
  ],
  "selectRowNode": "string",
  "pipeConnection": {
    "pipeID": "string",
    "inputID": "string",
    "outputID": "string",
    "outputName": "string",
    "lastValidated": "2019-08-24T14:15:22Z",
    "inputMapping": [
      {}
    ],
    "outputMapping": [
      {}
    ]
  },
  "inputTable": "string",
  "uploadStage": true,
  "predictStage": true,
  "downloadStage": true,
  "symonImportType": "None",
  "refreshAllPipeDatasources": true,
  "connectorID": "string",
  "streamID": "string",
  "importConfig": null,
  "outputMapping": [
    {
      "source": "string",
      "destination": "string",
      "type": "String"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v2/imports',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v2/imports', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v2/imports',
  params: {
  }, headers: headers

p JSON.parse(result)

Get an import with a given ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get import with given name.

RESTAPI.v1.DTOs.Composer.DataImport.ImportParamsDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/imports/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/imports/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/imports/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/imports/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/imports/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "name": "string",
  "importType": "None",
  "hasHeader": true,
  "table": "string",
  "columnMatchings": {
    "columns": [
      "string"
    ],
    "matched": [
      "string"
    ]
  },
  "dateFormat": "Default",
  "listSubitems": [
    "string"
  ],
  "subitemMap": {
    "property1": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    },
    "property2": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    }
  },
  "addMember": true,
  "updateExistingRows": true,
  "tableType": "System",
  "isLocal": true,
  "localCulture": {},
  "useIncrementalImport": true,
  "culture": "string",
  "tableEffectiveDated": true,
  "isODBCTextDriver": true,
  "version": {
    "rowVersion": 0
  },
  "fileOverwrite": true,
  "importId": 0,
  "filename": "string",
  "localPath": "string",
  "username": "string",
  "password": "string",
  "delimiter": "string",
  "sheetName": "string",
  "cellRange": "string",
  "query": "string",
  "queryTimeout": 0,
  "connectionString": "string",
  "useAdvanced": true,
  "model": "string",
  "importMethod": 0,
  "sourceTableName": "string",
  "securityToken": "string",
  "customColumns": [
    "string"
  ],
  "userSelected": true,
  "sandbox": true,
  "fileLocation": "string",
  "codePage": 0,
  "ignoreFirst": true,
  "ignoreLast": true,
  "recordLength": 0,
  "fields": [
    {
      "name": "string",
      "offset": 0,
      "length": 0,
      "dataType": "String"
    }
  ],
  "selectRowNode": "string",
  "pipeConnection": {
    "pipeID": "string",
    "inputID": "string",
    "outputID": "string",
    "outputName": "string",
    "lastValidated": "2019-08-24T14:15:22Z",
    "inputMapping": [
      {}
    ],
    "outputMapping": [
      {}
    ]
  },
  "inputTable": "string",
  "uploadStage": true,
  "predictStage": true,
  "downloadStage": true,
  "symonImportType": "None",
  "refreshAllPipeDatasources": true,
  "connectorID": "string",
  "streamID": "string",
  "importConfig": null,
  "outputMapping": [
    {
      "source": "string",
      "destination": "string",
      "type": "String"
    }
  ],
  "cosLocations": [
    {
      "bucket": "string",
      "key": "string"
    }
  ],
  "cosCredentials": {
    "endpoint": "string",
    "accessKey": "string",
    "secretKey": "string",
    "sessionToken": "string",
    "taskAuthToken": "string",
    "taskAuthEndpoint": "string",
    "taskAuthExpiration": "string"
  }
}
{"name":"string","importType":"None","hasHeader":true,"table":"string","columnMatchings":{"columns":["string"],"matched":["string"]},"dateFormat":"Default","listSubitems":["string"],"subitemMap":{"property1":{"name":[],"fieldName":[],"type":"Delimited","delimiter":"string","segment":0,"selection":[],"fieldIndices":[]},"property2":{"name":[],"fieldName":[],"type":"Delimited","delimiter":"string","segment":0,"selection":[],"fieldIndices":[]}},"addMember":true,"updateExistingRows":true,"tableType":"System","isLocal":true,"localCulture":{},"useIncrementalImport":true,"culture":"string","tableEffectiveDated":true,"isODBCTextDriver":true,"version":{"rowVersion":0},"fileOverwrite":true,"importId":0,"filename":"string","localPath":"string","username":"string","password":"string","delimiter":"string","sheetName":"string","cellRange":"string","query":"string","queryTimeout":0,"connectionString":"string","useAdvanced":true,"model":"string","importMethod":0,"sourceTableName":"string","securityToken":"string","customColumns":["string"],"userSelected":true,"sandbox":true,"fileLocation":"string","codePage":0,"ignoreFirst":true,"ignoreLast":true,"recordLength":0,"fields":[{"name":"string","offset":0,"length":0,"dataType":"String"}],"selectRowNode":"string","pipeConnection":{"pipeID":"string","inputID":"string","outputID":"string","outputName":"string","lastValidated":"2019-08-24T14:15:22Z","inputMapping":[{}],"outputMapping":[{}]},"inputTable":"string","uploadStage":true,"predictStage":true,"downloadStage":true,"symonImportType":"None","refreshAllPipeDatasources":true,"connectorID":"string","streamID":"string","importConfig":null,"outputMapping":[{"source":"string","destination":"string","type":"String"}],"cosLocations":[{"bucket":"string","key":"string"}],"cosCredentials":{"endpoint":"string","accessKey":"string","secretKey":"string","sessionToken":"string","taskAuthToken":"string","taskAuthEndpoint":"string","taskAuthExpiration":"string"}}

Update an import by ID.

Body parameter

{
  "name": "string",
  "importType": "None",
  "hasHeader": true,
  "table": "string",
  "columnMatchings": {
    "columns": [
      "string"
    ],
    "matched": [
      "string"
    ]
  },
  "dateFormat": "Default",
  "listSubitems": [
    "string"
  ],
  "subitemMap": {
    "property1": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    },
    "property2": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    }
  },
  "addMember": true,
  "updateExistingRows": true,
  "tableType": "System",
  "isLocal": true,
  "localCulture": {},
  "useIncrementalImport": true,
  "culture": "string",
  "tableEffectiveDated": true,
  "isODBCTextDriver": true,
  "version": {
    "rowVersion": 0
  },
  "fileOverwrite": true,
  "importId": 0,
  "filename": "string",
  "localPath": "string",
  "username": "string",
  "password": "string",
  "delimiter": "string",
  "sheetName": "string",
  "cellRange": "string",
  "query": "string",
  "queryTimeout": 0,
  "connectionString": "string",
  "useAdvanced": true,
  "model": "string",
  "importMethod": 0,
  "sourceTableName": "string",
  "securityToken": "string",
  "customColumns": [
    "string"
  ],
  "userSelected": true,
  "sandbox": true,
  "fileLocation": "string",
  "codePage": 0,
  "ignoreFirst": true,
  "ignoreLast": true,
  "recordLength": 0,
  "fields": [
    {
      "name": "string",
      "offset": 0,
      "length": 0,
      "dataType": "String"
    }
  ],
  "selectRowNode": "string",
  "pipeConnection": {
    "pipeID": "string",
    "inputID": "string",
    "outputID": "string",
    "outputName": "string",
    "lastValidated": "2019-08-24T14:15:22Z",
    "inputMapping": [
      {}
    ],
    "outputMapping": [
      {}
    ]
  },
  "inputTable": "string",
  "uploadStage": true,
  "predictStage": true,
  "downloadStage": true,
  "symonImportType": "None",
  "refreshAllPipeDatasources": true,
  "connectorID": "string",
  "streamID": "string",
  "importConfig": null,
  "outputMapping": [
    {
      "source": "string",
      "destination": "string",
      "type": "String"
    }
  ],
  "cosLocations": [
    {
      "bucket": "string",
      "key": "string"
    }
  ],
  "cosCredentials": {
    "endpoint": "string",
    "accessKey": "string",
    "secretKey": "string",
    "sessionToken": "string",
    "taskAuthToken": "string",
    "taskAuthEndpoint": "string",
    "taskAuthExpiration": "string"
  }
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

RESTAPI.v1.DTOs.Composer.DataImport.ImportParamsDTO

false

none

» name

body

string¦null

false

none

» importType

body

string

false

none

» hasHeader

body

boolean

false

none

» table

body

string¦null

false

none

» columnMatchings

body

RESTAPI.v1.DTOs.ColumnMatchingsDTO

false

none

»» columns

body

[string]¦null

false

none

»» matched

body

[string]¦null

false

none

» dateFormat

body

string

false

none

» listSubitems

body

[string]¦null

false

none

» subitemMap

body

object¦null

false

none

»» additionalProperties

body

RESTAPI.v1.DTOs.Composer.DataImport.SubitemDTO

false

none

»»» name

body

[string]¦null

false

none

»»» fieldName

body

[string]¦null

false

none

»»» type

body

string

false

none

»»» delimiter

body

string¦null

false

none

»»» segment

body

integer(int32)

false

none

»»» selection

body

[string]¦null

false

none

»»» fieldIndices

body

[integer]¦null

false

none

» addMember

body

boolean

false

none

» updateExistingRows

body

boolean

false

none

» tableType

body

string

false

none

» isLocal

body

boolean

false

none

» localCulture

body

System.IFormatProvider

false

none

» useIncrementalImport

body

boolean

false

none

» culture

body

string¦null

false

none

» tableEffectiveDated

body

boolean

false

none

» isODBCTextDriver

body

boolean

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

» fileOverwrite

body

boolean

false

none

» importId

body

integer(int32)

false

none

» filename

body

string¦null

false

none

» localPath

body

string¦null

false

none

» username

body

string¦null

false

none

» password

body

string¦null

false

none

» delimiter

body

string

false

none

» sheetName

body

string¦null

false

none

» cellRange

body

string¦null

false

none

» query

body

string¦null

false

none

» queryTimeout

body

integer(int32)

false

none

» connectionString

body

string¦null

false

none

» useAdvanced

body

boolean

false

none

» model

body

string¦null

false

none

» importMethod

body

integer(int32)

false

none

» sourceTableName

body

string¦null

false

none

» securityToken

body

string¦null

false

none

» customColumns

body

[string]¦null

false

none

» userSelected

body

boolean

false

none

» sandbox

body

boolean

false

none

» fileLocation

body

string¦null

false

none

» codePage

body

integer(int32)

false

none

» ignoreFirst

body

boolean

false

none

» ignoreLast

body

boolean

false

none

» recordLength

body

integer(int32)

false

none

» fields

body

[RESTAPI.v1.DTOs.Composer.DataImport.EBCDICFieldDTO]¦null

false

none

»» name

body

string¦null

false

none

»» offset

body

integer(int32)

false

none

»» length

body

integer(int32)

false

none

»» dataType

body

string

false

none

» selectRowNode

body

string¦null

false

none

» pipeConnection

body

Varicent.RESTAPI.v1.DTOs.Symon.PipeConnectionDTO

false

none

»» pipeID

body

string¦null

false

none

»» inputID

body

string¦null

false

none

»» outputID

body

string¦null

false

none

»» outputName

body

string¦null

false

none

»» lastValidated

body

string(date-time)

false

none

»» inputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»»» source

body

string¦null

false

none

»»» destination

body

string¦null

false

none

»»» type

body

string

false

none

»» outputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

» inputTable

body

string¦null

false

none

» uploadStage

body

boolean

false

none

» predictStage

body

boolean

false

none

» downloadStage

body

boolean

false

none

» symonImportType

body

string

false

none

» refreshAllPipeDatasources

body

boolean

false

none

» connectorID

body

string¦null

false

none

» streamID

body

string¦null

false

none

» importConfig

body

any

false

none

» outputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

» cosLocations

body

[RESTAPI.v1.DTOs.Symon.CosLocationDTO]¦null

false

none

»» bucket

body

string¦null

false

none

»» key

body

string¦null

false

none

» cosCredentials

body

RESTAPI.v1.DTOs.Composer.DataImport.CosCredentialsDTO

false

none

»» endpoint

body

string¦null

false

none

»» accessKey

body

string¦null

false

none

»» secretKey

body

string¦null

false

none

»» sessionToken

body

string¦null

false

none

»» taskAuthToken

body

string¦null

false

none

»» taskAuthEndpoint

body

string¦null

false

none

»» taskAuthExpiration

body

string¦null

false

none

Enumerated Values

Parameter

Value

» importType

None

» importType

Text

» importType

Excel

» importType

DBImport

» importType

Salesforce

» importType

MSCRM

» importType

EBCDICText

» importType

TerrAlign

» importType

XML

» importType

ODBCImport

» importType

SymonImport

» importType

SymonConnectorImport

» importType

Cos

» importType

SQLServer

» importType

Dynamics

» importType

GoogleSheets

» importType

MySql

» importType

AmazonAurora

» importType

AmazonS3

» importType

Snowflake

» importType

Shopify

» importType

Hubspot

» importType

Oracle

» importType

AmazonRedshift

» importType

Workday

» dateFormat

Default

» dateFormat

DayFirst

» dateFormat

MonthFirst

»»» type

Delimited

»»» type

Selection

»»» type

Merged

» tableType

System

» tableType

Dimension

» tableType

Structural

» tableType

Lookup

» tableType

Data

» tableType

View

» tableType

Custom

» tableType

StarSchema

» tableType

ExportTable

» tableType

CreditingRule

» tableType

AssignTable

» tableType

PlcmCustomTable

» tableType

PlcmStructuralTable

» tableType

PlcmTable

» tableType

DataSource

» tableType

Cached

» tableType

MaterializedView

»» dataType

String

»» dataType

Decimal

»»» type

String

»»» type

Number

»»» type

Boolean

»»» type

Date

» symonImportType

None

» symonImportType

Text

» symonImportType

Excel

» symonImportType

DBImport

» symonImportType

Salesforce

» symonImportType

MSCRM

» symonImportType

EBCDICText

» symonImportType

TerrAlign

» symonImportType

XML

» symonImportType

ODBCImport

» symonImportType

SymonImport

» symonImportType

SymonConnectorImport

» symonImportType

Cos

» symonImportType

SQLServer

» symonImportType

Dynamics

» symonImportType

GoogleSheets

» symonImportType

MySql

» symonImportType

AmazonAurora

» symonImportType

AmazonS3

» symonImportType

Snowflake

» symonImportType

Shopify

» symonImportType

Hubspot

» symonImportType

Oracle

» symonImportType

AmazonRedshift

» symonImportType

Workday

Responses

Status

Meaning

Description

Schema

200

OK

Update import

RESTAPI.v1.DTOs.Composer.DataImport.ImportParamsDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/imports/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/imports/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "name": "string",
  "importType": "None",
  "hasHeader": true,
  "table": "string",
  "columnMatchings": {
    "columns": [
      "string"
    ],
    "matched": [
      "string"
    ]
  },
  "dateFormat": "Default",
  "listSubitems": [
    "string"
  ],
  "subitemMap": {
    "property1": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    },
    "property2": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    }
  },
  "addMember": true,
  "updateExistingRows": true,
  "tableType": "System",
  "isLocal": true,
  "localCulture": {},
  "useIncrementalImport": true,
  "culture": "string",
  "tableEffectiveDated": true,
  "isODBCTextDriver": true,
  "version": {
    "rowVersion": 0
  },
  "fileOverwrite": true,
  "importId": 0,
  "filename": "string",
  "localPath": "string",
  "username": "string",
  "password": "string",
  "delimiter": "string",
  "sheetName": "string",
  "cellRange": "string",
  "query": "string",
  "queryTimeout": 0,
  "connectionString": "string",
  "useAdvanced": true,
  "model": "string",
  "importMethod": 0,
  "sourceTableName": "string",
  "securityToken": "string",
  "customColumns": [
    "string"
  ],
  "userSelected": true,
  "sandbox": true,
  "fileLocation": "string",
  "codePage": 0,
  "ignoreFirst": true,
  "ignoreLast": true,
  "recordLength": 0,
  "fields": [
    {
      "name": "string",
      "offset": 0,
      "length": 0,
      "dataType": "String"
    }
  ],
  "selectRowNode": "string",
  "pipeConnection": {
    "pipeID": "string",
    "inputID": "string",
    "outputID": "string",
    "outputName": "string",
    "lastValidated": "2019-08-24T14:15:22Z",
    "inputMapping": [
      {}
    ],
    "outputMapping": [
      {}
    ]
  },
  "inputTable": "string",
  "uploadStage": true,
  "predictStage": true,
  "downloadStage": true,
  "symonImportType": "None",
  "refreshAllPipeDatasources": true,
  "connectorID": "string",
  "streamID": "string",
  "importConfig": null,
  "outputMapping": [
    {
      "source": "string",
      "destination": "string",
      "type": "String"
    }
  ],
  "cosLocations": [
    {
      "bucket": "string",
      "key": "string"
    }
  ],
  "cosCredentials": {
    "endpoint": "string",
    "accessKey": "string",
    "secretKey": "string",
    "sessionToken": "string",
    "taskAuthToken": "string",
    "taskAuthEndpoint": "string",
    "taskAuthExpiration": "string"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/imports/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/imports/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/imports/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

Delete an import with a given ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Delete import with given id.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/imports/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/imports/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/imports/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/imports/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/imports/{id}',
  params: {
  }

p JSON.parse(result)

Gets the preview information from a remote file.

Body parameter

{
  "importParams": {
    "name": "string",
    "importType": "None",
    "hasHeader": true,
    "table": "string",
    "columnMatchings": {
      "columns": [],
      "matched": []
    },
    "dateFormat": "Default",
    "listSubitems": [
      "string"
    ],
    "subitemMap": {
      "property1": {},
      "property2": {}
    },
    "addMember": true,
    "updateExistingRows": true,
    "tableType": "System",
    "isLocal": true,
    "localCulture": {},
    "useIncrementalImport": true,
    "culture": "string",
    "tableEffectiveDated": true,
    "isODBCTextDriver": true,
    "version": {
      "rowVersion": 0
    },
    "fileOverwrite": true,
    "importId": 0,
    "filename": "string",
    "localPath": "string",
    "username": "string",
    "password": "string",
    "delimiter": "string",
    "sheetName": "string",
    "cellRange": "string",
    "query": "string",
    "queryTimeout": 0,
    "connectionString": "string",
    "useAdvanced": true,
    "model": "string",
    "importMethod": 0,
    "sourceTableName": "string",
    "securityToken": "string",
    "customColumns": [
      "string"
    ],
    "userSelected": true,
    "sandbox": true,
    "fileLocation": "string",
    "codePage": 0,
    "ignoreFirst": true,
    "ignoreLast": true,
    "recordLength": 0,
    "fields": [
      {}
    ],
    "selectRowNode": "string",
    "pipeConnection": {
      "pipeID": "string",
      "inputID": "string",
      "outputID": "string",
      "outputName": "string",
      "lastValidated": "2019-08-24T14:15:22Z",
      "inputMapping": [],
      "outputMapping": []
    },
    "inputTable": "string",
    "uploadStage": true,
    "predictStage": true,
    "downloadStage": true,
    "symonImportType": "None",
    "refreshAllPipeDatasources": true,
    "connectorID": "string",
    "streamID": "string",
    "importConfig": null,
    "outputMapping": [
      {}
    ],
    "cosLocations": [
      {}
    ],
    "cosCredentials": {
      "endpoint": "string",
      "accessKey": "string",
      "secretKey": "string",
      "sessionToken": "string",
      "taskAuthToken": "string",
      "taskAuthEndpoint": "string",
      "taskAuthExpiration": "string"
    }
  },
  "numLines": 0
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

RESTAPI.v1.DTOs.Composer.DataImport.ImportPreviewDTO

false

none

» importParams

body

RESTAPI.v1.DTOs.Composer.DataImport.ImportParamsDTO

false

none

»» name

body

string¦null

false

none

»» importType

body

string

false

none

»» hasHeader

body

boolean

false

none

»» table

body

string¦null

false

none

»» columnMatchings

body

RESTAPI.v1.DTOs.ColumnMatchingsDTO

false

none

»»» columns

body

[string]¦null

false

none

»»» matched

body

[string]¦null

false

none

»» dateFormat

body

string

false

none

»» listSubitems

body

[string]¦null

false

none

»» subitemMap

body

object¦null

false

none

»»» additionalProperties

body

RESTAPI.v1.DTOs.Composer.DataImport.SubitemDTO

false

none

»»»» name

body

[string]¦null

false

none

»»»» fieldName

body

[string]¦null

false

none

»»»» type

body

string

false

none

»»»» delimiter

body

string¦null

false

none

»»»» segment

body

integer(int32)

false

none

»»»» selection

body

[string]¦null

false

none

»»»» fieldIndices

body

[integer]¦null

false

none

»» addMember

body

boolean

false

none

»» updateExistingRows

body

boolean

false

none

»» tableType

body

string

false

none

»» isLocal

body

boolean

false

none

»» localCulture

body

System.IFormatProvider

false

none

»» useIncrementalImport

body

boolean

false

none

»» culture

body

string¦null

false

none

»» tableEffectiveDated

body

boolean

false

none

»» isODBCTextDriver

body

boolean

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» rowVersion

body

integer(int64)

false

none

»» fileOverwrite

body

boolean

false

none

»» importId

body

integer(int32)

false

none

»» filename

body

string¦null

false

none

»» localPath

body

string¦null

false

none

»» username

body

string¦null

false

none

»» password

body

string¦null

false

none

»» delimiter

body

string

false

none

»» sheetName

body

string¦null

false

none

»» cellRange

body

string¦null

false

none

»» query

body

string¦null

false

none

»» queryTimeout

body

integer(int32)

false

none

»» connectionString

body

string¦null

false

none

»» useAdvanced

body

boolean

false

none

»» model

body

string¦null

false

none

»» importMethod

body

integer(int32)

false

none

»» sourceTableName

body

string¦null

false

none

»» securityToken

body

string¦null

false

none

»» customColumns

body

[string]¦null

false

none

»» userSelected

body

boolean

false

none

»» sandbox

body

boolean

false

none

»» fileLocation

body

string¦null

false

none

»» codePage

body

integer(int32)

false

none

»» ignoreFirst

body

boolean

false

none

»» ignoreLast

body

boolean

false

none

»» recordLength

body

integer(int32)

false

none

»» fields

body

[RESTAPI.v1.DTOs.Composer.DataImport.EBCDICFieldDTO]¦null

false

none

»»» name

body

string¦null

false

none

»»» offset

body

integer(int32)

false

none

»»» length

body

integer(int32)

false

none

»»» dataType

body

string

false

none

»» selectRowNode

body

string¦null

false

none

»» pipeConnection

body

Varicent.RESTAPI.v1.DTOs.Symon.PipeConnectionDTO

false

none

»»» pipeID

body

string¦null

false

none

»»» inputID

body

string¦null

false

none

»»» outputID

body

string¦null

false

none

»»» outputName

body

string¦null

false

none

»»» lastValidated

body

string(date-time)

false

none

»»» inputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»»»» source

body

string¦null

false

none

»»»» destination

body

string¦null

false

none

»»»» type

body

string

false

none

»»» outputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»» inputTable

body

string¦null

false

none

»» uploadStage

body

boolean

false

none

»» predictStage

body

boolean

false

none

»» downloadStage

body

boolean

false

none

»» symonImportType

body

string

false

none

»» refreshAllPipeDatasources

body

boolean

false

none

»» connectorID

body

string¦null

false

none

»» streamID

body

string¦null

false

none

»» importConfig

body

any

false

none

»» outputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»» cosLocations

body

[RESTAPI.v1.DTOs.Symon.CosLocationDTO]¦null

false

none

»»» bucket

body

string¦null

false

none

»»» key

body

string¦null

false

none

»» cosCredentials

body

RESTAPI.v1.DTOs.Composer.DataImport.CosCredentialsDTO

false

none

»»» endpoint

body

string¦null

false

none

»»» accessKey

body

string¦null

false

none

»»» secretKey

body

string¦null

false

none

»»» sessionToken

body

string¦null

false

none

»»» taskAuthToken

body

string¦null

false

none

»»» taskAuthEndpoint

body

string¦null

false

none

»»» taskAuthExpiration

body

string¦null

false

none

» numLines

body

integer(int32)

false

none

Enumerated Values

Parameter

Value

»» importType

None

»» importType

Text

»» importType

Excel

»» importType

DBImport

»» importType

Salesforce

»» importType

MSCRM

»» importType

EBCDICText

»» importType

TerrAlign

»» importType

XML

»» importType

ODBCImport

»» importType

SymonImport

»» importType

SymonConnectorImport

»» importType

Cos

»» importType

SQLServer

»» importType

Dynamics

»» importType

GoogleSheets

»» importType

MySql

»» importType

AmazonAurora

»» importType

AmazonS3

»» importType

Snowflake

»» importType

Shopify

»» importType

Hubspot

»» importType

Oracle

»» importType

AmazonRedshift

»» importType

Workday

»» dateFormat

Default

»» dateFormat

DayFirst

»» dateFormat

MonthFirst

»»»» type

Delimited

»»»» type

Selection

»»»» type

Merged

»» tableType

System

»» tableType

Dimension

»» tableType

Structural

»» tableType

Lookup

»» tableType

Data

»» tableType

View

»» tableType

Custom

»» tableType

StarSchema

»» tableType

ExportTable

»» tableType

CreditingRule

»» tableType

AssignTable

»» tableType

PlcmCustomTable

»» tableType

PlcmStructuralTable

»» tableType

PlcmTable

»» tableType

DataSource

»» tableType

Cached

»» tableType

MaterializedView

»»» dataType

String

»»» dataType

Decimal

»»»» type

String

»»»» type

Number

»»»» type

Boolean

»»»» type

Date

»» symonImportType

None

»» symonImportType

Text

»» symonImportType

Excel

»» symonImportType

DBImport

»» symonImportType

Salesforce

»» symonImportType

MSCRM

»» symonImportType

EBCDICText

»» symonImportType

TerrAlign

»» symonImportType

XML

»» symonImportType

ODBCImport

»» symonImportType

SymonImport

»» symonImportType

SymonConnectorImport

»» symonImportType

Cos

»» symonImportType

SQLServer

»» symonImportType

Dynamics

»» symonImportType

GoogleSheets

»» symonImportType

MySql

»» symonImportType

AmazonAurora

»» symonImportType

AmazonS3

»» symonImportType

Snowflake

»» symonImportType

Shopify

»» symonImportType

Hubspot

»» symonImportType

Oracle

»» symonImportType

AmazonRedshift

»» symonImportType

Workday

Responses

Status

Meaning

Description

Schema

200

OK

Get full table schema given table name.

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/imports/{id}/preview", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/imports/{id}/preview");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "importParams": {
    "name": "string",
    "importType": "None",
    "hasHeader": true,
    "table": "string",
    "columnMatchings": {
      "columns": [],
      "matched": []
    },
    "dateFormat": "Default",
    "listSubitems": [
      "string"
    ],
    "subitemMap": {
      "property1": {},
      "property2": {}
    },
    "addMember": true,
    "updateExistingRows": true,
    "tableType": "System",
    "isLocal": true,
    "localCulture": {},
    "useIncrementalImport": true,
    "culture": "string",
    "tableEffectiveDated": true,
    "isODBCTextDriver": true,
    "version": {
      "rowVersion": 0
    },
    "fileOverwrite": true,
    "importId": 0,
    "filename": "string",
    "localPath": "string",
    "username": "string",
    "password": "string",
    "delimiter": "string",
    "sheetName": "string",
    "cellRange": "string",
    "query": "string",
    "queryTimeout": 0,
    "connectionString": "string",
    "useAdvanced": true,
    "model": "string",
    "importMethod": 0,
    "sourceTableName": "string",
    "securityToken": "string",
    "customColumns": [
      "string"
    ],
    "userSelected": true,
    "sandbox": true,
    "fileLocation": "string",
    "codePage": 0,
    "ignoreFirst": true,
    "ignoreLast": true,
    "recordLength": 0,
    "fields": [
      {}
    ],
    "selectRowNode": "string",
    "pipeConnection": {
      "pipeID": "string",
      "inputID": "string",
      "outputID": "string",
      "outputName": "string",
      "lastValidated": "2019-08-24T14:15:22Z",
      "inputMapping": [],
      "outputMapping": []
    },
    "inputTable": "string",
    "uploadStage": true,
    "predictStage": true,
    "downloadStage": true,
    "symonImportType": "None",
    "refreshAllPipeDatasources": true,
    "connectorID": "string",
    "streamID": "string",
    "importConfig": null,
    "outputMapping": [
      {}
    ],
    "cosLocations": [
      {}
    ],
    "cosCredentials": {
      "endpoint": "string",
      "accessKey": "string",
      "secretKey": "string",
      "sessionToken": "string",
      "taskAuthToken": "string",
      "taskAuthEndpoint": "string",
      "taskAuthExpiration": "string"
    }
  },
  "numLines": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/imports/{id}/preview',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/imports/{id}/preview', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/imports/{id}/preview',
  params: {
  }, headers: headers

p JSON.parse(result)

Get header information (and sample row information, if available) from a remote file.

Body parameter

{
  "name": "string",
  "importType": "None",
  "hasHeader": true,
  "table": "string",
  "columnMatchings": {
    "columns": [
      "string"
    ],
    "matched": [
      "string"
    ]
  },
  "dateFormat": "Default",
  "listSubitems": [
    "string"
  ],
  "subitemMap": {
    "property1": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    },
    "property2": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    }
  },
  "addMember": true,
  "updateExistingRows": true,
  "tableType": "System",
  "isLocal": true,
  "localCulture": {},
  "useIncrementalImport": true,
  "culture": "string",
  "tableEffectiveDated": true,
  "isODBCTextDriver": true,
  "version": {
    "rowVersion": 0
  },
  "fileOverwrite": true,
  "importId": 0,
  "filename": "string",
  "localPath": "string",
  "username": "string",
  "password": "string",
  "delimiter": "string",
  "sheetName": "string",
  "cellRange": "string",
  "query": "string",
  "queryTimeout": 0,
  "connectionString": "string",
  "useAdvanced": true,
  "model": "string",
  "importMethod": 0,
  "sourceTableName": "string",
  "securityToken": "string",
  "customColumns": [
    "string"
  ],
  "userSelected": true,
  "sandbox": true,
  "fileLocation": "string",
  "codePage": 0,
  "ignoreFirst": true,
  "ignoreLast": true,
  "recordLength": 0,
  "fields": [
    {
      "name": "string",
      "offset": 0,
      "length": 0,
      "dataType": "String"
    }
  ],
  "selectRowNode": "string",
  "pipeConnection": {
    "pipeID": "string",
    "inputID": "string",
    "outputID": "string",
    "outputName": "string",
    "lastValidated": "2019-08-24T14:15:22Z",
    "inputMapping": [
      {}
    ],
    "outputMapping": [
      {}
    ]
  },
  "inputTable": "string",
  "uploadStage": true,
  "predictStage": true,
  "downloadStage": true,
  "symonImportType": "None",
  "refreshAllPipeDatasources": true,
  "connectorID": "string",
  "streamID": "string",
  "importConfig": null,
  "outputMapping": [
    {
      "source": "string",
      "destination": "string",
      "type": "String"
    }
  ],
  "cosLocations": [
    {
      "bucket": "string",
      "key": "string"
    }
  ],
  "cosCredentials": {
    "endpoint": "string",
    "accessKey": "string",
    "secretKey": "string",
    "sessionToken": "string",
    "taskAuthToken": "string",
    "taskAuthEndpoint": "string",
    "taskAuthExpiration": "string"
  }
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

RESTAPI.v1.DTOs.Composer.DataImport.ImportParamsDTO

false

none

» name

body

string¦null

false

none

» importType

body

string

false

none

» hasHeader

body

boolean

false

none

» table

body

string¦null

false

none

» columnMatchings

body

RESTAPI.v1.DTOs.ColumnMatchingsDTO

false

none

»» columns

body

[string]¦null

false

none

»» matched

body

[string]¦null

false

none

» dateFormat

body

string

false

none

» listSubitems

body

[string]¦null

false

none

» subitemMap

body

object¦null

false

none

»» additionalProperties

body

RESTAPI.v1.DTOs.Composer.DataImport.SubitemDTO

false

none

»»» name

body

[string]¦null

false

none

»»» fieldName

body

[string]¦null

false

none

»»» type

body

string

false

none

»»» delimiter

body

string¦null

false

none

»»» segment

body

integer(int32)

false

none

»»» selection

body

[string]¦null

false

none

»»» fieldIndices

body

[integer]¦null

false

none

» addMember

body

boolean

false

none

» updateExistingRows

body

boolean

false

none

» tableType

body

string

false

none

» isLocal

body

boolean

false

none

» localCulture

body

System.IFormatProvider

false

none

» useIncrementalImport

body

boolean

false

none

» culture

body

string¦null

false

none

» tableEffectiveDated

body

boolean

false

none

» isODBCTextDriver

body

boolean

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

» fileOverwrite

body

boolean

false

none

» importId

body

integer(int32)

false

none

» filename

body

string¦null

false

none

» localPath

body

string¦null

false

none

» username

body

string¦null

false

none

» password

body

string¦null

false

none

» delimiter

body

string

false

none

» sheetName

body

string¦null

false

none

» cellRange

body

string¦null

false

none

» query

body

string¦null

false

none

» queryTimeout

body

integer(int32)

false

none

» connectionString

body

string¦null

false

none

» useAdvanced

body

boolean

false

none

» model

body

string¦null

false

none

» importMethod

body

integer(int32)

false

none

» sourceTableName

body

string¦null

false

none

» securityToken

body

string¦null

false

none

» customColumns

body

[string]¦null

false

none

» userSelected

body

boolean

false

none

» sandbox

body

boolean

false

none

» fileLocation

body

string¦null

false

none

» codePage

body

integer(int32)

false

none

» ignoreFirst

body

boolean

false

none

» ignoreLast

body

boolean

false

none

» recordLength

body

integer(int32)

false

none

» fields

body

[RESTAPI.v1.DTOs.Composer.DataImport.EBCDICFieldDTO]¦null

false

none

»» name

body

string¦null

false

none

»» offset

body

integer(int32)

false

none

»» length

body

integer(int32)

false

none

»» dataType

body

string

false

none

» selectRowNode

body

string¦null

false

none

» pipeConnection

body

Varicent.RESTAPI.v1.DTOs.Symon.PipeConnectionDTO

false

none

»» pipeID

body

string¦null

false

none

»» inputID

body

string¦null

false

none

»» outputID

body

string¦null

false

none

»» outputName

body

string¦null

false

none

»» lastValidated

body

string(date-time)

false

none

»» inputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»»» source

body

string¦null

false

none

»»» destination

body

string¦null

false

none

»»» type

body

string

false

none

»» outputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

» inputTable

body

string¦null

false

none

» uploadStage

body

boolean

false

none

» predictStage

body

boolean

false

none

» downloadStage

body

boolean

false

none

» symonImportType

body

string

false

none

» refreshAllPipeDatasources

body

boolean

false

none

» connectorID

body

string¦null

false

none

» streamID

body

string¦null

false

none

» importConfig

body

any

false

none

» outputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

» cosLocations

body

[RESTAPI.v1.DTOs.Symon.CosLocationDTO]¦null

false

none

»» bucket

body

string¦null

false

none

»» key

body

string¦null

false

none

» cosCredentials

body

RESTAPI.v1.DTOs.Composer.DataImport.CosCredentialsDTO

false

none

»» endpoint

body

string¦null

false

none

»» accessKey

body

string¦null

false

none

»» secretKey

body

string¦null

false

none

»» sessionToken

body

string¦null

false

none

»» taskAuthToken

body

string¦null

false

none

»» taskAuthEndpoint

body

string¦null

false

none

»» taskAuthExpiration

body

string¦null

false

none

Enumerated Values

Parameter

Value

» importType

None

» importType

Text

» importType

Excel

» importType

DBImport

» importType

Salesforce

» importType

MSCRM

» importType

EBCDICText

» importType

TerrAlign

» importType

XML

» importType

ODBCImport

» importType

SymonImport

» importType

SymonConnectorImport

» importType

Cos

» importType

SQLServer

» importType

Dynamics

» importType

GoogleSheets

» importType

MySql

» importType

AmazonAurora

» importType

AmazonS3

» importType

Snowflake

» importType

Shopify

» importType

Hubspot

» importType

Oracle

» importType

AmazonRedshift

» importType

Workday

» dateFormat

Default

» dateFormat

DayFirst

» dateFormat

MonthFirst

»»» type

Delimited

»»» type

Selection

»»» type

Merged

» tableType

System

» tableType

Dimension

» tableType

Structural

» tableType

Lookup

» tableType

Data

» tableType

View

» tableType

Custom

» tableType

StarSchema

» tableType

ExportTable

» tableType

CreditingRule

» tableType

AssignTable

» tableType

PlcmCustomTable

» tableType

PlcmStructuralTable

» tableType

PlcmTable

» tableType

DataSource

» tableType

Cached

» tableType

MaterializedView

»» dataType

String

»» dataType

Decimal

»»» type

String

»»» type

Number

»»» type

Boolean

»»» type

Date

» symonImportType

None

» symonImportType

Text

» symonImportType

Excel

» symonImportType

DBImport

» symonImportType

Salesforce

» symonImportType

MSCRM

» symonImportType

EBCDICText

» symonImportType

TerrAlign

» symonImportType

XML

» symonImportType

ODBCImport

» symonImportType

SymonImport

» symonImportType

SymonConnectorImport

» symonImportType

Cos

» symonImportType

SQLServer

» symonImportType

Dynamics

» symonImportType

GoogleSheets

» symonImportType

MySql

» symonImportType

AmazonAurora

» symonImportType

AmazonS3

» symonImportType

Snowflake

» symonImportType

Shopify

» symonImportType

Hubspot

» symonImportType

Oracle

» symonImportType

AmazonRedshift

» symonImportType

Workday

Responses

Status

Meaning

Description

Schema

200

OK

Gets header information (and sample row information, if available) from a remote file.

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/imports/{id}/remoteheader", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/imports/{id}/remoteheader");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "name": "string",
  "importType": "None",
  "hasHeader": true,
  "table": "string",
  "columnMatchings": {
    "columns": [
      "string"
    ],
    "matched": [
      "string"
    ]
  },
  "dateFormat": "Default",
  "listSubitems": [
    "string"
  ],
  "subitemMap": {
    "property1": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    },
    "property2": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    }
  },
  "addMember": true,
  "updateExistingRows": true,
  "tableType": "System",
  "isLocal": true,
  "localCulture": {},
  "useIncrementalImport": true,
  "culture": "string",
  "tableEffectiveDated": true,
  "isODBCTextDriver": true,
  "version": {
    "rowVersion": 0
  },
  "fileOverwrite": true,
  "importId": 0,
  "filename": "string",
  "localPath": "string",
  "username": "string",
  "password": "string",
  "delimiter": "string",
  "sheetName": "string",
  "cellRange": "string",
  "query": "string",
  "queryTimeout": 0,
  "connectionString": "string",
  "useAdvanced": true,
  "model": "string",
  "importMethod": 0,
  "sourceTableName": "string",
  "securityToken": "string",
  "customColumns": [
    "string"
  ],
  "userSelected": true,
  "sandbox": true,
  "fileLocation": "string",
  "codePage": 0,
  "ignoreFirst": true,
  "ignoreLast": true,
  "recordLength": 0,
  "fields": [
    {
      "name": "string",
      "offset": 0,
      "length": 0,
      "dataType": "String"
    }
  ],
  "selectRowNode": "string",
  "pipeConnection": {
    "pipeID": "string",
    "inputID": "string",
    "outputID": "string",
    "outputName": "string",
    "lastValidated": "2019-08-24T14:15:22Z",
    "inputMapping": [
      {}
    ],
    "outputMapping": [
      {}
    ]
  },
  "inputTable": "string",
  "uploadStage": true,
  "predictStage": true,
  "downloadStage": true,
  "symonImportType": "None",
  "refreshAllPipeDatasources": true,
  "connectorID": "string",
  "streamID": "string",
  "importConfig": null,
  "outputMapping": [
    {
      "source": "string",
      "destination": "string",
      "type": "String"
    }
  ],
  "cosLocations": [
    {
      "bucket": "string",
      "key": "string"
    }
  ],
  "cosCredentials": {
    "endpoint": "string",
    "accessKey": "string",
    "secretKey": "string",
    "sessionToken": "string",
    "taskAuthToken": "string",
    "taskAuthEndpoint": "string",
    "taskAuthExpiration": "string"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/imports/{id}/remoteheader',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/imports/{id}/remoteheader', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/imports/{id}/remoteheader',
  params: {
  }, headers: headers

p JSON.parse(result)

Get all transformations.

Parameters

Name

In

Type

Required

Description

orderBy

query

string

false

####Description

Detailed descriptions

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

id, name

Responses

Status

Meaning

Description

Schema

200

OK

Get All Transformations

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.TransformationDTO]

false

none

none

» id

integer(int32)¦null

false

none

none

» name

string¦null

false

none

none

» table

string¦null

false

none

none

» sourceColumn

string¦null

false

none

none

» find

string¦null

false

none

none

» targetColumn

string¦null

false

none

none

» replace

string¦null

false

none

none

» replaceType

string

false

none

none

» findType

string

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

Enumerated Values

Property

Value

replaceType

Text

replaceType

Decimal

replaceType

Date

findType

Text

findType

Decimal

findType

Date

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/transforms", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/transforms");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/transforms',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/transforms', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/transforms',
  params: {
  }, headers: headers

p JSON.parse(result)

Insert a transformation. Transform and then save.

Body parameter

{
  "id": 0,
  "name": "string",
  "table": "string",
  "sourceColumn": "string",
  "find": "string",
  "targetColumn": "string",
  "replace": "string",
  "replaceType": "Text",
  "findType": "Text",
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.TransformationDTO

false

none

» id

body

integer(int32)¦null

false

none

» name

body

string¦null

false

none

» table

body

string¦null

false

none

» sourceColumn

body

string¦null

false

none

» find

body

string¦null

false

none

» targetColumn

body

string¦null

false

none

» replace

body

string¦null

false

none

» replaceType

body

string

false

none

» findType

body

string

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Enumerated Values

Parameter

Value

» replaceType

Text

» replaceType

Decimal

» replaceType

Date

» findType

Text

» findType

Decimal

» findType

Date

Responses

Status

Meaning

Description

Schema

200

OK

Transform and Save Transformation

Varicent.RESTAPI.v1.DTOs.TransformationDTO

400

Bad Request

Transformation could not be found

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/transforms", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/transforms");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "name": "string",
  "table": "string",
  "sourceColumn": "string",
  "find": "string",
  "targetColumn": "string",
  "replace": "string",
  "replaceType": "Text",
  "findType": "Text",
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/transforms',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/transforms', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/transforms',
  params: {
  }, headers: headers

p JSON.parse(result)

Get transformations by table.

Parameters

Name

In

Type

Required

Description

table

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get All Transformations by Table

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.TransformationDTO]

false

none

none

» id

integer(int32)¦null

false

none

none

» name

string¦null

false

none

none

» table

string¦null

false

none

none

» sourceColumn

string¦null

false

none

none

» find

string¦null

false

none

none

» targetColumn

string¦null

false

none

none

» replace

string¦null

false

none

none

» replaceType

string

false

none

none

» findType

string

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

Enumerated Values

Property

Value

replaceType

Text

replaceType

Decimal

replaceType

Date

findType

Text

findType

Decimal

findType

Date

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/transforms/{table}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/transforms/{table}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/transforms/{table}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/transforms/{table}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/transforms/{table}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "name": "string",
    "table": "string",
    "sourceColumn": "string",
    "find": "string",
    "targetColumn": "string",
    "replace": "string",
    "replaceType": "Text",
    "findType": "Text",
    "version": {
      "rowVersion": 0
    }
  }
]
[{"id":0,"name":"string","table":"string","sourceColumn":"string","find":"string","targetColumn":"string","replace":"string","replaceType":"Text","findType":"Text","version":{"rowVersion":0}}]

Delete transformation by ID.

Parameters

Name

In

Type

Required

Description

transformationID

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Delete Transformation by ID

None

404

Not Found

Transformation does not exist

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/transforms/{transformationID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/transforms/{transformationID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/transforms/{transformationID}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/transforms/{transformationID}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/transforms/{transformationID}',
  params: {
  }

p JSON.parse(result)

Update a given transformation.

Body parameter

{
  "id": 0,
  "name": "string",
  "table": "string",
  "sourceColumn": "string",
  "find": "string",
  "targetColumn": "string",
  "replace": "string",
  "replaceType": "Text",
  "findType": "Text",
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

transformationID

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.TransformationDTO

false

none

» id

body

integer(int32)¦null

false

none

» name

body

string¦null

false

none

» table

body

string¦null

false

none

» sourceColumn

body

string¦null

false

none

» find

body

string¦null

false

none

» targetColumn

body

string¦null

false

none

» replace

body

string¦null

false

none

» replaceType

body

string

false

none

» findType

body

string

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Enumerated Values

Parameter

Value

» replaceType

Text

» replaceType

Decimal

» replaceType

Date

» findType

Text

» findType

Decimal

» findType

Date

Responses

Status

Meaning

Description

Schema

200

OK

Update Transformation

Varicent.RESTAPI.v1.DTOs.TransformationDTO

400

Bad Request

Transformation is not valid

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/transforms/{transformationID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/transforms/{transformationID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "name": "string",
  "table": "string",
  "sourceColumn": "string",
  "find": "string",
  "targetColumn": "string",
  "replace": "string",
  "replaceType": "Text",
  "findType": "Text",
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/transforms/{transformationID}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/transforms/{transformationID}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/transforms/{transformationID}',
  params: {
  }, headers: headers

p JSON.parse(result)

Transform a given transformation.

Parameters

Name

In

Type

Required

Description

transformationID

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Transform

None

404

Not Found

Transformation does not exist

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/transforms/{transformationID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/transforms/{transformationID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/rpc/transforms/{transformationID}',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/v1/rpc/transforms/{transformationID}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/v1/rpc/transforms/{transformationID}',
  params: {
  }

p JSON.parse(result)

Perform a transformation.

Body parameter

{
  "id": 0,
  "name": "string",
  "table": "string",
  "sourceColumn": "string",
  "find": "string",
  "targetColumn": "string",
  "replace": "string",
  "replaceType": "Text",
  "findType": "Text",
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.TransformationDTO

false

none

» id

body

integer(int32)¦null

false

none

» name

body

string¦null

false

none

» table

body

string¦null

false

none

» sourceColumn

body

string¦null

false

none

» find

body

string¦null

false

none

» targetColumn

body

string¦null

false

none

» replace

body

string¦null

false

none

» replaceType

body

string

false

none

» findType

body

string

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Enumerated Values

Parameter

Value

» replaceType

Text

» replaceType

Decimal

» replaceType

Date

» findType

Text

» findType

Decimal

» findType

Date

Responses

Status

Meaning

Description

Schema

200

OK

Perform Transformation

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/transforms", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/transforms");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "name": "string",
  "table": "string",
  "sourceColumn": "string",
  "find": "string",
  "targetColumn": "string",
  "replace": "string",
  "replaceType": "Text",
  "findType": "Text",
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/transforms',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/transforms', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/transforms',
  params: {
  }, headers: headers

p JSON.parse(result)

Get element by ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Element ID

Responses

Status

Meaning

Description

Schema

200

OK

Get Element by Id

Varicent.RESTAPI.v1.DTOs.Composer.ElementDTO

404

Not Found

Element not found

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/composer/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/composer/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/composer/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/composer/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/composer/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "isEmpty": true,
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1,
    "left": 0.1,
    "top": 0.1,
    "right": 0.1,
    "bottom": 0.1,
    "isEmpty": true
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}
{"elementId":0,"parentBlockId":0,"bounds":{"location":{"isEmpty":true,"x":0.1,"y":0.1},"size":"string","x":0.1,"y":0.1,"width":0.1,"height":0.1,"left":0.1,"top":0.1,"right":0.1,"bottom":0.1,"isEmpty":true},"color":{"a":0,"b":0,"g":0,"r":0},"name":"string","parentBlock":{"id":0,"name":"string","href":"string"},"isVisible":true,"version":{"rowVersion":0}}

Update an element by ID.

Body parameter

{
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Element ID

body

body

Varicent.RESTAPI.v1.DTOs.Composer.ElementDTO

false

ElementDTO

» elementId

body

integer(int32)

false

none

» parentBlockId

body

integer(int32)¦null

false

none

» bounds

body

System.Drawing.RectangleF

false

none

»» location

body

System.Drawing.PointF

false

none

»»» isEmpty

body

boolean

false

none

»»» x

body

number(float)

false

none

»»» y

body

number(float)

false

none

»» size

body

string

false

none

»» x

body

number(float)

false

none

»» y

body

number(float)

false

none

»» width

body

number(float)

false

none

»» height

body

number(float)

false

none

»» left

body

number(float)

false

none

»» top

body

number(float)

false

none

»» right

body

number(float)

false

none

»» bottom

body

number(float)

false

none

»» isEmpty

body

boolean

false

none

» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»» a

body

integer(int32)

false

none

»» b

body

integer(int32)

false

none

»» g

body

integer(int32)

false

none

»» r

body

integer(int32)

false

none

» name

body

string¦null

false

none

» parentBlock

body

Varicent.RESTAPI.v1.DTOs.Composer.ExpandableBlockElementDTO

false

none

»» id

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» href

body

string¦null

false

none

» isVisible

body

boolean

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Patch Element by Id

Varicent.RESTAPI.v1.DTOs.Composer.ElementDTO

400

Bad Request

Element id does not match parameter id

None

404

Not Found

Element not found

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/composer/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/composer/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/composer/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/composer/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/composer/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "isEmpty": true,
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1,
    "left": 0.1,
    "top": 0.1,
    "right": 0.1,
    "bottom": 0.1,
    "isEmpty": true
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}
{"elementId":0,"parentBlockId":0,"bounds":{"location":{"isEmpty":true,"x":0.1,"y":0.1},"size":"string","x":0.1,"y":0.1,"width":0.1,"height":0.1,"left":0.1,"top":0.1,"right":0.1,"bottom":0.1,"isEmpty":true},"color":{"a":0,"b":0,"g":0,"r":0},"name":"string","parentBlock":{"id":0,"name":"string","href":"string"},"isVisible":true,"version":{"rowVersion":0}}

Get element details by ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Element ID

Responses

Status

Meaning

Description

Schema

200

OK

Get Element details by ID

Varicent.RESTAPI.v1.DTOs.Composer.TypedElements.TypedElementDTO

404

Not Found

Element not found

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/composer/{id}/details", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/composer/{id}/details");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/composer/{id}/details',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/composer/{id}/details', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/composer/{id}/details',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "details": "string",
  "elements": "string",
  "type": "Block",
  "calculationType": "Mathematical",
  "comment": "string",
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "isEmpty": true,
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1,
    "left": 0.1,
    "top": 0.1,
    "right": 0.1,
    "bottom": 0.1,
    "isEmpty": true
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}
{"details":"string","elements":"string","type":"Block","calculationType":"Mathematical","comment":"string","elementId":0,"parentBlockId":0,"bounds":{"location":{"isEmpty":true,"x":0.1,"y":0.1},"size":"string","x":0.1,"y":0.1,"width":0.1,"height":0.1,"left":0.1,"top":0.1,"right":0.1,"bottom":0.1,"isEmpty":true},"color":{"a":0,"b":0,"g":0,"r":0},"name":"string","parentBlock":{"id":0,"name":"string","href":"string"},"isVisible":true,"version":{"rowVersion":0}}

Delete multiple elements at once to circumvent deletion dependencies.

Nothing is deleted if an error occurs.

Body parameter

[
  {
    "key": "Block",
    "value": "string"
  }
]

Parameters

Name

In

Type

Required

Description

parentBlockId

path

integer(int32)

true

ID of the parent block

body

body

[System.Collections.Generic.KeyValuePair2[Varicent.Domain.Composer.ElementType,System.String]](#schemasystem.collections.generic.keyvaluepair2[varicent.domain.composer.elementtype,system.string])

false

List of elements to delete

Responses

Status

Meaning

Description

Schema

204

No Content

All provided elements have been deleted.

None

409

Conflict

A dependency error occurred.

RESTAPI.v1.DTOs.DependencyInfoDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/composer/{parentBlockId}/elements", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/composer/{parentBlockId}/elements");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "key": "Block",
    "value": "string"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/composer/{parentBlockId}/elements',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.delete('http://localhost:8080/api/v1/composer/{parentBlockId}/elements', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.delete 'http://localhost:8080/api/v1/composer/{parentBlockId}/elements',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "dependencies": {
    "Calendars": [
      {}
    ],
    "StarSchemas": [
      {}
    ],
    "Calculations": [
      {}
    ],
    "SavedImports": [
      {}
    ],
    "InputForms": [
      {}
    ],
    "TaskGroup": [
      {}
    ],
    "Plans": [
      {}
    ],
    "TailoredReports": [
      {}
    ],
    "Publications": [
      {}
    ],
    "PayeeGroups": [
      {}
    ],
    "Payees": [
      {}
    ],
    "Blocks": [
      {}
    ],
    "Ports": [
      {}
    ],
    "WebForms": [
      {}
    ],
    "WebFormFilters": [
      {}
    ],
    "WorkflowGroups": [
      {}
    ],
    "WebTab": [
      {}
    ],
    "Transformations": [
      {}
    ],
    "WebFormValidationRules": [
      {}
    ],
    "DataStores": [
      {}
    ],
    "BPMWorkflow": [
      {}
    ],
    "BPMSwimLane": [
      {}
    ],
    "BPMNode": [
      {}
    ],
    "BPMComponent": [
      {}
    ],
    "Views": [
      {}
    ],
    "Tables": [
      {}
    ],
    "PresenterReports": [
      {}
    ],
    "PickList": [
      {}
    ],
    "WebEditRestriction": [
      {}
    ],
    "PresenterReportDataSources": [
      {}
    ],
    "PresenterReportValueSources": [
      {}
    ],
    "PresenterReportRowFormSources": [
      {}
    ],
    "ScenarioWorkspace": [
      {}
    ],
    "Scheduler": [
      {}
    ],
    "RapidReport": [
      {}
    ],
    "DDE": [
      {}
    ],
    "Hierarchy": [
      {}
    ],
    "PresenterFlex": [
      {}
    ],
    "AdaptiveForms": [
      {}
    ],
    "ReportDataModelSource": [
      {}
    ],
    "PlanComponentSource": [
      {}
    ],
    "PlanBuilderCalculation": [
      {}
    ],
    "PlanBuilderItem": [
      {}
    ]
  }
}
{"dependencies":{"Calendars":[{}],"StarSchemas":[{}],"Calculations":[{}],"SavedImports":[{}],"InputForms":[{}],"TaskGroup":[{}],"Plans":[{}],"TailoredReports":[{}],"Publications":[{}],"PayeeGroups":[{}],"Payees":[{}],"Blocks":[{}],"Ports":[{}],"WebForms":[{}],"WebFormFilters":[{}],"WorkflowGroups":[{}],"WebTab":[{}],"Transformations":[{}],"WebFormValidationRules":[{}],"DataStores":[{}],"BPMWorkflow":[{}],"BPMSwimLane":[{}],"BPMNode":[{}],"BPMComponent":[{}],"Views":[{}],"Tables":[{}],"PresenterReports":[{}],"PickList":[{}],"WebEditRestriction":[{}],"PresenterReportDataSources":[{}],"PresenterReportValueSources":[{}],"PresenterReportRowFormSources":[{}],"ScenarioWorkspace":[{}],"Scheduler":[{}],"RapidReport":[{}],"DDE":[{}],"Hierarchy":[{}],"PresenterFlex":[{}],"AdaptiveForms":[{}],"ReportDataModelSource":[{}],"PlanComponentSource":[{}],"PlanBuilderCalculation":[{}],"PlanBuilderItem":[{}]}}

Get visible elements (composer scope) inside a given component.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Block Id

filter

query

string

false

####Supported operations

usesId

query

integer(int32)

false

none

usedbyId

query

integer(int32)

false

none

blockId

query

integer(int32)

false

none

Detailed descriptions

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

ports, block

Responses

Status

Meaning

Description

Schema

200

OK

Get component’s elements.

Varicent.RESTAPI.v1.DTOs.Composer.ComponentScopeDTOVaricent.RESTAPI.v1.DTOs.Composer.ComponentScopeDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/composer/{id}/elements", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/composer/{id}/elements");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/composer/{id}/elements',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/composer/{id}/elements', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/composer/{id}/elements',
  params: {
  }, headers: headers

p JSON.parse(result)

Update elements.

Body parameter

[
  {
    "elementId": 0,
    "parentBlockId": 0,
    "bounds": {
      "location": {},
      "size": "string",
      "x": 0.1,
      "y": 0.1,
      "width": 0.1,
      "height": 0.1
    },
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "name": "string",
    "parentBlock": {
      "id": 0,
      "name": "string",
      "href": "string"
    },
    "isVisible": true,
    "version": {
      "rowVersion": 0
    }
  }
]

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Composer.ElementDTO

false

ElementDTO

Responses

Status

Meaning

Description

Schema

200

OK

Elements provided are being updated

Inline

400

Bad Request

Element not found

None

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

integer(int64)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/composer", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/composer");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "elementId": 0,
    "parentBlockId": 0,
    "bounds": {
      "location": {},
      "size": "string",
      "x": 0.1,
      "y": 0.1,
      "width": 0.1,
      "height": 0.1
    },
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "name": "string",
    "parentBlock": {
      "id": 0,
      "name": "string",
      "href": "string"
    },
    "isVisible": true,
    "version": {
      "rowVersion": 0
    }
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/composer',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/composer', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/composer',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "property1": 0,
  "property2": 0
}
{"property1":0,"property2":0}

Returns all sources for the elements with the given elementIDs.

Body parameter

{
  "elementIDs": [
    0
  ]
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Composer.ElementIDsDTO

false

Element IDs for elements to get sources for

» elementIDs

body

[integer]¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Sources for the given elements.

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/composer/pasteElementSources", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/composer/pasteElementSources");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "elementIDs": [
    0
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/composer/pasteElementSources',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/composer/pasteElementSources', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/composer/pasteElementSources',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  "string"
]
["string"]

Returns all sources with details for the elements with the given elemenIDs.

Body parameter

{
  "elementIDs": [
    0
  ]
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Composer.ElementIDsDTO

false

Element IDs for elements to get sources for

» elementIDs

body

[integer]¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Sources for the given elements.

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.Composer.ElementPasteSourceDTO]

false

none

none

» elementID

integer(int32)

false

none

none

» source

string¦null

false

none

none

» outputTable

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/composer/pasteElementSourcesDetails", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/composer/pasteElementSourcesDetails");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "elementIDs": [
    0
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/composer/pasteElementSourcesDetails',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/composer/pasteElementSourcesDetails', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/composer/pasteElementSourcesDetails',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "elementID": 0,
    "source": "string",
    "outputTable": "string"
  }
]
[{"elementID":0,"source":"string","outputTable":"string"}]

Search all composer elements, constrained by user view permissions.

Parameters

Name

In

Type

Required

Description

filter

query

string

false

Filter over Name

Responses

Status

Meaning

Description

Schema

200

OK

Search all composer elements

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.SearchItemDTO]

false

none

none

» id

integer(int32)

false

none

none

» parentBlockId

integer(int32)

false

none

none

» name

string¦null

false

none

none

» type

string

false

none

none

» subType

string

false

none

none

» calculationType

string

false

none

none

» canView

boolean

false

none

none

» blockId

integer(int32)¦null

false

none

none

» details

string¦null

false

none

none

Enumerated Values

Property

Value

type

Block

type

Table

type

Calculation

type

Plan

type

TailoredReport

type

WebForm

type

WebReport

type

InputPort

type

OutputPort

type

Library

type

DataStore

type

AssignTable

type

Hub

type

Waypoint

type

InsertionPoint

subType

None

subType

InsertionPoint

subType

Waypoint

calculationType

Mathematical

calculationType

Sorting

calculationType

TimeShift

calculationType

Category

calculationType

Symon

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/composer/search", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/composer/search");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/composer/search',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/composer/search', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/composer/search',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "parentBlockId": 0,
    "name": "string",
    "type": "Block",
    "subType": "None",
    "calculationType": "Mathematical",
    "canView": true,
    "blockId": 0,
    "details": "string"
  }
]
[{"id":0,"parentBlockId":0,"name":"string","type":"Block","subType":"None","calculationType":"Mathematical","canView":true,"blockId":0,"details":"string"}]

Get all favorite elements and folders.

Responses

Status

Meaning

Description

Schema

200

OK

Get all favorite elements and folders

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.TreeNodeDTO]

false

none

none

» node

any

false

none

none

» children

array¦null

false

none

none

»» anonymous

any

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/composerfavorites", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/composerfavorites");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/composerfavorites',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/composerfavorites', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/composerfavorites',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "node": null,
    "children": []
  }
]
[{"node":null,"children":[]}]

Moves a favorite folder.

Body parameter

{
  "originOrder": 0,
  "originNodeId": 0,
  "destinationOrder": 0,
  "destinationNodeId": 0
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.MoveFavoriteDTO

false

The folders to update

» originOrder

body

integer(int32)

false

none

» originNodeId

body

integer(int32)

false

none

» destinationOrder

body

integer(int32)

false

none

» destinationNodeId

body

integer(int32)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Put Element by Id

Varicent.RESTAPI.v1.DTOs.Composer.ElementDTO

400

Bad Request

Element id does not match parameter id

None

404

Not Found

Element not found

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/composerfavorites", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/composerfavorites");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "originOrder": 0,
  "originNodeId": 0,
  "destinationOrder": 0,
  "destinationNodeId": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/composerfavorites',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/composerfavorites', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/composerfavorites',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "isEmpty": true,
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1,
    "left": 0.1,
    "top": 0.1,
    "right": 0.1,
    "bottom": 0.1,
    "isEmpty": true
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}
{"elementId":0,"parentBlockId":0,"bounds":{"location":{"isEmpty":true,"x":0.1,"y":0.1},"size":"string","x":0.1,"y":0.1,"width":0.1,"height":0.1,"left":0.1,"top":0.1,"right":0.1,"bottom":0.1,"isEmpty":true},"color":{"a":0,"b":0,"g":0,"r":0},"name":"string","parentBlock":{"id":0,"name":"string","href":"string"},"isVisible":true,"version":{"rowVersion":0}}

Update a favorite folder.

Body parameter

{
  "node": null,
  "children": []
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Element ID

body

body

RESTAPI.v1.DTOs.TreeNodeDTO

false

The folder to update

» node

body

any

false

none

» children

body

array¦null

false

none

»» anonymous

body

any

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Put Element by Id

Varicent.RESTAPI.v1.DTOs.Composer.ElementDTO

400

Bad Request

Element id does not match parameter id

None

404

Not Found

Element not found

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/composerfavorites/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/composerfavorites/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "node": null,
  "children": []
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/composerfavorites/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/composerfavorites/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/composerfavorites/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "isEmpty": true,
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1,
    "left": 0.1,
    "top": 0.1,
    "right": 0.1,
    "bottom": 0.1,
    "isEmpty": true
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}
{"elementId":0,"parentBlockId":0,"bounds":{"location":{"isEmpty":true,"x":0.1,"y":0.1},"size":"string","x":0.1,"y":0.1,"width":0.1,"height":0.1,"left":0.1,"top":0.1,"right":0.1,"bottom":0.1,"isEmpty":true},"color":{"a":0,"b":0,"g":0,"r":0},"name":"string","parentBlock":{"id":0,"name":"string","href":"string"},"isVisible":true,"version":{"rowVersion":0}}

Create a favorite folder or element.

Body parameter

{
  "node": null,
  "children": []
}

Parameters

Name

In

Type

Required

Description

order

path

integer(int32)

true

the position of the item to be added within the child array

body

body

RESTAPI.v1.DTOs.TreeNodeDTO

false

The parent of the item to add

» node

body

any

false

none

» children

body

array¦null

false

none

»» anonymous

body

any

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Post Favorite Folder

Varicent.RESTAPI.v1.DTOs.FavoriteFolderDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/composerfavorites/{order}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/composerfavorites/{order}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "node": null,
  "children": []
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/composerfavorites/{order}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/composerfavorites/{order}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/composerfavorites/{order}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "folderName": "string",
  "parentFolderId": 0,
  "rowVersion": {
    "rowVersion": 0
  },
  "type": "Block"
}
{"id":0,"folderName":"string","parentFolderId":0,"rowVersion":{"rowVersion":0},"type":"Block"}

Delete a favorite folder or element.

Body parameter

{
  "node": null,
  "children": []
}

Parameters

Name

In

Type

Required

Description

order

path

integer(int32)

true

the position of the item to be deleted within the child array

body

body

RESTAPI.v1.DTOs.TreeNodeDTO

false

The parent of the item to delete

» node

body

any

false

none

» children

body

array¦null

false

none

»» anonymous

body

any

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Post Favorite Folder

RESTAPI.v1.DTOs.TreeNodeDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/composerfavorites/{order}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/composerfavorites/{order}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "node": null,
  "children": []
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/composerfavorites/{order}',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.delete('http://localhost:8080/api/v1/composerfavorites/{order}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.delete 'http://localhost:8080/api/v1/composerfavorites/{order}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "node": null,
  "children": []
}
{"node":null,"children":[]}

Get connections for a given port.

Parameters

Name

In

Type

Required

Description

portId

path

integer(int32)

true

Port ID

Responses

Status

Meaning

Description

Schema

200

OK

Get Port connections for the given port ID

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Composer.TypedElements.TypedElementDTO]

false

none

none

» details

string¦null

false

none

none

» elements

string¦null

false

none

none

» type

string

false

none

none

» calculationType

string

false

none

none

» comment

string¦null

false

none

none

» elementId

integer(int32)

false

none

none

» parentBlockId

integer(int32)¦null

false

none

none

» bounds

System.Drawing.RectangleF

false

none

none

»» location

System.Drawing.PointF

false

none

none

»»» isEmpty

boolean

false

read-only

none

»»» x

number(float)

false

none

none

»»» y

number(float)

false

none

none

»» size

string

false

none

none

»» x

number(float)

false

none

none

»» y

number(float)

false

none

none

»» width

number(float)

false

none

none

»» height

number(float)

false

none

none

»» left

number(float)

false

read-only

none

»» top

number(float)

false

read-only

none

»» right

number(float)

false

read-only

none

»» bottom

number(float)

false

read-only

none

»» isEmpty

boolean

false

read-only

none

» color

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

none

»» a

integer(int32)

false

none

none

»» b

integer(int32)

false

none

none

»» g

integer(int32)

false

none

none

»» r

integer(int32)

false

none

none

» name

string¦null

false

none

none

» parentBlock

Varicent.RESTAPI.v1.DTOs.Composer.ExpandableBlockElementDTO

false

none

none

»» id

integer(int32)

false

none

none

»» name

string¦null

false

none

none

»» href

string¦null

false

none

none

» isVisible

boolean

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

Enumerated Values

Property

Value

type

Block

type

Table

type

Calculation

type

Plan

type

TailoredReport

type

WebForm

type

WebReport

type

InputPort

type

OutputPort

type

Library

type

DataStore

type

AssignTable

type

Hub

type

Waypoint

type

InsertionPoint

calculationType

Mathematical

calculationType

Sorting

calculationType

TimeShift

calculationType

Category

calculationType

Symon

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/ports/{portId}/connections", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/ports/{portId}/connections");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/ports/{portId}/connections',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/ports/{portId}/connections', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/ports/{portId}/connections',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "details": "string",
    "elements": "string",
    "type": "Block",
    "calculationType": "Mathematical",
    "comment": "string",
    "elementId": 0,
    "parentBlockId": 0,
    "bounds": {
      "location": {},
      "size": "string",
      "x": 0.1,
      "y": 0.1,
      "width": 0.1,
      "height": 0.1,
      "left": 0.1,
      "top": 0.1,
      "right": 0.1,
      "bottom": 0.1,
      "isEmpty": true
    },
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "name": "string",
    "parentBlock": {
      "id": 0,
      "name": "string",
      "href": "string"
    },
    "isVisible": true,
    "version": {
      "rowVersion": 0
    }
  }
]
[{"details":"string","elements":"string","type":"Block","calculationType":"Mathematical","comment":"string","elementId":0,"parentBlockId":0,"bounds":{"location":{},"size":"string","x":0.1,"y":0.1,"width":0.1,"height":0.1,"left":0.1,"top":0.1,"right":0.1,"bottom":0.1,"isEmpty":true},"color":{"a":0,"b":0,"g":0,"r":0},"name":"string","parentBlock":{"id":0,"name":"string","href":"string"},"isVisible":true,"version":{"rowVersion":0}}]

Culture

Get supported culture.

Responses

Status

Meaning

Description

Schema

200

OK

Success

string

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/culture", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/culture");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/culture',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/culture', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/culture',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
"string"
"string"

Get all supported culture.

Responses

Status

Meaning

Description

Schema

200

OK

Success

string

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/cultures", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/cultures");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/cultures',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/cultures', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/cultures',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
"string"
"string"

CustomColor

Get all custom colors for user.

Responses

Status

Meaning

Description

Schema

200

OK

Get all custom colors for user.

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Composer.CustomColorDTO]

false

none

none

» colors

[string]¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/customcolor", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customcolor");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/customcolor',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/customcolor', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/customcolor',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "colors": [
      "string"
    ]
  }
]
[{"colors":["string"]}]

Update saved custom colors for user.

Body parameter

{
  "colors": [
    "string"
  ]
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Composer.CustomColorDTO

false

none

» colors

body

[string]¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Update saved custom colors for user.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/customcolor", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customcolor");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "colors": [
    "string"
  ]
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/customcolor',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/customcolor', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/customcolor',
  params: {
  }, headers: headers

p JSON.parse(result)

Custom Table

Get extened table column information

Parameters

Name

In

Type

Required

Description

customTableName

path

string

true

none

inputFormId

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.ExtendedTableColumnInfoDTO]

false

none

none

» columnType

string

false

none

none

» id

integer(int32)

false

none

none

» tableName

string¦null

false

none

none

» columnName

string¦null

false

none

none

» order

integer(int32)

false

none

none

» type

string

false

none

none

» lookupColumn

Varicent.RESTAPI.v1.DTOs.ExtendedTableLookupColumnInfoDTO

false

none

none

»» lookupTable

string¦null

false

none

none

»» lookupColumnName

string¦null

false

none

none

»» lookupColumnMappings

[Varicent.RESTAPI.v1.DTOs.ExtendedTableLookupColumnMappingInfoDTO]¦null

false

none

none

»»» sourceColumn

string¦null

false

none

none

»»» destinationColumn

string¦null

false

none

none

»»» operator

string¦null

false

none

none

»»» sourceColumnTypeCast

string¦null

false

none

none

»»» destinationColumnTypeCast

string¦null

false

none

none

»»» matchCase

boolean

false

none

none

» calculatedColumn

Varicent.RESTAPI.v1.DTOs.ExtendedTableCalculatedColumnInfoDTO

false

none

none

»» formula

string¦null

false

none

none

Enumerated Values

Property

Value

columnType

Calc

columnType

Lookup

type

String

type

LongString

type

MaxString

type

Date

type

DateTime

type

Decimal

type

Int

type

Long

type

Float

type

BLOB

type

Identity

type

CLOB

type

RowVersion

type

UID

type

VarCharMax

type

Boolean

sourceColumnTypeCast

Text

sourceColumnTypeCast

Date

sourceColumnTypeCast

List

sourceColumnTypeCast

Numeric

sourceColumnTypeCast

Email

sourceColumnTypeCast

Url

sourceColumnTypeCast

Comment

sourceColumnTypeCast

DateTime

destinationColumnTypeCast

Text

destinationColumnTypeCast

Date

destinationColumnTypeCast

List

destinationColumnTypeCast

Numeric

destinationColumnTypeCast

Email

destinationColumnTypeCast

Url

destinationColumnTypeCast

Comment

destinationColumnTypeCast

DateTime

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/internal/customtables/{customTableName}/{inputFormId}/getextendedcolumns", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/customtables/{customTableName}/{inputFormId}/getextendedcolumns");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/customtables/{customTableName}/{inputFormId}/getextendedcolumns',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/internal/customtables/{customTableName}/{inputFormId}/getextendedcolumns', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/internal/customtables/{customTableName}/{inputFormId}/getextendedcolumns',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "columnType": "Calc",
    "id": 0,
    "tableName": "string",
    "columnName": "string",
    "order": 0,
    "type": "String",
    "lookupColumn": {
      "lookupTable": "string",
      "lookupColumnName": "string",
      "lookupColumnMappings": []
    },
    "calculatedColumn": {
      "formula": "string"
    }
  }
]
[{"columnType":"Calc","id":0,"tableName":"string","columnName":"string","order":0,"type":"String","lookupColumn":{"lookupTable":"string","lookupColumnName":"string","lookupColumnMappings":[]},"calculatedColumn":{"formula":"string"}}]

Add a lookup column to custom table

Body parameter

{
  "type": "String",
  "id": 0,
  "order": 0,
  "columnName": "string",
  "lookupTable": "string",
  "lookupColumn": "string",
  "lookupColumnMappings": [
    {
      "sourceColumn": "string",
      "destinationColumn": "string",
      "operator": "string",
      "sourceColumnTypeCast": "Text",
      "destinationColumnTypeCast": "Text",
      "matchCase": true
    }
  ]
}

Parameters

Name

In

Type

Required

Description

customTableName

path

string

true

none

inputFormId

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.LookupColumnDTO

false

none

» type

body

string¦null

false

none

» id

body

integer(int32)¦null

false

none

» order

body

integer(int32)¦null

false

none

» columnName

body

string¦null

false

none

» lookupTable

body

string¦null

false

none

» lookupColumn

body

string¦null

false

none

» lookupColumnMappings

body

[Varicent.RESTAPI.v1.DTOs.LookupColumnMappingDTO]¦null

false

none

»» sourceColumn

body

string¦null

false

none

»» destinationColumn

body

string¦null

false

none

»» operator

body

string¦null

false

none

»» sourceColumnTypeCast

body

string¦null

false

none

»» destinationColumnTypeCast

body

string¦null

false

none

»» matchCase

body

boolean

false

none

Enumerated Values

Parameter

Value

» type

String

» type

LongString

» type

MaxString

» type

Date

» type

DateTime

» type

Decimal

» type

Int

» type

Long

» type

Float

» type

BLOB

» type

Identity

» type

CLOB

» type

RowVersion

» type

UID

» type

VarCharMax

» type

Boolean

»» sourceColumnTypeCast

Text

»» sourceColumnTypeCast

Date

»» sourceColumnTypeCast

List

»» sourceColumnTypeCast

Numeric

»» sourceColumnTypeCast

Email

»» sourceColumnTypeCast

Url

»» sourceColumnTypeCast

Comment

»» sourceColumnTypeCast

DateTime

»» destinationColumnTypeCast

Text

»» destinationColumnTypeCast

Date

»» destinationColumnTypeCast

List

»» destinationColumnTypeCast

Numeric

»» destinationColumnTypeCast

Email

»» destinationColumnTypeCast

Url

»» destinationColumnTypeCast

Comment

»» destinationColumnTypeCast

DateTime

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/internal/customtables/{customTableName}/{inputFormId}/addlookupcolumn", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/customtables/{customTableName}/{inputFormId}/addlookupcolumn");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "type": "String",
  "id": 0,
  "order": 0,
  "columnName": "string",
  "lookupTable": "string",
  "lookupColumn": "string",
  "lookupColumnMappings": [
    {
      "sourceColumn": "string",
      "destinationColumn": "string",
      "operator": "string",
      "sourceColumnTypeCast": "Text",
      "destinationColumnTypeCast": "Text",
      "matchCase": true
    }
  ]
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/internal/customtables/{customTableName}/{inputFormId}/addlookupcolumn',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/internal/customtables/{customTableName}/{inputFormId}/addlookupcolumn', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/internal/customtables/{customTableName}/{inputFormId}/addlookupcolumn',
  params: {
  }, headers: headers

p JSON.parse(result)

Edit a lookup column in custom table

Body parameter

{
  "type": "String",
  "id": 0,
  "order": 0,
  "columnName": "string",
  "lookupTable": "string",
  "lookupColumn": "string",
  "lookupColumnMappings": [
    {
      "sourceColumn": "string",
      "destinationColumn": "string",
      "operator": "string",
      "sourceColumnTypeCast": "Text",
      "destinationColumnTypeCast": "Text",
      "matchCase": true
    }
  ]
}

Parameters

Name

In

Type

Required

Description

customTableName

path

string

true

none

inputFormId

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.LookupColumnDTO

false

none

» type

body

string¦null

false

none

» id

body

integer(int32)¦null

false

none

» order

body

integer(int32)¦null

false

none

» columnName

body

string¦null

false

none

» lookupTable

body

string¦null

false

none

» lookupColumn

body

string¦null

false

none

» lookupColumnMappings

body

[Varicent.RESTAPI.v1.DTOs.LookupColumnMappingDTO]¦null

false

none

»» sourceColumn

body

string¦null

false

none

»» destinationColumn

body

string¦null

false

none

»» operator

body

string¦null

false

none

»» sourceColumnTypeCast

body

string¦null

false

none

»» destinationColumnTypeCast

body

string¦null

false

none

»» matchCase

body

boolean

false

none

Enumerated Values

Parameter

Value

» type

String

» type

LongString

» type

MaxString

» type

Date

» type

DateTime

» type

Decimal

» type

Int

» type

Long

» type

Float

» type

BLOB

» type

Identity

» type

CLOB

» type

RowVersion

» type

UID

» type

VarCharMax

» type

Boolean

»» sourceColumnTypeCast

Text

»» sourceColumnTypeCast

Date

»» sourceColumnTypeCast

List

»» sourceColumnTypeCast

Numeric

»» sourceColumnTypeCast

Email

»» sourceColumnTypeCast

Url

»» sourceColumnTypeCast

Comment

»» sourceColumnTypeCast

DateTime

»» destinationColumnTypeCast

Text

»» destinationColumnTypeCast

Date

»» destinationColumnTypeCast

List

»» destinationColumnTypeCast

Numeric

»» destinationColumnTypeCast

Email

»» destinationColumnTypeCast

Url

»» destinationColumnTypeCast

Comment

»» destinationColumnTypeCast

DateTime

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/internal/customtables/{customTableName}/{inputFormId}/editlookupcolumn", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/customtables/{customTableName}/{inputFormId}/editlookupcolumn");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "type": "String",
  "id": 0,
  "order": 0,
  "columnName": "string",
  "lookupTable": "string",
  "lookupColumn": "string",
  "lookupColumnMappings": [
    {
      "sourceColumn": "string",
      "destinationColumn": "string",
      "operator": "string",
      "sourceColumnTypeCast": "Text",
      "destinationColumnTypeCast": "Text",
      "matchCase": true
    }
  ]
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/internal/customtables/{customTableName}/{inputFormId}/editlookupcolumn',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.put('http://localhost:8080/api/internal/customtables/{customTableName}/{inputFormId}/editlookupcolumn', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/internal/customtables/{customTableName}/{inputFormId}/editlookupcolumn',
  params: {
  }, headers: headers

p JSON.parse(result)

Add a calculated column to custom table

Body parameter

{
  "type": "String",
  "id": 0,
  "order": 0,
  "columnName": "string",
  "formula": "string"
}

Parameters

Name

In

Type

Required

Description

customTableName

path

string

true

none

inputFormId

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.CalculatedColumnDTO

false

none

» type

body

string¦null

false

none

» id

body

integer(int32)¦null

false

none

» order

body

integer(int32)¦null

false

none

» columnName

body

string¦null

false

none

» formula

body

string¦null

false

none

Enumerated Values

Parameter

Value

» type

String

» type

LongString

» type

MaxString

» type

Date

» type

DateTime

» type

Decimal

» type

Int

» type

Long

» type

Float

» type

BLOB

» type

Identity

» type

CLOB

» type

RowVersion

» type

UID

» type

VarCharMax

» type

Boolean

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/internal/customtables/{customTableName}/{inputFormId}/addcalculatedcolumn", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/customtables/{customTableName}/{inputFormId}/addcalculatedcolumn");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "type": "String",
  "id": 0,
  "order": 0,
  "columnName": "string",
  "formula": "string"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/internal/customtables/{customTableName}/{inputFormId}/addcalculatedcolumn',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/internal/customtables/{customTableName}/{inputFormId}/addcalculatedcolumn', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/internal/customtables/{customTableName}/{inputFormId}/addcalculatedcolumn',
  params: {
  }, headers: headers

p JSON.parse(result)

Edit a calculated column on a custom table

Body parameter

{
  "type": "String",
  "id": 0,
  "order": 0,
  "columnName": "string",
  "formula": "string"
}

Parameters

Name

In

Type

Required

Description

customTableName

path

string

true

none

inputFormId

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.CalculatedColumnDTO

false

none

» type

body

string¦null

false

none

» id

body

integer(int32)¦null

false

none

» order

body

integer(int32)¦null

false

none

» columnName

body

string¦null

false

none

» formula

body

string¦null

false

none

Enumerated Values

Parameter

Value

» type

String

» type

LongString

» type

MaxString

» type

Date

» type

DateTime

» type

Decimal

» type

Int

» type

Long

» type

Float

» type

BLOB

» type

Identity

» type

CLOB

» type

RowVersion

» type

UID

» type

VarCharMax

» type

Boolean

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/internal/customtables/{customTableName}/{inputFormId}/editcalculatedcolumn", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/customtables/{customTableName}/{inputFormId}/editcalculatedcolumn");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "type": "String",
  "id": 0,
  "order": 0,
  "columnName": "string",
  "formula": "string"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/internal/customtables/{customTableName}/{inputFormId}/editcalculatedcolumn',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.put('http://localhost:8080/api/internal/customtables/{customTableName}/{inputFormId}/editcalculatedcolumn', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/internal/customtables/{customTableName}/{inputFormId}/editcalculatedcolumn',
  params: {
  }, headers: headers

p JSON.parse(result)

Delete a lookup column from custom table

Parameters

Name

In

Type

Required

Description

customTableName

path

string

true

none

inputFormId

path

integer(int32)

true

none

columnId

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/internal/customtables/{customTableName}/{inputFormId}/{columnId}/deleteextendedcolumn", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/customtables/{customTableName}/{inputFormId}/{columnId}/deleteextendedcolumn");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/internal/customtables/{customTableName}/{inputFormId}/{columnId}/deleteextendedcolumn',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/internal/customtables/{customTableName}/{inputFormId}/{columnId}/deleteextendedcolumn')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/internal/customtables/{customTableName}/{inputFormId}/{columnId}/deleteextendedcolumn',
  params: {
  }

p JSON.parse(result)

Get custom tables for the data module landing page.

Parameters

Name

In

Type

Required

Description

limit

query

integer(int32)

false

none

offset

query

integer(int32)

false

none

filter

query

string

false

####Supported operations

orderBy

query

string

false

####Description

Detailed descriptions

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

name

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

name

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.DataModuleTableRowsDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/internal/datamoduletables", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/datamoduletables");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/datamoduletables',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/internal/datamoduletables', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/internal/datamoduletables',
  params: {
  }, headers: headers

p JSON.parse(result)

Get custom tables.

Parameters

Name

In

Type

Required

Description

filter

query

string

false

####Supported operations

orderBy

query

string

false

####Description

Detailed descriptions

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

name, tabletype, parentblockid, isGlobal

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

name, isHistoryEnabled

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Composer.CustomTableElementDTO]

false

none

none

» table

Varicent.RESTAPI.v1.DTOs.CustomTableDTO

false

none

none

»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»» rowVersion

integer(int64)

false

none

none

»» name

string¦null

false

none

none

»» tableType

string

false

none

none

»» effectiveDated

boolean

false

none

none

»» workflowObjectID

integer(int32)

false

none

none

»» hierarchyMetadata

RESTAPI.v1.DTOs.Hierarchy.HierarchyMetadataDTO

false

none

none

»»» tableName

string¦null

false

none

none

»»» idColumnName

string¦null

false

none

none

»»» parentColumnName

string¦null

false

none

none

»» lastUpdatedTracking

boolean¦null

false

none

none

» isWebEnabled

boolean

false

none

none

» isHistoryEnabled

boolean

false

none

none

» comment

string¦null

false

none

none

» isGlobal

boolean

false

none

none

» isWebDataViewable

boolean

false

none

none

» elementId

integer(int32)

false

none

none

» parentBlockId

integer(int32)¦null

false

none

none

» bounds

System.Drawing.RectangleF

false

none

none

»» location

System.Drawing.PointF

false

none

none

»»» isEmpty

boolean

false

read-only

none

»»» x

number(float)

false

none

none

»»» y

number(float)

false

none

none

»» size

string

false

none

none

»» x

number(float)

false

none

none

»» y

number(float)

false

none

none

»» width

number(float)

false

none

none

»» height

number(float)

false

none

none

»» left

number(float)

false

read-only

none

»» top

number(float)

false

read-only

none

»» right

number(float)

false

read-only

none

»» bottom

number(float)

false

read-only

none

»» isEmpty

boolean

false

read-only

none

» color

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

none

»» a

integer(int32)

false

none

none

»» b

integer(int32)

false

none

none

»» g

integer(int32)

false

none

none

»» r

integer(int32)

false

none

none

» name

string¦null

false

none

none

» parentBlock

Varicent.RESTAPI.v1.DTOs.Composer.ExpandableBlockElementDTO

false

none

none

»» id

integer(int32)

false

none

none

»» name

string¦null

false

none

none

»» href

string¦null

false

none

none

» isVisible

boolean

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

tableType

System

tableType

Dimension

tableType

Structural

tableType

Lookup

tableType

Data

tableType

View

tableType

Custom

tableType

StarSchema

tableType

ExportTable

tableType

CreditingRule

tableType

AssignTable

tableType

PlcmCustomTable

tableType

PlcmStructuralTable

tableType

PlcmTable

tableType

DataSource

tableType

Cached

tableType

MaterializedView

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/customtables", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtables");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/customtables',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/customtables', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/customtables',
  params: {
  }, headers: headers

p JSON.parse(result)

Creates a new custom table.

Body parameter

{
  "table": {
    "table": {
      "version": {},
      "name": "string",
      "tableType": "System",
      "effectiveDated": true,
      "workflowObjectID": 0,
      "hierarchyMetadata": {},
      "lastUpdatedTracking": true
    },
    "columns": [
      {}
    ],
    "time": {
      "timeId": "string",
      "dateColumn": "string",
      "lockedOn": {},
      "min": {},
      "max": {}
    }
  },
  "tableAdditionalData": {},
  "comment": "string",
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Composer.TableElementDTO

false

The table definition wrapped in its element definition

» table

body

Varicent.RESTAPI.v1.DTOs.TableDefinitionDTO

false

none

»» table

body

Varicent.RESTAPI.v1.DTOs.CustomTableDTO

false

none

»»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»» rowVersion

body

integer(int64)

false

none

»»» name

body

string¦null

false

none

»»» tableType

body

string

false

none

»»» effectiveDated

body

boolean

false

none

»»» workflowObjectID

body

integer(int32)

false

none

»»» hierarchyMetadata

body

RESTAPI.v1.DTOs.Hierarchy.HierarchyMetadataDTO

false

none

»»»» tableName

body

string¦null

false

none

»»»» idColumnName

body

string¦null

false

none

»»»» parentColumnName

body

string¦null

false

none

»»» lastUpdatedTracking

body

boolean¦null

false

none

»» columns

body

[Varicent.RESTAPI.v1.DTOs.ColumnDefinitionDTO]¦null

false

none

»»» column

body

Varicent.RESTAPI.v1.DTOs.CustomColumnDTO

false

none

»»»» name

body

string¦null

false

none

»»»» type

body

string

false

none

»»»» referencedTable

body

string¦null

false

none

»»»» referencedName

body

string¦null

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»»»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»»»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»»»»» alias

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» customSelect

body

string¦null

false

none

»»»»»»» dataType

body

string

false

none

»»»»»»» type

body

string

false

none

»»»»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»»»» constraintType

body

string

false

none

»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»» condition

body

any

false

none

»»»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»»»» literalType

body

string

false

none

»»»»»»»»»»» value

body

any

false

none

»»»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»»»» constraints

body

array¦null

false

none

»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»» literalRight

body

any

false

none

»»»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»» right

body

any

false

none

»»»»»»»»»» expressionLeft

body

any

false

none

»»»»»»»»»» expressionRight

body

any

false

none

»»»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»»»» like

body

string¦null

false

none

»»»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»» literalType

body

string

false

none

»»»»»»»»» value

body

any

false

none

»»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»»»»» m_namespace

body

string¦null

false

none

»»»»»»»» name

body

string¦null

false

none

»»»»»»» query

body

any

false

none

»»»»»»» alias

body

string¦null

false

none

»»»»»»» sourceType

body

string

false

none

»»»»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»»» joinType

body

string

false

none

»»»»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»»»» constraintType

body

string

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»» like

body

string¦null

false

none

»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» direction

body

string

false

none

»»»»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»» distinct

body

boolean

false

none

»»»»»» unionWith

body

any

false

none

»»»»»» exceptWith

body

any

false

none

»»»»» sourceNames

body

object¦null

false

none

»»»»»» additionalProperties

body

string¦null

false

none

»»»» pickListParams

body

[Varicent.RESTAPI.v1.DTOs.PickListParamDTO]¦null

false

none

»»»»» joinAlias

body

string¦null

false

none

»»»»» joinColumn

body

string¦null

false

none

»»»»» op

body

string

false

none

»»»» isKey

body

boolean

false

none

»»» isRemovable

body

boolean

false

none

»»» isNullable

body

boolean

false

none

»»» referencedColumn

body

string¦null

false

none

»» time

body

Varicent.RESTAPI.v1.DTOs.TableTimeDTO

false

none

»»» timeId

body

string¦null

false

none

»»» dateColumn

body

string¦null

false

none

»»» lockedOn

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»»» min

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»»» max

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

» tableAdditionalData

body

Varicent.RESTAPI.v1.DTOs.IExpandableResourceDTO

false

none

» comment

body

string¦null

false

none

» elementId

body

integer(int32)

false

none

» parentBlockId

body

integer(int32)¦null

false

none

» bounds

body

System.Drawing.RectangleF

false

none

»» location

body

System.Drawing.PointF

false

none

»»» isEmpty

body

boolean

false

none

»»» x

body

number(float)

false

none

»»» y

body

number(float)

false

none

»» size

body

string

false

none

»» x

body

number(float)

false

none

»» y

body

number(float)

false

none

»» width

body

number(float)

false

none

»» height

body

number(float)

false

none

»» left

body

number(float)

false

none

»» top

body

number(float)

false

none

»» right

body

number(float)

false

none

»» bottom

body

number(float)

false

none

»» isEmpty

body

boolean

false

none

» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»» a

body

integer(int32)

false

none

»» b

body

integer(int32)

false

none

»» g

body

integer(int32)

false

none

»» r

body

integer(int32)

false

none

» name

body

string¦null

false

none

» parentBlock

body

Varicent.RESTAPI.v1.DTOs.Composer.ExpandableBlockElementDTO

false

none

»» id

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» href

body

string¦null

false

none

» isVisible

body

boolean

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

»»» tableType

System

»»» tableType

Dimension

»»» tableType

Structural

»»» tableType

Lookup

»»» tableType

Data

»»» tableType

View

»»» tableType

Custom

»»» tableType

StarSchema

»»» tableType

ExportTable

»»» tableType

CreditingRule

»»» tableType

AssignTable

»»» tableType

PlcmCustomTable

»»» tableType

PlcmStructuralTable

»»» tableType

PlcmTable

»»» tableType

DataSource

»»» tableType

Cached

»»» tableType

MaterializedView

»»»» type

Text

»»»» type

Date

»»»» type

List

»»»» type

Numeric

»»»» type

Email

»»»» type

Url

»»»» type

Comment

»»»» type

DateTime

»»»»»»» dataType

Int

»»»»»»» dataType

Decimal

»»»»»»» dataType

DateTime

»»»»»»» dataType

None

»»»»»»» dataType

String

»»»»»»» type

SelectAll

»»»»»»» type

SelectItem

»»»»»»» type

SelectLiteral

»»»»»»» type

SelectCustom

»»»»»»» type

SelectExpression

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»»» expressionType

caseExpression

»»»»»»»»» expressionType

dataField

»»»»»»»»» expressionType

function

»»»»»»»»» expressionType

ifExpression

»»»»»»»»» expressionType

literal

»»»»»»»»»» constraintType

clause

»»»»»»»»»» constraintType

constraint

»»»»»»»»»» constraintType

expressionConstraint

»»»»»»»»»» constraintType

likeConstraint

»»»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»»»» constraintType

subQueryConstraint

»»»»»»»»»»» expressionType

caseExpression

»»»»»»»»»»» expressionType

dataField

»»»»»»»»»»» expressionType

function

»»»»»»»»»»» expressionType

ifExpression

»»»»»»»»»»» expressionType

literal

»»»»»»»»»»» literalType

Integer

»»»»»»»»»»» literalType

Decimal

»»»»»»»»»»» literalType

Date

»»»»»»»»»»» literalType

DateTime

»»»»»»»»»»» literalType

String

»»»»»»»»»»» literalType

Float

»»»»»»»»»»» literalType

Long

»»»»»»»»»»» literalType

Null

»»»»»»»»»»» literalType

Parameter

»»»»»»»»»»» literalType

Guid

»»»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»»»» literalType

Boolean

»»»»»»»»» literalType

Integer

»»»»»»»»» literalType

Decimal

»»»»»»»»» literalType

Date

»»»»»»»»» literalType

DateTime

»»»»»»»»» literalType

String

»»»»»»»»» literalType

Float

»»»»»»»»» literalType

Long

»»»»»»»»» literalType

Null

»»»»»»»»» literalType

Parameter

»»»»»»»»» literalType

Guid

»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»» literalType

Boolean

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»»» sourceType

Table

»»»»»»» sourceType

Query

»»»»»»» joinType

Inner

»»»»»»» joinType

Left

»»»»»»» joinType

Right

»»»»»»» joinType

Cross

»»»»»»» joinType

CrossApply

»»»»»»» joinType

OuterApply

»»»»»»»» constraintType

clause

»»»»»»»» constraintType

constraint

»»»»»»»» constraintType

expressionConstraint

»»»»»»»» constraintType

likeConstraint

»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»» constraintType

subQueryConstraint

»»»»»»» direction

Ascending

»»»»»»» direction

Descending

»»»»»»» direction

AscendingNullsFirst

»»»»»»» direction

DescendingNullsLast

»»»»» op

LessThan

»»»»» op

LessThanEquals

»»»»» op

Equals

»»»»» op

NotEquals

»»»»» op

GreaterThan

»»»»» op

GreaterThanEquals

»»»»» op

IsNull

»»»»» op

IsNotNull

»»»»» op

In

»»»»» op

NotIn

Responses

Status

Meaning

Description

Schema

201

Created

Newly-created table

Varicent.RESTAPI.v1.DTOs.Composer.TableElementDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/customtables", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtables");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "table": {
    "table": {
      "version": {},
      "name": "string",
      "tableType": "System",
      "effectiveDated": true,
      "workflowObjectID": 0,
      "hierarchyMetadata": {},
      "lastUpdatedTracking": true
    },
    "columns": [
      {}
    ],
    "time": {
      "timeId": "string",
      "dateColumn": "string",
      "lockedOn": {},
      "min": {},
      "max": {}
    }
  },
  "tableAdditionalData": {},
  "comment": "string",
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/customtables',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/customtables', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/customtables',
  params: {
  }, headers: headers

p JSON.parse(result)

Get custom tables compact DTO without permissions requirement.

Parameters

Name

In

Type

Required

Description

filter

query

string

false

####Supported operations

orderBy

query

string

false

####Description

limit

query

integer(int32)

false

none

offset

query

integer(int32)

false

none

Detailed descriptions

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

name, tabletype, parentblockid, isGlobal

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

name, isHistoryEnabled

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Composer.CustomTableCompactDTO]

false

none

none

» name

string¦null

false

none

none

» tableType

string

false

none

none

Enumerated Values

Property

Value

tableType

System

tableType

Dimension

tableType

Structural

tableType

Lookup

tableType

Data

tableType

View

tableType

Custom

tableType

StarSchema

tableType

ExportTable

tableType

CreditingRule

tableType

AssignTable

tableType

PlcmCustomTable

tableType

PlcmStructuralTable

tableType

PlcmTable

tableType

DataSource

tableType

Cached

tableType

MaterializedView

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/customtablescompact", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtablescompact");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/customtablescompact',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/customtablescompact', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/customtablescompact',
  params: {
  }, headers: headers

p JSON.parse(result)

Gets a table’s data source schema

Parameters

Name

In

Type

Required

Description

customTableName

path

string

true

Name of an existing custom table.

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.Composer.DataSourceSchemaDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/customtables/{customTableName}/datasourceschema", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtables/{customTableName}/datasourceschema");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/customtables/{customTableName}/datasourceschema',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/customtables/{customTableName}/datasourceschema', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/customtables/{customTableName}/datasourceschema',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "displayName": "string",
  "details": {
    "href": "string"
  },
  "type": "Table",
  "fullTableSchema": {
    "columns": [
      {}
    ],
    "table": "string",
    "name": "string",
    "referencedSources": [
      "string"
    ],
    "referencedTimes": [
      {}
    ],
    "referencedSourcesDictionary": {
      "property1": "string",
      "property2": "string"
    },
    "referencedTimesDictionary": {
      "property1": {},
      "property2": {}
    }
  },
  "tableDefinition": {
    "table": {
      "version": {},
      "name": "string",
      "tableType": "System",
      "effectiveDated": true,
      "workflowObjectID": 0,
      "hierarchyMetadata": {},
      "lastUpdatedTracking": true
    },
    "columns": [
      {}
    ],
    "time": {
      "timeId": "string",
      "dateColumn": "string",
      "lockedOn": {},
      "min": {},
      "max": {}
    }
  },
  "calculationDefinition": {
    "calculationId": 0,
    "calculationType": "Mathematical",
    "planBuilderCalculationId": "string"
  }
}
{"displayName":"string","details":{"href":"string"},"type":"Table","fullTableSchema":{"columns":[{}],"table":"string","name":"string","referencedSources":["string"],"referencedTimes":[{}],"referencedSourcesDictionary":{"property1":"string","property2":"string"},"referencedTimesDictionary":{"property1":{},"property2":{}}},"tableDefinition":{"table":{"version":{},"name":"string","tableType":"System","effectiveDated":true,"workflowObjectID":0,"hierarchyMetadata":{},"lastUpdatedTracking":true},"columns":[{}],"time":{"timeId":"string","dateColumn":"string","lockedOn":{},"min":{},"max":{}}},"calculationDefinition":{"calculationId":0,"calculationType":"Mathematical","planBuilderCalculationId":"string"}}

Get the full table schema and details of a custom table.

Parameters

Name

In

Type

Required

Description

customTableName

path

string

true

Name of an existing custom table.

expand

query

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.Composer.TableElementDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/customtables/{customTableName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtables/{customTableName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/customtables/{customTableName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/customtables/{customTableName}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/customtables/{customTableName}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "table": {
    "table": {
      "version": {},
      "name": "string",
      "tableType": "System",
      "effectiveDated": true,
      "workflowObjectID": 0,
      "hierarchyMetadata": {},
      "lastUpdatedTracking": true
    },
    "columns": [
      {}
    ],
    "time": {
      "timeId": "string",
      "dateColumn": "string",
      "lockedOn": {},
      "min": {},
      "max": {}
    }
  },
  "tableAdditionalData": {},
  "comment": "string",
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "isEmpty": true,
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1,
    "left": 0.1,
    "top": 0.1,
    "right": 0.1,
    "bottom": 0.1,
    "isEmpty": true
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}
{"table":{"table":{"version":{},"name":"string","tableType":"System","effectiveDated":true,"workflowObjectID":0,"hierarchyMetadata":{},"lastUpdatedTracking":true},"columns":[{}],"time":{"timeId":"string","dateColumn":"string","lockedOn":{},"min":{},"max":{}}},"tableAdditionalData":{},"comment":"string","elementId":0,"parentBlockId":0,"bounds":{"location":{"isEmpty":true,"x":0.1,"y":0.1},"size":"string","x":0.1,"y":0.1,"width":0.1,"height":0.1,"left":0.1,"top":0.1,"right":0.1,"bottom":0.1,"isEmpty":true},"color":{"a":0,"b":0,"g":0,"r":0},"name":"string","parentBlock":{"id":0,"name":"string","href":"string"},"isVisible":true,"version":{"rowVersion":0}}

Delete a table by name.

Body parameter

{
  "table": {
    "table": {
      "version": {},
      "name": "string",
      "tableType": "System",
      "effectiveDated": true,
      "workflowObjectID": 0,
      "hierarchyMetadata": {},
      "lastUpdatedTracking": true
    },
    "columns": [
      {}
    ],
    "time": {
      "timeId": "string",
      "dateColumn": "string",
      "lockedOn": {},
      "min": {},
      "max": {}
    }
  },
  "tableAdditionalData": {},
  "comment": "string",
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

customTableName

path

string

true

The name of an existing custom table.

body

body

Varicent.RESTAPI.v1.DTOs.Composer.TableElementDTO

false

none

» table

body

Varicent.RESTAPI.v1.DTOs.TableDefinitionDTO

false

none

»» table

body

Varicent.RESTAPI.v1.DTOs.CustomTableDTO

false

none

»»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»» rowVersion

body

integer(int64)

false

none

»»» name

body

string¦null

false

none

»»» tableType

body

string

false

none

»»» effectiveDated

body

boolean

false

none

»»» workflowObjectID

body

integer(int32)

false

none

»»» hierarchyMetadata

body

RESTAPI.v1.DTOs.Hierarchy.HierarchyMetadataDTO

false

none

»»»» tableName

body

string¦null

false

none

»»»» idColumnName

body

string¦null

false

none

»»»» parentColumnName

body

string¦null

false

none

»»» lastUpdatedTracking

body

boolean¦null

false

none

»» columns

body

[Varicent.RESTAPI.v1.DTOs.ColumnDefinitionDTO]¦null

false

none

»»» column

body

Varicent.RESTAPI.v1.DTOs.CustomColumnDTO

false

none

»»»» name

body

string¦null

false

none

»»»» type

body

string

false

none

»»»» referencedTable

body

string¦null

false

none

»»»» referencedName

body

string¦null

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»»»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»»»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»»»»» alias

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» customSelect

body

string¦null

false

none

»»»»»»» dataType

body

string

false

none

»»»»»»» type

body

string

false

none

»»»»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»»»» constraintType

body

string

false

none

»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»» condition

body

any

false

none

»»»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»»»» literalType

body

string

false

none

»»»»»»»»»»» value

body

any

false

none

»»»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»»»» constraints

body

array¦null

false

none

»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»» literalRight

body

any

false

none

»»»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»» right

body

any

false

none

»»»»»»»»»» expressionLeft

body

any

false

none

»»»»»»»»»» expressionRight

body

any

false

none

»»»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»»»» like

body

string¦null

false

none

»»»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»» literalType

body

string

false

none

»»»»»»»»» value

body

any

false

none

»»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»»»»» m_namespace

body

string¦null

false

none

»»»»»»»» name

body

string¦null

false

none

»»»»»»» query

body

any

false

none

»»»»»»» alias

body

string¦null

false

none

»»»»»»» sourceType

body

string

false

none

»»»»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»»» joinType

body

string

false

none

»»»»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»»»» constraintType

body

string

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»» like

body

string¦null

false

none

»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» direction

body

string

false

none

»»»»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»» distinct

body

boolean

false

none

»»»»»» unionWith

body

any

false

none

»»»»»» exceptWith

body

any

false

none

»»»»» sourceNames

body

object¦null

false

none

»»»»»» additionalProperties

body

string¦null

false

none

»»»» pickListParams

body

[Varicent.RESTAPI.v1.DTOs.PickListParamDTO]¦null

false

none

»»»»» joinAlias

body

string¦null

false

none

»»»»» joinColumn

body

string¦null

false

none

»»»»» op

body

string

false

none

»»»» isKey

body

boolean

false

none

»»» isRemovable

body

boolean

false

none

»»» isNullable

body

boolean

false

none

»»» referencedColumn

body

string¦null

false

none

»» time

body

Varicent.RESTAPI.v1.DTOs.TableTimeDTO

false

none

»»» timeId

body

string¦null

false

none

»»» dateColumn

body

string¦null

false

none

»»» lockedOn

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»»» min

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»»» max

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

» tableAdditionalData

body

Varicent.RESTAPI.v1.DTOs.IExpandableResourceDTO

false

none

» comment

body

string¦null

false

none

» elementId

body

integer(int32)

false

none

» parentBlockId

body

integer(int32)¦null

false

none

» bounds

body

System.Drawing.RectangleF

false

none

»» location

body

System.Drawing.PointF

false

none

»»» isEmpty

body

boolean

false

none

»»» x

body

number(float)

false

none

»»» y

body

number(float)

false

none

»» size

body

string

false

none

»» x

body

number(float)

false

none

»» y

body

number(float)

false

none

»» width

body

number(float)

false

none

»» height

body

number(float)

false

none

»» left

body

number(float)

false

none

»» top

body

number(float)

false

none

»» right

body

number(float)

false

none

»» bottom

body

number(float)

false

none

»» isEmpty

body

boolean

false

none

» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»» a

body

integer(int32)

false

none

»» b

body

integer(int32)

false

none

»» g

body

integer(int32)

false

none

»» r

body

integer(int32)

false

none

» name

body

string¦null

false

none

» parentBlock

body

Varicent.RESTAPI.v1.DTOs.Composer.ExpandableBlockElementDTO

false

none

»» id

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» href

body

string¦null

false

none

» isVisible

body

boolean

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

»»» tableType

System

»»» tableType

Dimension

»»» tableType

Structural

»»» tableType

Lookup

»»» tableType

Data

»»» tableType

View

»»» tableType

Custom

»»» tableType

StarSchema

»»» tableType

ExportTable

»»» tableType

CreditingRule

»»» tableType

AssignTable

»»» tableType

PlcmCustomTable

»»» tableType

PlcmStructuralTable

»»» tableType

PlcmTable

»»» tableType

DataSource

»»» tableType

Cached

»»» tableType

MaterializedView

»»»» type

Text

»»»» type

Date

»»»» type

List

»»»» type

Numeric

»»»» type

Email

»»»» type

Url

»»»» type

Comment

»»»» type

DateTime

»»»»»»» dataType

Int

»»»»»»» dataType

Decimal

»»»»»»» dataType

DateTime

»»»»»»» dataType

None

»»»»»»» dataType

String

»»»»»»» type

SelectAll

»»»»»»» type

SelectItem

»»»»»»» type

SelectLiteral

»»»»»»» type

SelectCustom

»»»»»»» type

SelectExpression

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»»» expressionType

caseExpression

»»»»»»»»» expressionType

dataField

»»»»»»»»» expressionType

function

»»»»»»»»» expressionType

ifExpression

»»»»»»»»» expressionType

literal

»»»»»»»»»» constraintType

clause

»»»»»»»»»» constraintType

constraint

»»»»»»»»»» constraintType

expressionConstraint

»»»»»»»»»» constraintType

likeConstraint

»»»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»»»» constraintType

subQueryConstraint

»»»»»»»»»»» expressionType

caseExpression

»»»»»»»»»»» expressionType

dataField

»»»»»»»»»»» expressionType

function

»»»»»»»»»»» expressionType

ifExpression

»»»»»»»»»»» expressionType

literal

»»»»»»»»»»» literalType

Integer

»»»»»»»»»»» literalType

Decimal

»»»»»»»»»»» literalType

Date

»»»»»»»»»»» literalType

DateTime

»»»»»»»»»»» literalType

String

»»»»»»»»»»» literalType

Float

»»»»»»»»»»» literalType

Long

»»»»»»»»»»» literalType

Null

»»»»»»»»»»» literalType

Parameter

»»»»»»»»»»» literalType

Guid

»»»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»»»» literalType

Boolean

»»»»»»»»» literalType

Integer

»»»»»»»»» literalType

Decimal

»»»»»»»»» literalType

Date

»»»»»»»»» literalType

DateTime

»»»»»»»»» literalType

String

»»»»»»»»» literalType

Float

»»»»»»»»» literalType

Long

»»»»»»»»» literalType

Null

»»»»»»»»» literalType

Parameter

»»»»»»»»» literalType

Guid

»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»» literalType

Boolean

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»»» sourceType

Table

»»»»»»» sourceType

Query

»»»»»»» joinType

Inner

»»»»»»» joinType

Left

»»»»»»» joinType

Right

»»»»»»» joinType

Cross

»»»»»»» joinType

CrossApply

»»»»»»» joinType

OuterApply

»»»»»»»» constraintType

clause

»»»»»»»» constraintType

constraint

»»»»»»»» constraintType

expressionConstraint

»»»»»»»» constraintType

likeConstraint

»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»» constraintType

subQueryConstraint

»»»»»»» direction

Ascending

»»»»»»» direction

Descending

»»»»»»» direction

AscendingNullsFirst

»»»»»»» direction

DescendingNullsLast

»»»»» op

LessThan

»»»»» op

LessThanEquals

»»»»» op

Equals

»»»»» op

NotEquals

»»»»» op

GreaterThan

»»»»» op

GreaterThanEquals

»»»»» op

IsNull

»»»»» op

IsNotNull

»»»»» op

In

»»»»» op

NotIn

Responses

Status

Meaning

Description

Schema

200

OK

Delete the table with the given table name

None

409

Conflict

List of dependents for this table

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/customtables/{customTableName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtables/{customTableName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "table": {
    "table": {
      "version": {},
      "name": "string",
      "tableType": "System",
      "effectiveDated": true,
      "workflowObjectID": 0,
      "hierarchyMetadata": {},
      "lastUpdatedTracking": true
    },
    "columns": [
      {}
    ],
    "time": {
      "timeId": "string",
      "dateColumn": "string",
      "lockedOn": {},
      "min": {},
      "max": {}
    }
  },
  "tableAdditionalData": {},
  "comment": "string",
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/customtables/{customTableName}',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.delete('http://localhost:8080/api/v1/customtables/{customTableName}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.delete 'http://localhost:8080/api/v1/customtables/{customTableName}',
  params: {
  }, headers: headers

p JSON.parse(result)

Get all available tables.

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.CustomTableDTO]

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

» name

string¦null

false

none

none

» tableType

string

false

none

none

» effectiveDated

boolean

false

none

none

» workflowObjectID

integer(int32)

false

none

none

» hierarchyMetadata

RESTAPI.v1.DTOs.Hierarchy.HierarchyMetadataDTO

false

none

none

»» tableName

string¦null

false

none

none

»» idColumnName

string¦null

false

none

none

»» parentColumnName

string¦null

false

none

none

» lastUpdatedTracking

boolean¦null

false

none

none

Enumerated Values

Property

Value

tableType

System

tableType

Dimension

tableType

Structural

tableType

Lookup

tableType

Data

tableType

View

tableType

Custom

tableType

StarSchema

tableType

ExportTable

tableType

CreditingRule

tableType

AssignTable

tableType

PlcmCustomTable

tableType

PlcmStructuralTable

tableType

PlcmTable

tableType

DataSource

tableType

Cached

tableType

MaterializedView

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/availabletables", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/availabletables");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/availabletables',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/availabletables', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/availabletables',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "version": {
      "rowVersion": 0
    },
    "name": "string",
    "tableType": "System",
    "effectiveDated": true,
    "workflowObjectID": 0,
    "hierarchyMetadata": {
      "tableName": "string",
      "idColumnName": "string",
      "parentColumnName": "string"
    },
    "lastUpdatedTracking": true
  }
]
[{"version":{"rowVersion":0},"name":"string","tableType":"System","effectiveDated":true,"workflowObjectID":0,"hierarchyMetadata":{"tableName":"string","idColumnName":"string","parentColumnName":"string"},"lastUpdatedTracking":true}]

Get an available table with given name.

Parameters

Name

In

Type

Required

Description

name

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.TableDefinitionDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/availabletables/{name}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/availabletables/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/availabletables/{name}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/availabletables/{name}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/availabletables/{name}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "table": {
    "version": {
      "rowVersion": 0
    },
    "name": "string",
    "tableType": "System",
    "effectiveDated": true,
    "workflowObjectID": 0,
    "hierarchyMetadata": {
      "tableName": "string",
      "idColumnName": "string",
      "parentColumnName": "string"
    },
    "lastUpdatedTracking": true
  },
  "columns": [
    {
      "column": {},
      "isRemovable": true,
      "isNullable": true,
      "referencedColumn": "string"
    }
  ],
  "time": {
    "timeId": "string",
    "dateColumn": "string",
    "lockedOn": {},
    "min": {},
    "max": {}
  }
}
{"table":{"version":{"rowVersion":0},"name":"string","tableType":"System","effectiveDated":true,"workflowObjectID":0,"hierarchyMetadata":{"tableName":"string","idColumnName":"string","parentColumnName":"string"},"lastUpdatedTracking":true},"columns":[{"column":{},"isRemovable":true,"isNullable":true,"referencedColumn":"string"}],"time":{"timeId":"string","dateColumn":"string","lockedOn":{},"min":{},"max":{}}}

Updates the table description and column definitions synchronously

Body parameter

{
  "description": "string",
  "table": {
    "version": {
      "rowVersion": 0
    },
    "name": "string",
    "tableType": "System",
    "effectiveDated": true,
    "workflowObjectID": 0,
    "hierarchyMetadata": {
      "tableName": "string",
      "idColumnName": "string",
      "parentColumnName": "string"
    },
    "lastUpdatedTracking": true
  },
  "columnChanges": [
    {
      "action": "Add",
      "customColumn": {}
    }
  ],
  "time": {
    "timeId": "string",
    "dateColumn": "string",
    "lockedOn": {},
    "min": {},
    "max": {}
  }
}

Parameters

Name

In

Type

Required

Description

table

path

string

true

Name of the table to patch

body

body

Varicent.RESTAPI.v1.DTOs.CustomTablePatchDTO

false

Contains an updated description and updated column schemas, or both.

» description

body

string¦null

false

none

» table

body

Varicent.RESTAPI.v1.DTOs.CustomTableDTO

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» rowVersion

body

integer(int64)

false

none

»» name

body

string¦null

false

none

»» tableType

body

string

false

none

»» effectiveDated

body

boolean

false

none

»» workflowObjectID

body

integer(int32)

false

none

»» hierarchyMetadata

body

RESTAPI.v1.DTOs.Hierarchy.HierarchyMetadataDTO

false

none

»»» tableName

body

string¦null

false

none

»»» idColumnName

body

string¦null

false

none

»»» parentColumnName

body

string¦null

false

none

»» lastUpdatedTracking

body

boolean¦null

false

none

» columnChanges

body

[Varicent.RESTAPI.v1.DTOs.ColumnActionDTO]¦null

false

none

»» action

body

string

false

none

»» customColumn

body

Varicent.RESTAPI.v1.DTOs.CustomColumnDTO

false

none

»»» name

body

string¦null

false

none

»»» type

body

string

false

none

»»» referencedTable

body

string¦null

false

none

»»» referencedName

body

string¦null

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»»»» alias

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» customSelect

body

string¦null

false

none

»»»»»» dataType

body

string

false

none

»»»»»» type

body

string

false

none

»»»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»» expressionType

body

string

false

none

»»»»»»» cases

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»»» constraintType

body

string

false

none

»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»» condition

body

any

false

none

»»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»»» literalType

body

string

false

none

»»»»»»»»»» value

body

any

false

none

»»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»»» constraints

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»» literalRight

body

any

false

none

»»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»» right

body

any

false

none

»»»»»»»»» expressionLeft

body

any

false

none

»»»»»»»»» expressionRight

body

any

false

none

»»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»»» like

body

string¦null

false

none

»»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»»»» trueValue

body

any

false

none

»»»»»»»» falseValue

body

any

false

none

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» isDate

body

boolean

false

none

»»»»»»» literalType

body

string

false

none

»»»»»»» value

body

any

false

none

»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»»»» m_namespace

body

string¦null

false

none

»»»»»»» name

body

string¦null

false

none

»»»»»» query

body

any

false

none

»»»»»» alias

body

string¦null

false

none

»»»»»» sourceType

body

string

false

none

»»»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»» joinType

body

string

false

none

»»»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»»» constraintType

body

string

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»» like

body

string¦null

false

none

»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» queryDefinitionRight

body

any

false

none

»»»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» direction

body

string

false

none

»»»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» distinct

body

boolean

false

none

»»»»» unionWith

body

any

false

none

»»»»» exceptWith

body

any

false

none

»»»» sourceNames

body

object¦null

false

none

»»»»» additionalProperties

body

string¦null

false

none

»»» pickListParams

body

[Varicent.RESTAPI.v1.DTOs.PickListParamDTO]¦null

false

none

»»»» joinAlias

body

string¦null

false

none

»»»» joinColumn

body

string¦null

false

none

»»»» op

body

string

false

none

»»» isKey

body

boolean

false

none

» time

body

Varicent.RESTAPI.v1.DTOs.TableTimeDTO

false

none

»» timeId

body

string¦null

false

none

»» dateColumn

body

string¦null

false

none

»» lockedOn

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»» min

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»» max

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

Detailed descriptions

body: Contains an updated description and updated column schemas, or both. Note that the table name and table version cannot be omitted.

Enumerated Values

Parameter

Value

»» tableType

System

»» tableType

Dimension

»» tableType

Structural

»» tableType

Lookup

»» tableType

Data

»» tableType

View

»» tableType

Custom

»» tableType

StarSchema

»» tableType

ExportTable

»» tableType

CreditingRule

»» tableType

AssignTable

»» tableType

PlcmCustomTable

»» tableType

PlcmStructuralTable

»» tableType

PlcmTable

»» tableType

DataSource

»» tableType

Cached

»» tableType

MaterializedView

»» action

Add

»» action

Remove

»» action

Edit

»»» type

Text

»»» type

Date

»»» type

List

»»» type

Numeric

»»» type

Email

»»» type

Url

»»» type

Comment

»»» type

DateTime

»»»»»» dataType

Int

»»»»»» dataType

Decimal

»»»»»» dataType

DateTime

»»»»»» dataType

None

»»»»»» dataType

String

»»»»»» type

SelectAll

»»»»»» type

SelectItem

»»»»»» type

SelectLiteral

»»»»»» type

SelectCustom

»»»»»» type

SelectExpression

»»»»»»» expressionType

caseExpression

»»»»»»» expressionType

dataField

»»»»»»» expressionType

function

»»»»»»» expressionType

ifExpression

»»»»»»» expressionType

literal

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»»» constraintType

clause

»»»»»»»»» constraintType

constraint

»»»»»»»»» constraintType

expressionConstraint

»»»»»»»»» constraintType

likeConstraint

»»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»»» constraintType

subQueryConstraint

»»»»»»»»»» expressionType

caseExpression

»»»»»»»»»» expressionType

dataField

»»»»»»»»»» expressionType

function

»»»»»»»»»» expressionType

ifExpression

»»»»»»»»»» expressionType

literal

»»»»»»»»»» literalType

Integer

»»»»»»»»»» literalType

Decimal

»»»»»»»»»» literalType

Date

»»»»»»»»»» literalType

DateTime

»»»»»»»»»» literalType

String

»»»»»»»»»» literalType

Float

»»»»»»»»»» literalType

Long

»»»»»»»»»» literalType

Null

»»»»»»»»»» literalType

Parameter

»»»»»»»»»» literalType

Guid

»»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»»» literalType

Boolean

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»»» literalType

Integer

»»»»»»» literalType

Decimal

»»»»»»» literalType

Date

»»»»»»» literalType

DateTime

»»»»»»» literalType

String

»»»»»»» literalType

Float

»»»»»»» literalType

Long

»»»»»»» literalType

Null

»»»»»»» literalType

Parameter

»»»»»»» literalType

Guid

»»»»»»» literalType

SystemUtcTime

»»»»»»» literalType

Boolean

»»»»»» sourceType

Table

»»»»»» sourceType

Query

»»»»»» joinType

Inner

»»»»»» joinType

Left

»»»»»» joinType

Right

»»»»»» joinType

Cross

»»»»»» joinType

CrossApply

»»»»»» joinType

OuterApply

»»»»»»» constraintType

clause

»»»»»»» constraintType

constraint

»»»»»»» constraintType

expressionConstraint

»»»»»»» constraintType

likeConstraint

»»»»»»» constraintType

rowVersionConstraint

»»»»»»» constraintType

subQueryConstraint

»»»»»» direction

Ascending

»»»»»» direction

Descending

»»»»»» direction

AscendingNullsFirst

»»»»»» direction

DescendingNullsLast

»»»» op

LessThan

»»»» op

LessThanEquals

»»»» op

Equals

»»»» op

NotEquals

»»»» op

GreaterThan

»»»» op

GreaterThanEquals

»»»» op

IsNull

»»»» op

IsNotNull

»»»» op

In

»»»» op

NotIn

Responses

Status

Meaning

Description

Schema

200

OK

Table modification was successful.

Varicent.RESTAPI.v1.DTOs.Composer.CustomTableElementDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/customtables/{table}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtables/{table}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "description": "string",
  "table": {
    "version": {
      "rowVersion": 0
    },
    "name": "string",
    "tableType": "System",
    "effectiveDated": true,
    "workflowObjectID": 0,
    "hierarchyMetadata": {
      "tableName": "string",
      "idColumnName": "string",
      "parentColumnName": "string"
    },
    "lastUpdatedTracking": true
  },
  "columnChanges": [
    {
      "action": "Add",
      "customColumn": {}
    }
  ],
  "time": {
    "timeId": "string",
    "dateColumn": "string",
    "lockedOn": {},
    "min": {},
    "max": {}
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/customtables/{table}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/customtables/{table}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/customtables/{table}',
  params: {
  }, headers: headers

p JSON.parse(result)

Updates the table description and column definitions asynchronously

Body parameter

{
  "description": "string",
  "table": {
    "version": {
      "rowVersion": 0
    },
    "name": "string",
    "tableType": "System",
    "effectiveDated": true,
    "workflowObjectID": 0,
    "hierarchyMetadata": {
      "tableName": "string",
      "idColumnName": "string",
      "parentColumnName": "string"
    },
    "lastUpdatedTracking": true
  },
  "columnChanges": [
    {
      "action": "Add",
      "customColumn": {}
    }
  ],
  "time": {
    "timeId": "string",
    "dateColumn": "string",
    "lockedOn": {},
    "min": {},
    "max": {}
  }
}

Parameters

Name

In

Type

Required

Description

table

path

string

true

Name of the table to patch

body

body

Varicent.RESTAPI.v1.DTOs.CustomTablePatchDTO

false

Contains an updated description

» description

body

string¦null

false

none

» table

body

Varicent.RESTAPI.v1.DTOs.CustomTableDTO

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» rowVersion

body

integer(int64)

false

none

»» name

body

string¦null

false

none

»» tableType

body

string

false

none

»» effectiveDated

body

boolean

false

none

»» workflowObjectID

body

integer(int32)

false

none

»» hierarchyMetadata

body

RESTAPI.v1.DTOs.Hierarchy.HierarchyMetadataDTO

false

none

»»» tableName

body

string¦null

false

none

»»» idColumnName

body

string¦null

false

none

»»» parentColumnName

body

string¦null

false

none

»» lastUpdatedTracking

body

boolean¦null

false

none

» columnChanges

body

[Varicent.RESTAPI.v1.DTOs.ColumnActionDTO]¦null

false

none

»» action

body

string

false

none

»» customColumn

body

Varicent.RESTAPI.v1.DTOs.CustomColumnDTO

false

none

»»» name

body

string¦null

false

none

»»» type

body

string

false

none

»»» referencedTable

body

string¦null

false

none

»»» referencedName

body

string¦null

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»»»» alias

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» customSelect

body

string¦null

false

none

»»»»»» dataType

body

string

false

none

»»»»»» type

body

string

false

none

»»»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»» expressionType

body

string

false

none

»»»»»»» cases

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»»» constraintType

body

string

false

none

»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»» condition

body

any

false

none

»»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»»» literalType

body

string

false

none

»»»»»»»»»» value

body

any

false

none

»»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»»» constraints

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»» literalRight

body

any

false

none

»»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»» right

body

any

false

none

»»»»»»»»» expressionLeft

body

any

false

none

»»»»»»»»» expressionRight

body

any

false

none

»»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»»» like

body

string¦null

false

none

»»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»»»» trueValue

body

any

false

none

»»»»»»»» falseValue

body

any

false

none

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» isDate

body

boolean

false

none

»»»»»»» literalType

body

string

false

none

»»»»»»» value

body

any

false

none

»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»»»» m_namespace

body

string¦null

false

none

»»»»»»» name

body

string¦null

false

none

»»»»»» query

body

any

false

none

»»»»»» alias

body

string¦null

false

none

»»»»»» sourceType

body

string

false

none

»»»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»» joinType

body

string

false

none

»»»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»»» constraintType

body

string

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»» like

body

string¦null

false

none

»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» queryDefinitionRight

body

any

false

none

»»»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» direction

body

string

false

none

»»»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» distinct

body

boolean

false

none

»»»»» unionWith

body

any

false

none

»»»»» exceptWith

body

any

false

none

»»»» sourceNames

body

object¦null

false

none

»»»»» additionalProperties

body

string¦null

false

none

»»» pickListParams

body

[Varicent.RESTAPI.v1.DTOs.PickListParamDTO]¦null

false

none

»»»» joinAlias

body

string¦null

false

none

»»»» joinColumn

body

string¦null

false

none

»»»» op

body

string

false

none

»»» isKey

body

boolean

false

none

» time

body

Varicent.RESTAPI.v1.DTOs.TableTimeDTO

false

none

»» timeId

body

string¦null

false

none

»» dateColumn

body

string¦null

false

none

»» lockedOn

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»» min

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»» max

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

Detailed descriptions

body: Contains an updated description DOES NOT contain an updated column schema as updating schema is now a long running action Note that the table name and table version cannot be omitted.

Enumerated Values

Parameter

Value

»» tableType

System

»» tableType

Dimension

»» tableType

Structural

»» tableType

Lookup

»» tableType

Data

»» tableType

View

»» tableType

Custom

»» tableType

StarSchema

»» tableType

ExportTable

»» tableType

CreditingRule

»» tableType

AssignTable

»» tableType

PlcmCustomTable

»» tableType

PlcmStructuralTable

»» tableType

PlcmTable

»» tableType

DataSource

»» tableType

Cached

»» tableType

MaterializedView

»» action

Add

»» action

Remove

»» action

Edit

»»» type

Text

»»» type

Date

»»» type

List

»»» type

Numeric

»»» type

Email

»»» type

Url

»»» type

Comment

»»» type

DateTime

»»»»»» dataType

Int

»»»»»» dataType

Decimal

»»»»»» dataType

DateTime

»»»»»» dataType

None

»»»»»» dataType

String

»»»»»» type

SelectAll

»»»»»» type

SelectItem

»»»»»» type

SelectLiteral

»»»»»» type

SelectCustom

»»»»»» type

SelectExpression

»»»»»»» expressionType

caseExpression

»»»»»»» expressionType

dataField

»»»»»»» expressionType

function

»»»»»»» expressionType

ifExpression

»»»»»»» expressionType

literal

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»»» constraintType

clause

»»»»»»»»» constraintType

constraint

»»»»»»»»» constraintType

expressionConstraint

»»»»»»»»» constraintType

likeConstraint

»»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»»» constraintType

subQueryConstraint

»»»»»»»»»» expressionType

caseExpression

»»»»»»»»»» expressionType

dataField

»»»»»»»»»» expressionType

function

»»»»»»»»»» expressionType

ifExpression

»»»»»»»»»» expressionType

literal

»»»»»»»»»» literalType

Integer

»»»»»»»»»» literalType

Decimal

»»»»»»»»»» literalType

Date

»»»»»»»»»» literalType

DateTime

»»»»»»»»»» literalType

String

»»»»»»»»»» literalType

Float

»»»»»»»»»» literalType

Long

»»»»»»»»»» literalType

Null

»»»»»»»»»» literalType

Parameter

»»»»»»»»»» literalType

Guid

»»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»»» literalType

Boolean

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»»» literalType

Integer

»»»»»»» literalType

Decimal

»»»»»»» literalType

Date

»»»»»»» literalType

DateTime

»»»»»»» literalType

String

»»»»»»» literalType

Float

»»»»»»» literalType

Long

»»»»»»» literalType

Null

»»»»»»» literalType

Parameter

»»»»»»» literalType

Guid

»»»»»»» literalType

SystemUtcTime

»»»»»»» literalType

Boolean

»»»»»» sourceType

Table

»»»»»» sourceType

Query

»»»»»» joinType

Inner

»»»»»» joinType

Left

»»»»»» joinType

Right

»»»»»» joinType

Cross

»»»»»» joinType

CrossApply

»»»»»» joinType

OuterApply

»»»»»»» constraintType

clause

»»»»»»» constraintType

constraint

»»»»»»» constraintType

expressionConstraint

»»»»»»» constraintType

likeConstraint

»»»»»»» constraintType

rowVersionConstraint

»»»»»»» constraintType

subQueryConstraint

»»»»»» direction

Ascending

»»»»»» direction

Descending

»»»»»» direction

AscendingNullsFirst

»»»»»» direction

DescendingNullsLast

»»»» op

LessThan

»»»» op

LessThanEquals

»»»» op

Equals

»»»» op

NotEquals

»»»» op

GreaterThan

»»»» op

GreaterThanEquals

»»»» op

IsNull

»»»» op

IsNotNull

»»»» op

In

»»»» op

NotIn

Responses

Status

Meaning

Description

Schema

200

OK

Table modification started.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/customtables/{table}/async", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtables/{table}/async");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "description": "string",
  "table": {
    "version": {
      "rowVersion": 0
    },
    "name": "string",
    "tableType": "System",
    "effectiveDated": true,
    "workflowObjectID": 0,
    "hierarchyMetadata": {
      "tableName": "string",
      "idColumnName": "string",
      "parentColumnName": "string"
    },
    "lastUpdatedTracking": true
  },
  "columnChanges": [
    {
      "action": "Add",
      "customColumn": {}
    }
  ],
  "time": {
    "timeId": "string",
    "dateColumn": "string",
    "lockedOn": {},
    "min": {},
    "max": {}
  }
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/customtables/{table}/async',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/customtables/{table}/async', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/customtables/{table}/async',
  params: {
  }, headers: headers

p JSON.parse(result)

Check if column has dependencies.

Parameters

Name

In

Type

Required

Description

table

path

string

true

Name of custom table.

column

path

string

true

Name of column

Responses

Status

Meaning

Description

Schema

200

OK

Check if column has dependencies.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/customtables/{table}/dependencies/{column}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtables/{table}/dependencies/{column}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/customtables/{table}/dependencies/{column}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.get('http://localhost:8080/api/v1/customtables/{table}/dependencies/{column}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.get 'http://localhost:8080/api/v1/customtables/{table}/dependencies/{column}',
  params: {
  }

p JSON.parse(result)

Updates the source definition of the given view.

Body parameter

{
  "query": {
    "selectItems": [
      {}
    ],
    "source": {
      "namespaceTable": {},
      "query": null,
      "alias": "string",
      "sourceType": "Table"
    },
    "joins": [
      {}
    ],
    "whereClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "order": [
      {}
    ],
    "group": [
      {}
    ],
    "havingClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "distinct": true,
    "unionWith": null,
    "exceptWith": null
  },
  "sourceNames": {
    "property1": "string",
    "property2": "string"
  }
}

Parameters

Name

In

Type

Required

Description

name

path

string

true

The name of the view to update.

body

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

The definition of the view source.

» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»» alias

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» table

body

string¦null

false

none

»»» customSelect

body

string¦null

false

none

»»» dataType

body

string

false

none

»»» type

body

string

false

none

»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» expressionType

body

string

false

none

»»»» cases

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» op

body

string¦null

false

none

»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»» constraintType

body

string

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» expressionType

body

string

false

none

»»»»»»» cases

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» arguments

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» condition

body

any

false

none

»»»»»»» trueValue

body

any

false

none

»»»»»»» falseValue

body

any

false

none

»»»»»»» isDate

body

boolean

false

none

»»»»»»» literalType

body

string

false

none

»»»»»»» value

body

any

false

none

»»»»»» caseSensitive

body

boolean

false

none

»»»»»» constraints

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» literalRight

body

any

false

none

»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»» right

body

any

false

none

»»»»»» expressionLeft

body

any

false

none

»»»»»» expressionRight

body

any

false

none

»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»» like

body

string¦null

false

none

»»»»»» escapeWildcards

body

boolean

false

none

»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» queryDefinitionRight

body

any

false

none

»»»»» trueValue

body

any

false

none

»»»»» falseValue

body

any

false

none

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» isDate

body

boolean

false

none

»»»» literalType

body

string

false

none

»»»» value

body

any

false

none

»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»» m_namespace

body

string¦null

false

none

»»»» name

body

string¦null

false

none

»»» query

body

any

false

none

»»» alias

body

string¦null

false

none

»»» sourceType

body

string

false

none

»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»» joinType

body

string

false

none

»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»» constraintType

body

string

false

none

»»»» op

body

string¦null

false

none

»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» caseSensitive

body

boolean

false

none

»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» isPreciseDecimal

body

boolean

false

none

»»»» like

body

string¦null

false

none

»»»» escapeWildcards

body

boolean

false

none

»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»» table

body

string¦null

false

none

»»»» queryDefinitionRight

body

any

false

none

»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» direction

body

string

false

none

»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» distinct

body

boolean

false

none

»» unionWith

body

any

false

none

»» exceptWith

body

any

false

none

» sourceNames

body

object¦null

false

none

»» additionalProperties

body

string¦null

false

none

Enumerated Values

Parameter

Value

»»» dataType

Int

»»» dataType

Decimal

»»» dataType

DateTime

»»» dataType

None

»»» dataType

String

»»» type

SelectAll

»»» type

SelectItem

»»» type

SelectLiteral

»»» type

SelectCustom

»»» type

SelectExpression

»»»» expressionType

caseExpression

»»»» expressionType

dataField

»»»» expressionType

function

»»»» expressionType

ifExpression

»»»» expressionType

literal

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» constraintType

clause

»»»»»» constraintType

constraint

»»»»»» constraintType

expressionConstraint

»»»»»» constraintType

likeConstraint

»»»»»» constraintType

rowVersionConstraint

»»»»»» constraintType

subQueryConstraint

»»»»»»» expressionType

caseExpression

»»»»»»» expressionType

dataField

»»»»»»» expressionType

function

»»»»»»» expressionType

ifExpression

»»»»»»» expressionType

literal

»»»»»»» literalType

Integer

»»»»»»» literalType

Decimal

»»»»»»» literalType

Date

»»»»»»» literalType

DateTime

»»»»»»» literalType

String

»»»»»»» literalType

Float

»»»»»»» literalType

Long

»»»»»»» literalType

Null

»»»»»»» literalType

Parameter

»»»»»»» literalType

Guid

»»»»»»» literalType

SystemUtcTime

»»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» literalType

Integer

»»»» literalType

Decimal

»»»» literalType

Date

»»»» literalType

DateTime

»»»» literalType

String

»»»» literalType

Float

»»»» literalType

Long

»»»» literalType

Null

»»»» literalType

Parameter

»»»» literalType

Guid

»»»» literalType

SystemUtcTime

»»»» literalType

Boolean

»»» sourceType

Table

»»» sourceType

Query

»»» joinType

Inner

»»» joinType

Left

»»» joinType

Right

»»» joinType

Cross

»»» joinType

CrossApply

»»» joinType

OuterApply

»»»» constraintType

clause

»»»» constraintType

constraint

»»»» constraintType

expressionConstraint

»»»» constraintType

likeConstraint

»»»» constraintType

rowVersionConstraint

»»»» constraintType

subQueryConstraint

»»» direction

Ascending

»»» direction

Descending

»»» direction

AscendingNullsFirst

»»» direction

DescendingNullsLast

Responses

Status

Meaning

Description

Schema

200

OK

View modification was successful.

Varicent.RESTAPI.v1.DTOs.TableDefinitionDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/views/{name}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/views/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "query": {
    "selectItems": [
      {}
    ],
    "source": {
      "namespaceTable": {},
      "query": null,
      "alias": "string",
      "sourceType": "Table"
    },
    "joins": [
      {}
    ],
    "whereClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "order": [
      {}
    ],
    "group": [
      {}
    ],
    "havingClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "distinct": true,
    "unionWith": null,
    "exceptWith": null
  },
  "sourceNames": {
    "property1": "string",
    "property2": "string"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/views/{name}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/views/{name}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/views/{name}',
  params: {
  }, headers: headers

p JSON.parse(result)

Returns the view definition.

Parameters

Name

In

Type

Required

Description

name

path

string

true

none

Responses

Status

Meaning

Description

Schema

201

Created

Get view definition

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/views/{name}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/views/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/views/{name}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/views/{name}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/views/{name}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "query": {
    "selectItems": [
      {}
    ],
    "source": {
      "namespaceTable": {},
      "query": null,
      "alias": "string",
      "sourceType": "Table"
    },
    "joins": [
      {}
    ],
    "whereClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "order": [
      {}
    ],
    "group": [
      {}
    ],
    "havingClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "distinct": true,
    "unionWith": null,
    "exceptWith": null
  },
  "sourceNames": {
    "property1": "string",
    "property2": "string"
  }
}
{"query":{"selectItems":[{}],"source":{"namespaceTable":{},"query":null,"alias":"string","sourceType":"Table"},"joins":[{}],"whereClause":{"constraintType":"clause","op":"string","dataFieldLeft":{},"caseSensitive":true,"constraints":[],"literalRight":{},"dataFieldRight":{},"right":{},"expressionLeft":{},"expressionRight":{},"isPreciseDecimal":true,"like":"string","escapeWildcards":true,"rowVersion":{},"table":"string","queryDefinitionRight":null},"order":[{}],"group":[{}],"havingClause":{"constraintType":"clause","op":"string","dataFieldLeft":{},"caseSensitive":true,"constraints":[],"literalRight":{},"dataFieldRight":{},"right":{},"expressionLeft":{},"expressionRight":{},"isPreciseDecimal":true,"like":"string","escapeWildcards":true,"rowVersion":{},"table":"string","queryDefinitionRight":null},"distinct":true,"unionWith":null,"exceptWith":null},"sourceNames":{"property1":"string","property2":"string"}}

CustomTablesControllerV1_PutMaterializedViews

Body parameter

{
  "query": {
    "selectItems": [
      {}
    ],
    "source": {
      "namespaceTable": {},
      "query": null,
      "alias": "string",
      "sourceType": "Table"
    },
    "joins": [
      {}
    ],
    "whereClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "order": [
      {}
    ],
    "group": [
      {}
    ],
    "havingClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "distinct": true,
    "unionWith": null,
    "exceptWith": null
  },
  "sourceNames": {
    "property1": "string",
    "property2": "string"
  }
}

Parameters

Name

In

Type

Required

Description

name

path

string

true

none

body

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»» alias

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» table

body

string¦null

false

none

»»» customSelect

body

string¦null

false

none

»»» dataType

body

string

false

none

»»» type

body

string

false

none

»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» expressionType

body

string

false

none

»»»» cases

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» op

body

string¦null

false

none

»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»» constraintType

body

string

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» expressionType

body

string

false

none

»»»»»»» cases

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» arguments

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» condition

body

any

false

none

»»»»»»» trueValue

body

any

false

none

»»»»»»» falseValue

body

any

false

none

»»»»»»» isDate

body

boolean

false

none

»»»»»»» literalType

body

string

false

none

»»»»»»» value

body

any

false

none

»»»»»» caseSensitive

body

boolean

false

none

»»»»»» constraints

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» literalRight

body

any

false

none

»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»» right

body

any

false

none

»»»»»» expressionLeft

body

any

false

none

»»»»»» expressionRight

body

any

false

none

»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»» like

body

string¦null

false

none

»»»»»» escapeWildcards

body

boolean

false

none

»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» queryDefinitionRight

body

any

false

none

»»»»» trueValue

body

any

false

none

»»»»» falseValue

body

any

false

none

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» isDate

body

boolean

false

none

»»»» literalType

body

string

false

none

»»»» value

body

any

false

none

»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»» m_namespace

body

string¦null

false

none

»»»» name

body

string¦null

false

none

»»» query

body

any

false

none

»»» alias

body

string¦null

false

none

»»» sourceType

body

string

false

none

»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»» joinType

body

string

false

none

»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»» constraintType

body

string

false

none

»»»» op

body

string¦null

false

none

»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» caseSensitive

body

boolean

false

none

»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» isPreciseDecimal

body

boolean

false

none

»»»» like

body

string¦null

false

none

»»»» escapeWildcards

body

boolean

false

none

»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»» table

body

string¦null

false

none

»»»» queryDefinitionRight

body

any

false

none

»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» direction

body

string

false

none

»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» distinct

body

boolean

false

none

»» unionWith

body

any

false

none

»» exceptWith

body

any

false

none

» sourceNames

body

object¦null

false

none

»» additionalProperties

body

string¦null

false

none

Enumerated Values

Parameter

Value

»»» dataType

Int

»»» dataType

Decimal

»»» dataType

DateTime

»»» dataType

None

»»» dataType

String

»»» type

SelectAll

»»» type

SelectItem

»»» type

SelectLiteral

»»» type

SelectCustom

»»» type

SelectExpression

»»»» expressionType

caseExpression

»»»» expressionType

dataField

»»»» expressionType

function

»»»» expressionType

ifExpression

»»»» expressionType

literal

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» constraintType

clause

»»»»»» constraintType

constraint

»»»»»» constraintType

expressionConstraint

»»»»»» constraintType

likeConstraint

»»»»»» constraintType

rowVersionConstraint

»»»»»» constraintType

subQueryConstraint

»»»»»»» expressionType

caseExpression

»»»»»»» expressionType

dataField

»»»»»»» expressionType

function

»»»»»»» expressionType

ifExpression

»»»»»»» expressionType

literal

»»»»»»» literalType

Integer

»»»»»»» literalType

Decimal

»»»»»»» literalType

Date

»»»»»»» literalType

DateTime

»»»»»»» literalType

String

»»»»»»» literalType

Float

»»»»»»» literalType

Long

»»»»»»» literalType

Null

»»»»»»» literalType

Parameter

»»»»»»» literalType

Guid

»»»»»»» literalType

SystemUtcTime

»»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» literalType

Integer

»»»» literalType

Decimal

»»»» literalType

Date

»»»» literalType

DateTime

»»»» literalType

String

»»»» literalType

Float

»»»» literalType

Long

»»»» literalType

Null

»»»» literalType

Parameter

»»»» literalType

Guid

»»»» literalType

SystemUtcTime

»»»» literalType

Boolean

»»» sourceType

Table

»»» sourceType

Query

»»» joinType

Inner

»»» joinType

Left

»»» joinType

Right

»»» joinType

Cross

»»» joinType

CrossApply

»»» joinType

OuterApply

»»»» constraintType

clause

»»»» constraintType

constraint

»»»» constraintType

expressionConstraint

»»»» constraintType

likeConstraint

»»»» constraintType

rowVersionConstraint

»»»» constraintType

subQueryConstraint

»»» direction

Ascending

»»» direction

Descending

»»» direction

AscendingNullsFirst

»»» direction

DescendingNullsLast

Responses

Status

Meaning

Description

Schema

202

Accepted

Started materialized view update process

Inline

Response Schema

Status Code 202

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/materializedviews/{name}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/materializedviews/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "query": {
    "selectItems": [
      {}
    ],
    "source": {
      "namespaceTable": {},
      "query": null,
      "alias": "string",
      "sourceType": "Table"
    },
    "joins": [
      {}
    ],
    "whereClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "order": [
      {}
    ],
    "group": [
      {}
    ],
    "havingClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "distinct": true,
    "unionWith": null,
    "exceptWith": null
  },
  "sourceNames": {
    "property1": "string",
    "property2": "string"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/materializedviews/{name}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/materializedviews/{name}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/materializedviews/{name}',
  params: {
  }, headers: headers

p JSON.parse(result)

CustomTablesControllerV1_GetMaterializedView

Parameters

Name

In

Type

Required

Description

name

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.MaterializedViewDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/materializedviews/{name}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/materializedviews/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/materializedviews/{name}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/materializedviews/{name}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/materializedviews/{name}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "viewName": "string",
  "lastRefreshed": "2019-08-24T14:15:22Z"
}
{"viewName":"string","lastRefreshed":"2019-08-24T14:15:22Z"}

CustomTablesControllerV1_ViewsPost

Body parameter

{
  "source": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Composer.CreatedViewElementDTO

false

none

» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»» alias

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» table

body

string¦null

false

none

»»»» customSelect

body

string¦null

false

none

»»»» dataType

body

string

false

none

»»»» type

body

string

false

none

»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»» expressionType

body

string

false

none

»»»»»» cases

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» arguments

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»» constraintType

body

string

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» condition

body

any

false

none

»»»»»»»» trueValue

body

any

false

none

»»»»»»»» falseValue

body

any

false

none

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»» constraints

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» literalRight

body

any

false

none

»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» right

body

any

false

none

»»»»»»» expressionLeft

body

any

false

none

»»»»»»» expressionRight

body

any

false

none

»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»» like

body

string¦null

false

none

»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»» trueValue

body

any

false

none

»»»»»» falseValue

body

any

false

none

»»»»»» isDate

body

boolean

false

none

»»»»»» literalType

body

string

false

none

»»»»»» value

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»» m_namespace

body

string¦null

false

none

»»»»» name

body

string¦null

false

none

»»»» query

body

any

false

none

»»»» alias

body

string¦null

false

none

»»»» sourceType

body

string

false

none

»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» joinType

body

string

false

none

»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» constraintType

body

string

false

none

»»»»» op

body

string¦null

false

none

»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» caseSensitive

body

boolean

false

none

»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isPreciseDecimal

body

boolean

false

none

»»»»» like

body

string¦null

false

none

»»»»» escapeWildcards

body

boolean

false

none

»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»» table

body

string¦null

false

none

»»»»» queryDefinitionRight

body

any

false

none

»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» direction

body

string

false

none

»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» distinct

body

boolean

false

none

»»» unionWith

body

any

false

none

»»» exceptWith

body

any

false

none

»» sourceNames

body

object¦null

false

none

»»» additionalProperties

body

string¦null

false

none

» elementId

body

integer(int32)

false

none

» parentBlockId

body

integer(int32)¦null

false

none

» bounds

body

System.Drawing.RectangleF

false

none

»» location

body

System.Drawing.PointF

false

none

»»» isEmpty

body

boolean

false

none

»»» x

body

number(float)

false

none

»»» y

body

number(float)

false

none

»» size

body

string

false

none

»» x

body

number(float)

false

none

»» y

body

number(float)

false

none

»» width

body

number(float)

false

none

»» height

body

number(float)

false

none

»» left

body

number(float)

false

none

»» top

body

number(float)

false

none

»» right

body

number(float)

false

none

»» bottom

body

number(float)

false

none

»» isEmpty

body

boolean

false

none

» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»» a

body

integer(int32)

false

none

»» b

body

integer(int32)

false

none

»» g

body

integer(int32)

false

none

»» r

body

integer(int32)

false

none

» name

body

string¦null

false

none

» parentBlock

body

Varicent.RESTAPI.v1.DTOs.Composer.ExpandableBlockElementDTO

false

none

»» id

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» href

body

string¦null

false

none

» isVisible

body

boolean

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

»»»» dataType

Int

»»»» dataType

Decimal

»»»» dataType

DateTime

»»»» dataType

None

»»»» dataType

String

»»»» type

SelectAll

»»»» type

SelectItem

»»»» type

SelectLiteral

»»»» type

SelectCustom

»»»» type

SelectExpression

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» expressionType

caseExpression

»»»»»» expressionType

dataField

»»»»»» expressionType

function

»»»»»» expressionType

ifExpression

»»»»»» expressionType

literal

»»»»»»» constraintType

clause

»»»»»»» constraintType

constraint

»»»»»»» constraintType

expressionConstraint

»»»»»»» constraintType

likeConstraint

»»»»»»» constraintType

rowVersionConstraint

»»»»»»» constraintType

subQueryConstraint

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»» literalType

Integer

»»»»»» literalType

Decimal

»»»»»» literalType

Date

»»»»»» literalType

DateTime

»»»»»» literalType

String

»»»»»» literalType

Float

»»»»»» literalType

Long

»»»»»» literalType

Null

»»»»»» literalType

Parameter

»»»»»» literalType

Guid

»»»»»» literalType

SystemUtcTime

»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» sourceType

Table

»»»» sourceType

Query

»»»» joinType

Inner

»»»» joinType

Left

»»»» joinType

Right

»»»» joinType

Cross

»»»» joinType

CrossApply

»»»» joinType

OuterApply

»»»»» constraintType

clause

»»»»» constraintType

constraint

»»»»» constraintType

expressionConstraint

»»»»» constraintType

likeConstraint

»»»»» constraintType

rowVersionConstraint

»»»»» constraintType

subQueryConstraint

»»»» direction

Ascending

»»»» direction

Descending

»»»» direction

AscendingNullsFirst

»»»» direction

DescendingNullsLast

Responses

Status

Meaning

Description

Schema

201

Created

Newly-created view

Varicent.RESTAPI.v1.DTOs.Composer.TableElementDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/views", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/views");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "source": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/views',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/views', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/views',
  params: {
  }, headers: headers

p JSON.parse(result)

CustomTablesControllerV1_ViewsConvert

Parameters

Name

In

Type

Required

Description

name

path

string

true

none

Responses

Status

Meaning

Description

Schema

202

Accepted

Started materialized view conversion process

Inline

Response Schema

Status Code 202

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/views/{name}/convert", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/views/{name}/convert");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/views/{name}/convert',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/views/{name}/convert', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/views/{name}/convert',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "property1": "string",
  "property2": "string"
}
{"property1":"string","property2":"string"}

CustomTablesControllerV1_MaterializedViewsPost

Body parameter

{
  "source": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Composer.CreatedViewElementDTO

false

none

» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»» alias

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» table

body

string¦null

false

none

»»»» customSelect

body

string¦null

false

none

»»»» dataType

body

string

false

none

»»»» type

body

string

false

none

»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»» expressionType

body

string

false

none

»»»»»» cases

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» arguments

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»» constraintType

body

string

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» condition

body

any

false

none

»»»»»»»» trueValue

body

any

false

none

»»»»»»»» falseValue

body

any

false

none

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»» constraints

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» literalRight

body

any

false

none

»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» right

body

any

false

none

»»»»»»» expressionLeft

body

any

false

none

»»»»»»» expressionRight

body

any

false

none

»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»» like

body

string¦null

false

none

»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»» trueValue

body

any

false

none

»»»»»» falseValue

body

any

false

none

»»»»»» isDate

body

boolean

false

none

»»»»»» literalType

body

string

false

none

»»»»»» value

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»» m_namespace

body

string¦null

false

none

»»»»» name

body

string¦null

false

none

»»»» query

body

any

false

none

»»»» alias

body

string¦null

false

none

»»»» sourceType

body

string

false

none

»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» joinType

body

string

false

none

»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» constraintType

body

string

false

none

»»»»» op

body

string¦null

false

none

»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» caseSensitive

body

boolean

false

none

»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isPreciseDecimal

body

boolean

false

none

»»»»» like

body

string¦null

false

none

»»»»» escapeWildcards

body

boolean

false

none

»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»» table

body

string¦null

false

none

»»»»» queryDefinitionRight

body

any

false

none

»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» direction

body

string

false

none

»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» distinct

body

boolean

false

none

»»» unionWith

body

any

false

none

»»» exceptWith

body

any

false

none

»» sourceNames

body

object¦null

false

none

»»» additionalProperties

body

string¦null

false

none

» elementId

body

integer(int32)

false

none

» parentBlockId

body

integer(int32)¦null

false

none

» bounds

body

System.Drawing.RectangleF

false

none

»» location

body

System.Drawing.PointF

false

none

»»» isEmpty

body

boolean

false

none

»»» x

body

number(float)

false

none

»»» y

body

number(float)

false

none

»» size

body

string

false

none

»» x

body

number(float)

false

none

»» y

body

number(float)

false

none

»» width

body

number(float)

false

none

»» height

body

number(float)

false

none

»» left

body

number(float)

false

none

»» top

body

number(float)

false

none

»» right

body

number(float)

false

none

»» bottom

body

number(float)

false

none

»» isEmpty

body

boolean

false

none

» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»» a

body

integer(int32)

false

none

»» b

body

integer(int32)

false

none

»» g

body

integer(int32)

false

none

»» r

body

integer(int32)

false

none

» name

body

string¦null

false

none

» parentBlock

body

Varicent.RESTAPI.v1.DTOs.Composer.ExpandableBlockElementDTO

false

none

»» id

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» href

body

string¦null

false

none

» isVisible

body

boolean

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

»»»» dataType

Int

»»»» dataType

Decimal

»»»» dataType

DateTime

»»»» dataType

None

»»»» dataType

String

»»»» type

SelectAll

»»»» type

SelectItem

»»»» type

SelectLiteral

»»»» type

SelectCustom

»»»» type

SelectExpression

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» expressionType

caseExpression

»»»»»» expressionType

dataField

»»»»»» expressionType

function

»»»»»» expressionType

ifExpression

»»»»»» expressionType

literal

»»»»»»» constraintType

clause

»»»»»»» constraintType

constraint

»»»»»»» constraintType

expressionConstraint

»»»»»»» constraintType

likeConstraint

»»»»»»» constraintType

rowVersionConstraint

»»»»»»» constraintType

subQueryConstraint

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»» literalType

Integer

»»»»»» literalType

Decimal

»»»»»» literalType

Date

»»»»»» literalType

DateTime

»»»»»» literalType

String

»»»»»» literalType

Float

»»»»»» literalType

Long

»»»»»» literalType

Null

»»»»»» literalType

Parameter

»»»»»» literalType

Guid

»»»»»» literalType

SystemUtcTime

»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» sourceType

Table

»»»» sourceType

Query

»»»» joinType

Inner

»»»» joinType

Left

»»»» joinType

Right

»»»» joinType

Cross

»»»» joinType

CrossApply

»»»» joinType

OuterApply

»»»»» constraintType

clause

»»»»» constraintType

constraint

»»»»» constraintType

expressionConstraint

»»»»» constraintType

likeConstraint

»»»»» constraintType

rowVersionConstraint

»»»»» constraintType

subQueryConstraint

»»»» direction

Ascending

»»»» direction

Descending

»»»» direction

AscendingNullsFirst

»»»» direction

DescendingNullsLast

Responses

Status

Meaning

Description

Schema

202

Accepted

Started materialized view creation process

Inline

Response Schema

Status Code 202

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/materializedviews", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/materializedviews");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "source": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/materializedviews',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/materializedviews', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/materializedviews',
  params: {
  }, headers: headers

p JSON.parse(result)

CustomTablesControllerV1_MaterializedViewsConvert

Parameters

Name

In

Type

Required

Description

name

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

view converted

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/materializedviews/{name}/convert", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/materializedviews/{name}/convert");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/materializedviews/{name}/convert',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/v1/materializedviews/{name}/convert')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/v1/materializedviews/{name}/convert',
  params: {
  }

p JSON.parse(result)

CustomTablesControllerV1_MaterializedViewsRefresh

Parameters

Name

In

Type

Required

Description

name

path

string

true

none

Responses

Status

Meaning

Description

Schema

202

Accepted

Started materialized view refresh process

Inline

Response Schema

Status Code 202

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/materializedviews/{name}/refresh", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/materializedviews/{name}/refresh");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/materializedviews/{name}/refresh',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/materializedviews/{name}/refresh', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/materializedviews/{name}/refresh',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "property1": "string",
  "property2": "string"
}
{"property1":"string","property2":"string"}

Get all column references.

Parameters

Name

In

Type

Required

Description

tableName

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get all column references

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

[Varicent.RESTAPI.v1.DTOs.ReferenceOptionDTO]

false

none

none

»» type

string

false

none

none

»» referencedColumn

string¦null

false

none

none

»» isJumpTo

boolean

false

none

none

»» tabName

string¦null

false

none

none

»» referencedInputFormName

string¦null

false

none

none

»» referencedInputFormId

integer(int32)

false

none

none

»» referencedTable

string¦null

false

none

none

Enumerated Values

Property

Value

type

ReferenceOptionInputForm

type

ReferenceOptionTable

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/customtables/{tableName}/references", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtables/{tableName}/references");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/customtables/{tableName}/references',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/customtables/{tableName}/references', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/customtables/{tableName}/references',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "property1": [
    {
      "type": "ReferenceOptionInputForm",
      "referencedColumn": "string",
      "isJumpTo": true,
      "tabName": "string",
      "referencedInputFormName": "string",
      "referencedInputFormId": 0,
      "referencedTable": "string"
    }
  ],
  "property2": [
    {
      "type": "ReferenceOptionInputForm",
      "referencedColumn": "string",
      "isJumpTo": true,
      "tabName": "string",
      "referencedInputFormName": "string",
      "referencedInputFormId": 0,
      "referencedTable": "string"
    }
  ]
}
{"property1":[{"type":"ReferenceOptionInputForm","referencedColumn":"string","isJumpTo":true,"tabName":"string","referencedInputFormName":"string","referencedInputFormId":0,"referencedTable":"string"}],"property2":[{"type":"ReferenceOptionInputForm","referencedColumn":"string","isJumpTo":true,"tabName":"string","referencedInputFormName":"string","referencedInputFormId":0,"referencedTable":"string"}]}

Get all column default values.

Parameters

Name

In

Type

Required

Description

tableName

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get all column default values

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

[any]

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/customtables/{tableName}/defaultvalues", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtables/{tableName}/defaultvalues");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/customtables/{tableName}/defaultvalues',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/customtables/{tableName}/defaultvalues', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/customtables/{tableName}/defaultvalues',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "property1": [
    null
  ],
  "property2": [
    null
  ]
}
{"property1":[null],"property2":[null]}

Delete all rows from a given table.

Parameters

Name

In

Type

Required

Description

table

path

string

true

Custom table name

Responses

Status

Meaning

Description

Schema

202

Accepted

Table clear started.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/customtables/{table}/data", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtables/{table}/data");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/customtables/{table}/data',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/customtables/{table}/data')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/customtables/{table}/data',
  params: {
  }

p JSON.parse(result)

Get all elements that use a specific table.

Parameters

Name

In

Type

Required

Description

tablename

path

string

true

none

includeELTDependents

query

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Get all elements that use a specific global table with/without ELT dependents

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/customtables/{tablename}/dependents", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtables/{tablename}/dependents");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/customtables/{tablename}/dependents',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/customtables/{tablename}/dependents', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/customtables/{tablename}/dependents',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  null
]
[null]

TablesControllerV1_GetPicklistDependentTables

Parameters

Name

In

Type

Required

Description

tableName

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Table.SimpleColumnDTO]

false

none

none

» tableName

string¦null

false

none

none

» columnName

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/customtables/{tablename}/picklistdependenttables", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtables/{tablename}/picklistdependenttables");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/customtables/{tablename}/picklistdependenttables',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/customtables/{tablename}/picklistdependenttables', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/customtables/{tablename}/picklistdependenttables',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "tableName": "string",
    "columnName": "string"
  }
]
[{"tableName":"string","columnName":"string"}]

Data Store

Get navigational data store elements.

Parameters

Name

In

Type

Required

Description

filter

query

string

false

####Supported operations

excludeCalcSources

query

boolean

false

none

Detailed descriptions

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

name

Responses

Status

Meaning

Description

Schema

200

OK

Get all Navigation Data Store Elements (filter supported)

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.NavigationDataStoreElementDTO]

false

none

none

» parentBlockId

integer(int32)

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» isFavorite

boolean

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/datastores", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/datastores");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/datastores',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/datastores', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/datastores',
  params: {
  }, headers: headers

p JSON.parse(result)

Creates a data store.

Body parameter

{
  "dataStore": {
    "id": 0,
    "name": "string",
    "workflowObjectID": 0,
    "source": {
      "name": "string",
      "sourceDefinition": {},
      "dependencies": [],
      "columns": [],
      "references": {},
      "timeReferences": {}
    },
    "version": {
      "rowVersion": 0
    }
  },
  "isWebDataViewable": true,
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Composer.DataStoreElementDTO

false

none

» dataStore

body

Varicent.RESTAPI.v1.DTOs.DataStoreDTO

false

none

»» id

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» workflowObjectID

body

integer(int32)

false

none

»» source

body

Varicent.RESTAPI.v1.DTOs.QuerySourceDefinitionDTO

false

none

»»» name

body

string¦null

false

none

»»» sourceDefinition

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»»»» alias

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» customSelect

body

string¦null

false

none

»»»»»» dataType

body

string

false

none

»»»»»» type

body

string

false

none

»»»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»» expressionType

body

string

false

none

»»»»»»» cases

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»»» constraintType

body

string

false

none

»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»» condition

body

any

false

none

»»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»»» literalType

body

string

false

none

»»»»»»»»»» value

body

any

false

none

»»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»»» constraints

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»» literalRight

body

any

false

none

»»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»» right

body

any

false

none

»»»»»»»»» expressionLeft

body

any

false

none

»»»»»»»»» expressionRight

body

any

false

none

»»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»»» like

body

string¦null

false

none

»»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»»»» trueValue

body

any

false

none

»»»»»»»» falseValue

body

any

false

none

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» isDate

body

boolean

false

none

»»»»»»» literalType

body

string

false

none

»»»»»»» value

body

any

false

none

»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»»»» m_namespace

body

string¦null

false

none

»»»»»»» name

body

string¦null

false

none

»»»»»» query

body

any

false

none

»»»»»» alias

body

string¦null

false

none

»»»»»» sourceType

body

string

false

none

»»»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»» joinType

body

string

false

none

»»»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»»» constraintType

body

string

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»» like

body

string¦null

false

none

»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» queryDefinitionRight

body

any

false

none

»»»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» direction

body

string

false

none

»»»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» distinct

body

boolean

false

none

»»»»» unionWith

body

any

false

none

»»»»» exceptWith

body

any

false

none

»»»» sourceNames

body

object¦null

false

none

»»»»» additionalProperties

body

string¦null

false

none

»»» dependencies

body

[string]¦null

false

none

»»» columns

body

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

»»»» name

body

string¦null

false

none

»»»» type

body

string

false

none

»»»» isKey

body

boolean

false

none

»»»» nullable

body

boolean

false

none

»»»» values

body

string¦null

false

none

»»»» lockedPeriod

body

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

»»»»» start

body

string(date-time)

false

none

»»»»» end

body

string(date-time)

false

none

»»»» referencedCol

body

string¦null

false

none

»»»» picklistFilter

body

string¦null

false

none

»»»» displayName

body

string¦null

false

none

»»»» isELTPeriod

body

boolean¦null

false

none

»»» references

body

object¦null

false

none

»»»» additionalProperties

body

string

false

none

»»» timeReferences

body

object¦null

false

none

»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»»»» levelId

body

string¦null

false

none

»»»»» timeId

body

string¦null

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

» isWebDataViewable

body

boolean

false

none

» elementId

body

integer(int32)

false

none

» parentBlockId

body

integer(int32)¦null

false

none

» bounds

body

System.Drawing.RectangleF

false

none

»» location

body

System.Drawing.PointF

false

none

»»» isEmpty

body

boolean

false

none

»»» x

body

number(float)

false

none

»»» y

body

number(float)

false

none

»» size

body

string

false

none

»» x

body

number(float)

false

none

»» y

body

number(float)

false

none

»» width

body

number(float)

false

none

»» height

body

number(float)

false

none

»» left

body

number(float)

false

none

»» top

body

number(float)

false

none

»» right

body

number(float)

false

none

»» bottom

body

number(float)

false

none

»» isEmpty

body

boolean

false

none

» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»» a

body

integer(int32)

false

none

»» b

body

integer(int32)

false

none

»» g

body

integer(int32)

false

none

»» r

body

integer(int32)

false

none

» name

body

string¦null

false

none

» parentBlock

body

Varicent.RESTAPI.v1.DTOs.Composer.ExpandableBlockElementDTO

false

none

»» id

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» href

body

string¦null

false

none

» isVisible

body

boolean

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

»»»»»» dataType

Int

»»»»»» dataType

Decimal

»»»»»» dataType

DateTime

»»»»»» dataType

None

»»»»»» dataType

String

»»»»»» type

SelectAll

»»»»»» type

SelectItem

»»»»»» type

SelectLiteral

»»»»»» type

SelectCustom

»»»»»» type

SelectExpression

»»»»»»» expressionType

caseExpression

»»»»»»» expressionType

dataField

»»»»»»» expressionType

function

»»»»»»» expressionType

ifExpression

»»»»»»» expressionType

literal

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»»» constraintType

clause

»»»»»»»»» constraintType

constraint

»»»»»»»»» constraintType

expressionConstraint

»»»»»»»»» constraintType

likeConstraint

»»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»»» constraintType

subQueryConstraint

»»»»»»»»»» expressionType

caseExpression

»»»»»»»»»» expressionType

dataField

»»»»»»»»»» expressionType

function

»»»»»»»»»» expressionType

ifExpression

»»»»»»»»»» expressionType

literal

»»»»»»»»»» literalType

Integer

»»»»»»»»»» literalType

Decimal

»»»»»»»»»» literalType

Date

»»»»»»»»»» literalType

DateTime

»»»»»»»»»» literalType

String

»»»»»»»»»» literalType

Float

»»»»»»»»»» literalType

Long

»»»»»»»»»» literalType

Null

»»»»»»»»»» literalType

Parameter

»»»»»»»»»» literalType

Guid

»»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»»» literalType

Boolean

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»»» literalType

Integer

»»»»»»» literalType

Decimal

»»»»»»» literalType

Date

»»»»»»» literalType

DateTime

»»»»»»» literalType

String

»»»»»»» literalType

Float

»»»»»»» literalType

Long

»»»»»»» literalType

Null

»»»»»»» literalType

Parameter

»»»»»»» literalType

Guid

»»»»»»» literalType

SystemUtcTime

»»»»»»» literalType

Boolean

»»»»»» sourceType

Table

»»»»»» sourceType

Query

»»»»»» joinType

Inner

»»»»»» joinType

Left

»»»»»» joinType

Right

»»»»»» joinType

Cross

»»»»»» joinType

CrossApply

»»»»»» joinType

OuterApply

»»»»»»» constraintType

clause

»»»»»»» constraintType

constraint

»»»»»»» constraintType

expressionConstraint

»»»»»»» constraintType

likeConstraint

»»»»»»» constraintType

rowVersionConstraint

»»»»»»» constraintType

subQueryConstraint

»»»»»» direction

Ascending

»»»»»» direction

Descending

»»»»»» direction

AscendingNullsFirst

»»»»»» direction

DescendingNullsLast

»»»» type

String

»»»» type

LongString

»»»» type

MaxString

»»»» type

Date

»»»» type

DateTime

»»»» type

Decimal

»»»» type

Int

»»»» type

Long

»»»» type

Float

»»»» type

BLOB

»»»» type

Identity

»»»» type

CLOB

»»»» type

RowVersion

»»»» type

UID

»»»» type

VarCharMax

»»»» type

Boolean

Responses

Status

Meaning

Description

Schema

200

OK

Data Store created

Varicent.RESTAPI.v1.DTOs.Composer.DataStoreElementDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/datastores", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/datastores");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "dataStore": {
    "id": 0,
    "name": "string",
    "workflowObjectID": 0,
    "source": {
      "name": "string",
      "sourceDefinition": {},
      "dependencies": [],
      "columns": [],
      "references": {},
      "timeReferences": {}
    },
    "version": {
      "rowVersion": 0
    }
  },
  "isWebDataViewable": true,
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/datastores',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/datastores', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/datastores',
  params: {
  }, headers: headers

p JSON.parse(result)

Get a data store with a given ID.

Parameters

Name

In

Type

Required

Description

dataStoreId

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get Data Store with given ID

Varicent.RESTAPI.v1.DTOs.Composer.DataStoreElementDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/datastores/{dataStoreId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/datastores/{dataStoreId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/datastores/{dataStoreId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/datastores/{dataStoreId}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/datastores/{dataStoreId}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "dataStore": {
    "id": 0,
    "name": "string",
    "workflowObjectID": 0,
    "source": {
      "name": "string",
      "sourceDefinition": {},
      "dependencies": [],
      "columns": [],
      "references": {},
      "timeReferences": {}
    },
    "version": {
      "rowVersion": 0
    }
  },
  "isWebDataViewable": true,
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "isEmpty": true,
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1,
    "left": 0.1,
    "top": 0.1,
    "right": 0.1,
    "bottom": 0.1,
    "isEmpty": true
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}
{"dataStore":{"id":0,"name":"string","workflowObjectID":0,"source":{"name":"string","sourceDefinition":{},"dependencies":[],"columns":[],"references":{},"timeReferences":{}},"version":{"rowVersion":0}},"isWebDataViewable":true,"elementId":0,"parentBlockId":0,"bounds":{"location":{"isEmpty":true,"x":0.1,"y":0.1},"size":"string","x":0.1,"y":0.1,"width":0.1,"height":0.1,"left":0.1,"top":0.1,"right":0.1,"bottom":0.1,"isEmpty":true},"color":{"a":0,"b":0,"g":0,"r":0},"name":"string","parentBlock":{"id":0,"name":"string","href":"string"},"isVisible":true,"version":{"rowVersion":0}}

Updates a data store with the given ID.

Body parameter

{
  "dataStore": {
    "id": 0,
    "name": "string",
    "workflowObjectID": 0,
    "source": {
      "name": "string",
      "sourceDefinition": {},
      "dependencies": [],
      "columns": [],
      "references": {},
      "timeReferences": {}
    },
    "version": {
      "rowVersion": 0
    }
  },
  "isWebDataViewable": true,
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

dataStoreId

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.Composer.DataStoreElementDTO

false

none

» dataStore

body

Varicent.RESTAPI.v1.DTOs.DataStoreDTO

false

none

»» id

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» workflowObjectID

body

integer(int32)

false

none

»» source

body

Varicent.RESTAPI.v1.DTOs.QuerySourceDefinitionDTO

false

none

»»» name

body

string¦null

false

none

»»» sourceDefinition

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»»»» alias

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» customSelect

body

string¦null

false

none

»»»»»» dataType

body

string

false

none

»»»»»» type

body

string

false

none

»»»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»» expressionType

body

string

false

none

»»»»»»» cases

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»»» constraintType

body

string

false

none

»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»» condition

body

any

false

none

»»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»»» literalType

body

string

false

none

»»»»»»»»»» value

body

any

false

none

»»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»»» constraints

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»» literalRight

body

any

false

none

»»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»» right

body

any

false

none

»»»»»»»»» expressionLeft

body

any

false

none

»»»»»»»»» expressionRight

body

any

false

none

»»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»»» like

body

string¦null

false

none

»»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»»»» trueValue

body

any

false

none

»»»»»»»» falseValue

body

any

false

none

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» isDate

body

boolean

false

none

»»»»»»» literalType

body

string

false

none

»»»»»»» value

body

any

false

none

»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»»»» m_namespace

body

string¦null

false

none

»»»»»»» name

body

string¦null

false

none

»»»»»» query

body

any

false

none

»»»»»» alias

body

string¦null

false

none

»»»»»» sourceType

body

string

false

none

»»»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»» joinType

body

string

false

none

»»»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»»» constraintType

body

string

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»» like

body

string¦null

false

none

»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» queryDefinitionRight

body

any

false

none

»»»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» direction

body

string

false

none

»»»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» distinct

body

boolean

false

none

»»»»» unionWith

body

any

false

none

»»»»» exceptWith

body

any

false

none

»»»» sourceNames

body

object¦null

false

none

»»»»» additionalProperties

body

string¦null

false

none

»»» dependencies

body

[string]¦null

false

none

»»» columns

body

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

»»»» name

body

string¦null

false

none

»»»» type

body

string

false

none

»»»» isKey

body

boolean

false

none

»»»» nullable

body

boolean

false

none

»»»» values

body

string¦null

false

none

»»»» lockedPeriod

body

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

»»»»» start

body

string(date-time)

false

none

»»»»» end

body

string(date-time)

false

none

»»»» referencedCol

body

string¦null

false

none

»»»» picklistFilter

body

string¦null

false

none

»»»» displayName

body

string¦null

false

none

»»»» isELTPeriod

body

boolean¦null

false

none

»»» references

body

object¦null

false

none

»»»» additionalProperties

body

string

false

none

»»» timeReferences

body

object¦null

false

none

»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»»»» levelId

body

string¦null

false

none

»»»»» timeId

body

string¦null

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

» isWebDataViewable

body

boolean

false

none

» elementId

body

integer(int32)

false

none

» parentBlockId

body

integer(int32)¦null

false

none

» bounds

body

System.Drawing.RectangleF

false

none

»» location

body

System.Drawing.PointF

false

none

»»» isEmpty

body

boolean

false

none

»»» x

body

number(float)

false

none

»»» y

body

number(float)

false

none

»» size

body

string

false

none

»» x

body

number(float)

false

none

»» y

body

number(float)

false

none

»» width

body

number(float)

false

none

»» height

body

number(float)

false

none

»» left

body

number(float)

false

none

»» top

body

number(float)

false

none

»» right

body

number(float)

false

none

»» bottom

body

number(float)

false

none

»» isEmpty

body

boolean

false

none

» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»» a

body

integer(int32)

false

none

»» b

body

integer(int32)

false

none

»» g

body

integer(int32)

false

none

»» r

body

integer(int32)

false

none

» name

body

string¦null

false

none

» parentBlock

body

Varicent.RESTAPI.v1.DTOs.Composer.ExpandableBlockElementDTO

false

none

»» id

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» href

body

string¦null

false

none

» isVisible

body

boolean

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

»»»»»» dataType

Int

»»»»»» dataType

Decimal

»»»»»» dataType

DateTime

»»»»»» dataType

None

»»»»»» dataType

String

»»»»»» type

SelectAll

»»»»»» type

SelectItem

»»»»»» type

SelectLiteral

»»»»»» type

SelectCustom

»»»»»» type

SelectExpression

»»»»»»» expressionType

caseExpression

»»»»»»» expressionType

dataField

»»»»»»» expressionType

function

»»»»»»» expressionType

ifExpression

»»»»»»» expressionType

literal

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»»» constraintType

clause

»»»»»»»»» constraintType

constraint

»»»»»»»»» constraintType

expressionConstraint

»»»»»»»»» constraintType

likeConstraint

»»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»»» constraintType

subQueryConstraint

»»»»»»»»»» expressionType

caseExpression

»»»»»»»»»» expressionType

dataField

»»»»»»»»»» expressionType

function

»»»»»»»»»» expressionType

ifExpression

»»»»»»»»»» expressionType

literal

»»»»»»»»»» literalType

Integer

»»»»»»»»»» literalType

Decimal

»»»»»»»»»» literalType

Date

»»»»»»»»»» literalType

DateTime

»»»»»»»»»» literalType

String

»»»»»»»»»» literalType

Float

»»»»»»»»»» literalType

Long

»»»»»»»»»» literalType

Null

»»»»»»»»»» literalType

Parameter

»»»»»»»»»» literalType

Guid

»»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»»» literalType

Boolean

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»»» literalType

Integer

»»»»»»» literalType

Decimal

»»»»»»» literalType

Date

»»»»»»» literalType

DateTime

»»»»»»» literalType

String

»»»»»»» literalType

Float

»»»»»»» literalType

Long

»»»»»»» literalType

Null

»»»»»»» literalType

Parameter

»»»»»»» literalType

Guid

»»»»»»» literalType

SystemUtcTime

»»»»»»» literalType

Boolean

»»»»»» sourceType

Table

»»»»»» sourceType

Query

»»»»»» joinType

Inner

»»»»»» joinType

Left

»»»»»» joinType

Right

»»»»»» joinType

Cross

»»»»»» joinType

CrossApply

»»»»»» joinType

OuterApply

»»»»»»» constraintType

clause

»»»»»»» constraintType

constraint

»»»»»»» constraintType

expressionConstraint

»»»»»»» constraintType

likeConstraint

»»»»»»» constraintType

rowVersionConstraint

»»»»»»» constraintType

subQueryConstraint

»»»»»» direction

Ascending

»»»»»» direction

Descending

»»»»»» direction

AscendingNullsFirst

»»»»»» direction

DescendingNullsLast

»»»» type

String

»»»» type

LongString

»»»» type

MaxString

»»»» type

Date

»»»» type

DateTime

»»»» type

Decimal

»»»» type

Int

»»»» type

Long

»»»» type

Float

»»»» type

BLOB

»»»» type

Identity

»»»» type

CLOB

»»»» type

RowVersion

»»»» type

UID

»»»» type

VarCharMax

»»»» type

Boolean

Responses

Status

Meaning

Description

Schema

200

OK

Data Store updated

Varicent.RESTAPI.v1.DTOs.Composer.DataStoreElementDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/datastores/{dataStoreId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/datastores/{dataStoreId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "dataStore": {
    "id": 0,
    "name": "string",
    "workflowObjectID": 0,
    "source": {
      "name": "string",
      "sourceDefinition": {},
      "dependencies": [],
      "columns": [],
      "references": {},
      "timeReferences": {}
    },
    "version": {
      "rowVersion": 0
    }
  },
  "isWebDataViewable": true,
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/datastores/{dataStoreId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/datastores/{dataStoreId}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/datastores/{dataStoreId}',
  params: {
  }, headers: headers

p JSON.parse(result)

Deletes a data store with the given ID.

Parameters

Name

In

Type

Required

Description

dataStoreId

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Data Store deleted

Varicent.RESTAPI.v1.DTOs.Composer.DataStoreElementDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/datastores/{dataStoreId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/datastores/{dataStoreId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/datastores/{dataStoreId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('http://localhost:8080/api/v1/datastores/{dataStoreId}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.delete 'http://localhost:8080/api/v1/datastores/{dataStoreId}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "dataStore": {
    "id": 0,
    "name": "string",
    "workflowObjectID": 0,
    "source": {
      "name": "string",
      "sourceDefinition": {},
      "dependencies": [],
      "columns": [],
      "references": {},
      "timeReferences": {}
    },
    "version": {
      "rowVersion": 0
    }
  },
  "isWebDataViewable": true,
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "isEmpty": true,
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1,
    "left": 0.1,
    "top": 0.1,
    "right": 0.1,
    "bottom": 0.1,
    "isEmpty": true
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}
{"dataStore":{"id":0,"name":"string","workflowObjectID":0,"source":{"name":"string","sourceDefinition":{},"dependencies":[],"columns":[],"references":{},"timeReferences":{}},"version":{"rowVersion":0}},"isWebDataViewable":true,"elementId":0,"parentBlockId":0,"bounds":{"location":{"isEmpty":true,"x":0.1,"y":0.1},"size":"string","x":0.1,"y":0.1,"width":0.1,"height":0.1,"left":0.1,"top":0.1,"right":0.1,"bottom":0.1,"isEmpty":true},"color":{"a":0,"b":0,"g":0,"r":0},"name":"string","parentBlock":{"id":0,"name":"string","href":"string"},"isVisible":true,"version":{"rowVersion":0}}

Get system data stores.

Responses

Status

Meaning

Description

Schema

200

OK

Get all System Data Stores

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.DataStoreDTO]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» workflowObjectID

integer(int32)

false

none

none

» source

Varicent.RESTAPI.v1.DTOs.QuerySourceDefinitionDTO

false

none

none

»» name

string¦null

false

none

none

»» sourceDefinition

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

»»» query

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

»»»» selectItems

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

none

»»»»» alias

string¦null

false

none

none

»»»»» column

string¦null

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» customSelect

string¦null

false

none

none

»»»»» dataType

string

false

none

none

»»»»» type

string

false

none

none

»»»»» value

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»»» expressionType

string

false

none

none

»»»»»» cases

array¦null

false

none

none

»»»»»»» anonymous

any

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» column

string¦null

false

none

none

»»»»»» op

string¦null

false

none

none

»»»»»» arguments

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

none

[DTO version of IExpression]

»»»»»»» expressionType

string

false

none

none

»»»»»»» cases

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» column

string¦null

false

none

none

»»»»»»» op

string¦null

false

none

none

»»»»»»» arguments

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»»»» constraintType

string

false

none

none

»»»»»»»» op

string¦null

false

none

none

»»»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»»» expressionType

string

false

none

none

»»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»» table

string¦null

false

none

none

»»»»»»»»» column

string¦null

false

none

none

»»»»»»»»» op

string¦null

false

none

none

»»»»»»»»» arguments

array¦null

false

none

none

»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»» condition

any

false

none

none

»»»»»»»»» trueValue

any

false

none

none

»»»»»»»»» falseValue

any

false

none

none

»»»»»»»»» isDate

boolean

false

none

none

»»»»»»»»» literalType

string

false

none

none

»»»»»»»»» value

any

false

none

none

»»»»»»»» caseSensitive

boolean

false

none

none

»»»»»»»» constraints

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» literalRight

any

false

none

none

»»»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»» right

any

false

none

none

»»»»»»»» expressionLeft

any

false

none

none

»»»»»»»» expressionRight

any

false

none

none

»»»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»»»» like

string¦null

false

none

none

»»»»»»»» escapeWildcards

boolean

false

none

none

»»»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»»»» rowVersion

integer(int64)

false

none

none

»»»»»»»» table

string¦null

false

none

none

»»»»»»»» queryDefinitionRight

any

false

none

none

»»»»»»» trueValue

any

false

none

none

»»»»»»» falseValue

any

false

none

none

»»»»»»» isDate

boolean

false

none

none

»»»»»»» literalType

string

false

none

none

»»»»»»» value

any

false

none

none

»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»» trueValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»» falseValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»» isDate

boolean

false

none

none

»»»»»» literalType

string

false

none

none

»»»»»» value

any

false

none

none

»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»»» namespaceTable

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

none

»»»»»» m_namespace

string¦null

false

none

none

»»»»»» name

string¦null

false

none

none

»»»»» query

any

false

none

none

»»»»» alias

string¦null

false

none

none

»»»»» sourceType

string

false

none

none

»»»» joins

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

none

»»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»»» joinType

string

false

none

none

»»»»» onClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»»» constraintType

string

false

none

none

»»»»»» op

string¦null

false

none

none

»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»» caseSensitive

boolean

false

none

none

»»»»»» constraints

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

none

[DTO version of IConstraint]

»»»»»» literalRight

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»» right

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»» expressionLeft

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»» expressionRight

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»» like

string¦null

false

none

none

»»»»»» escapeWildcards

boolean

false

none

none

»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» queryDefinitionRight

any

false

none

none

»»»» whereClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»» order

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» column

string¦null

false

none

none

»»»»» direction

string

false

none

none

»»»» group

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» column

string¦null

false

none

none

»»»» havingClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»» distinct

boolean

false

none

none

»»»» unionWith

any

false

none

none

»»»» exceptWith

any

false

none

none

»»» sourceNames

object¦null

false

none

none

»»»» additionalProperties

string¦null

false

none

none

»» dependencies

[string]¦null

false

none

none

»» columns

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

none

»»» name

string¦null

false

none

none

»»» type

string

false

none

none

»»» isKey

boolean

false

none

none

»»» nullable

boolean

false

none

none

»»» values

string¦null

false

none

none

»»» lockedPeriod

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

none

»»»» start

string(date-time)

false

none

none

»»»» end

string(date-time)

false

none

none

»»» referencedCol

string¦null

false

none

none

»»» picklistFilter

string¦null

false

none

none

»»» displayName

string¦null

false

none

none

»»» isELTPeriod

boolean¦null

false

none

none

»» references

object¦null

false

none

none

»»» additionalProperties

string

false

none

none

»» timeReferences

object¦null

false

none

none

»»» additionalProperties

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

none

»»»» levelId

string¦null

false

none

none

»»»» timeId

string¦null

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

dataType

Int

dataType

Decimal

dataType

DateTime

dataType

None

dataType

String

type

SelectAll

type

SelectItem

type

SelectLiteral

type

SelectCustom

type

SelectExpression

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

sourceType

Table

sourceType

Query

joinType

Inner

joinType

Left

joinType

Right

joinType

Cross

joinType

CrossApply

joinType

OuterApply

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

direction

Ascending

direction

Descending

direction

AscendingNullsFirst

direction

DescendingNullsLast

type

String

type

LongString

type

MaxString

type

Date

type

DateTime

type

Decimal

type

Int

type

Long

type

Float

type

BLOB

type

Identity

type

CLOB

type

RowVersion

type

UID

type

VarCharMax

type

Boolean

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/datastores/system", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/datastores/system");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/datastores/system',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/datastores/system', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/datastores/system',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "name": "string",
    "workflowObjectID": 0,
    "source": {
      "name": "string",
      "sourceDefinition": {},
      "dependencies": [],
      "columns": [],
      "references": {},
      "timeReferences": {}
    },
    "version": {
      "rowVersion": 0
    }
  }
]
[{"id":0,"name":"string","workflowObjectID":0,"source":{"name":"string","sourceDefinition":{},"dependencies":[],"columns":[],"references":{},"timeReferences":{}},"version":{"rowVersion":0}}]

Get all elements that use a specific datastore.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get all elements that use a specific datastore.

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/datastores/{id}/dependents", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/datastores/{id}/dependents");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/datastores/{id}/dependents',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/datastores/{id}/dependents', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/datastores/{id}/dependents',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  null
]
[null]

Data source export. Currently Excel is supported.

Body parameter

{
  "name": "string",
  "sourceDefinition": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "dependencies": [
    "string"
  ],
  "columns": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "references": {
    "property1": "string",
    "property2": "string"
  },
  "timeReferences": {
    "property1": {
      "levelId": "string",
      "timeId": "string"
    },
    "property2": {
      "levelId": "string",
      "timeId": "string"
    }
  }
}

Parameters

Name

In

Type

Required

Description

offset

query

integer(int32)

false

The first row to export.

limit

query

integer(int32)

false

The total number of rows to export.

orderBy

query

string

false

The columns to order the results by.

filter

query

string

false

The filter string to determine which rows to export.

body

body

Varicent.RESTAPI.v1.DTOs.QuerySourceDefinitionDTO

false

The definition of the data store to export.

» name

body

string¦null

false

none

» sourceDefinition

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»» alias

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» table

body

string¦null

false

none

»»»» customSelect

body

string¦null

false

none

»»»» dataType

body

string

false

none

»»»» type

body

string

false

none

»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»» expressionType

body

string

false

none

»»»»»» cases

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» arguments

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»» constraintType

body

string

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» condition

body

any

false

none

»»»»»»»» trueValue

body

any

false

none

»»»»»»»» falseValue

body

any

false

none

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»» constraints

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» literalRight

body

any

false

none

»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» right

body

any

false

none

»»»»»»» expressionLeft

body

any

false

none

»»»»»»» expressionRight

body

any

false

none

»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»» like

body

string¦null

false

none

»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»» trueValue

body

any

false

none

»»»»»» falseValue

body

any

false

none

»»»»»» isDate

body

boolean

false

none

»»»»»» literalType

body

string

false

none

»»»»»» value

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»» m_namespace

body

string¦null

false

none

»»»»» name

body

string¦null

false

none

»»»» query

body

any

false

none

»»»» alias

body

string¦null

false

none

»»»» sourceType

body

string

false

none

»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» joinType

body

string

false

none

»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» constraintType

body

string

false

none

»»»»» op

body

string¦null

false

none

»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» caseSensitive

body

boolean

false

none

»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isPreciseDecimal

body

boolean

false

none

»»»»» like

body

string¦null

false

none

»»»»» escapeWildcards

body

boolean

false

none

»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»» table

body

string¦null

false

none

»»»»» queryDefinitionRight

body

any

false

none

»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» direction

body

string

false

none

»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» distinct

body

boolean

false

none

»»» unionWith

body

any

false

none

»»» exceptWith

body

any

false

none

»» sourceNames

body

object¦null

false

none

»»» additionalProperties

body

string¦null

false

none

» dependencies

body

[string]¦null

false

none

» columns

body

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

»» name

body

string¦null

false

none

»» type

body

string

false

none

»» isKey

body

boolean

false

none

»» nullable

body

boolean

false

none

»» values

body

string¦null

false

none

»» lockedPeriod

body

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

»»» start

body

string(date-time)

false

none

»»» end

body

string(date-time)

false

none

»» referencedCol

body

string¦null

false

none

»» picklistFilter

body

string¦null

false

none

»» displayName

body

string¦null

false

none

»» isELTPeriod

body

boolean¦null

false

none

» references

body

object¦null

false

none

»» additionalProperties

body

string

false

none

» timeReferences

body

object¦null

false

none

»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»» levelId

body

string¦null

false

none

»»» timeId

body

string¦null

false

none

Detailed descriptions

offset: The first row to export. Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: none

limit: The total number of rows to export. Number of records to retrieve.

Default: 50

orderBy: The columns to order the results by. ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

Any column

filter: The filter string to determine which rows to export. ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

Any column

Enumerated Values

Parameter

Value

»»»» dataType

Int

»»»» dataType

Decimal

»»»» dataType

DateTime

»»»» dataType

None

»»»» dataType

String

»»»» type

SelectAll

»»»» type

SelectItem

»»»» type

SelectLiteral

»»»» type

SelectCustom

»»»» type

SelectExpression

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» expressionType

caseExpression

»»»»»» expressionType

dataField

»»»»»» expressionType

function

»»»»»» expressionType

ifExpression

»»»»»» expressionType

literal

»»»»»»» constraintType

clause

»»»»»»» constraintType

constraint

»»»»»»» constraintType

expressionConstraint

»»»»»»» constraintType

likeConstraint

»»»»»»» constraintType

rowVersionConstraint

»»»»»»» constraintType

subQueryConstraint

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»» literalType

Integer

»»»»»» literalType

Decimal

»»»»»» literalType

Date

»»»»»» literalType

DateTime

»»»»»» literalType

String

»»»»»» literalType

Float

»»»»»» literalType

Long

»»»»»» literalType

Null

»»»»»» literalType

Parameter

»»»»»» literalType

Guid

»»»»»» literalType

SystemUtcTime

»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» sourceType

Table

»»»» sourceType

Query

»»»» joinType

Inner

»»»» joinType

Left

»»»» joinType

Right

»»»» joinType

Cross

»»»» joinType

CrossApply

»»»» joinType

OuterApply

»»»»» constraintType

clause

»»»»» constraintType

constraint

»»»»» constraintType

expressionConstraint

»»»»» constraintType

likeConstraint

»»»»» constraintType

rowVersionConstraint

»»»»» constraintType

subQueryConstraint

»»»» direction

Ascending

»»»» direction

Descending

»»»» direction

AscendingNullsFirst

»»»» direction

DescendingNullsLast

»» type

String

»» type

LongString

»» type

MaxString

»» type

Date

»» type

DateTime

»» type

Decimal

»» type

Int

»» type

Long

»» type

Float

»» type

BLOB

»» type

Identity

»» type

CLOB

»» type

RowVersion

»» type

UID

»» type

VarCharMax

»» type

Boolean

Responses

Status

Meaning

Description

Schema

200

OK

Export data source

System.Net.Http.StreamContent

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/datastores/export", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/datastores/export");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "name": "string",
  "sourceDefinition": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "dependencies": [
    "string"
  ],
  "columns": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "references": {
    "property1": "string",
    "property2": "string"
  },
  "timeReferences": {
    "property1": {
      "levelId": "string",
      "timeId": "string"
    },
    "property2": {
      "levelId": "string",
      "timeId": "string"
    }
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/datastores/export',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/datastores/export', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/datastores/export',
  params: {
  }, headers: headers

p JSON.parse(result)

Data source preview.

Body parameter

{
  "name": "string",
  "sourceDefinition": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "dependencies": [
    "string"
  ],
  "columns": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "references": {
    "property1": "string",
    "property2": "string"
  },
  "timeReferences": {
    "property1": {
      "levelId": "string",
      "timeId": "string"
    },
    "property2": {
      "levelId": "string",
      "timeId": "string"
    }
  }
}

Parameters

Name

In

Type

Required

Description

offset

query

integer(int32)

false

none

limit

query

integer(int32)

false

none

orderBy

query

string

false

none

filter

query

string

false

none

body

body

Varicent.RESTAPI.v1.DTOs.QuerySourceDefinitionDTO

false

none

» name

body

string¦null

false

none

» sourceDefinition

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»» alias

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» table

body

string¦null

false

none

»»»» customSelect

body

string¦null

false

none

»»»» dataType

body

string

false

none

»»»» type

body

string

false

none

»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»» expressionType

body

string

false

none

»»»»»» cases

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» arguments

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»» constraintType

body

string

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» condition

body

any

false

none

»»»»»»»» trueValue

body

any

false

none

»»»»»»»» falseValue

body

any

false

none

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»» constraints

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» literalRight

body

any

false

none

»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» right

body

any

false

none

»»»»»»» expressionLeft

body

any

false

none

»»»»»»» expressionRight

body

any

false

none

»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»» like

body

string¦null

false

none

»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»» trueValue

body

any

false

none

»»»»»» falseValue

body

any

false

none

»»»»»» isDate

body

boolean

false

none

»»»»»» literalType

body

string

false

none

»»»»»» value

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»» m_namespace

body

string¦null

false

none

»»»»» name

body

string¦null

false

none

»»»» query

body

any

false

none

»»»» alias

body

string¦null

false

none

»»»» sourceType

body

string

false

none

»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» joinType

body

string

false

none

»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» constraintType

body

string

false

none

»»»»» op

body

string¦null

false

none

»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» caseSensitive

body

boolean

false

none

»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isPreciseDecimal

body

boolean

false

none

»»»»» like

body

string¦null

false

none

»»»»» escapeWildcards

body

boolean

false

none

»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»» table

body

string¦null

false

none

»»»»» queryDefinitionRight

body

any

false

none

»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» direction

body

string

false

none

»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» distinct

body

boolean

false

none

»»» unionWith

body

any

false

none

»»» exceptWith

body

any

false

none

»» sourceNames

body

object¦null

false

none

»»» additionalProperties

body

string¦null

false

none

» dependencies

body

[string]¦null

false

none

» columns

body

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

»» name

body

string¦null

false

none

»» type

body

string

false

none

»» isKey

body

boolean

false

none

»» nullable

body

boolean

false

none

»» values

body

string¦null

false

none

»» lockedPeriod

body

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

»»» start

body

string(date-time)

false

none

»»» end

body

string(date-time)

false

none

»» referencedCol

body

string¦null

false

none

»» picklistFilter

body

string¦null

false

none

»» displayName

body

string¦null

false

none

»» isELTPeriod

body

boolean¦null

false

none

» references

body

object¦null

false

none

»» additionalProperties

body

string

false

none

» timeReferences

body

object¦null

false

none

»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»» levelId

body

string¦null

false

none

»»» timeId

body

string¦null

false

none

Enumerated Values

Parameter

Value

»»»» dataType

Int

»»»» dataType

Decimal

»»»» dataType

DateTime

»»»» dataType

None

»»»» dataType

String

»»»» type

SelectAll

»»»» type

SelectItem

»»»» type

SelectLiteral

»»»» type

SelectCustom

»»»» type

SelectExpression

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» expressionType

caseExpression

»»»»»» expressionType

dataField

»»»»»» expressionType

function

»»»»»» expressionType

ifExpression

»»»»»» expressionType

literal

»»»»»»» constraintType

clause

»»»»»»» constraintType

constraint

»»»»»»» constraintType

expressionConstraint

»»»»»»» constraintType

likeConstraint

»»»»»»» constraintType

rowVersionConstraint

»»»»»»» constraintType

subQueryConstraint

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»» literalType

Integer

»»»»»» literalType

Decimal

»»»»»» literalType

Date

»»»»»» literalType

DateTime

»»»»»» literalType

String

»»»»»» literalType

Float

»»»»»» literalType

Long

»»»»»» literalType

Null

»»»»»» literalType

Parameter

»»»»»» literalType

Guid

»»»»»» literalType

SystemUtcTime

»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» sourceType

Table

»»»» sourceType

Query

»»»» joinType

Inner

»»»» joinType

Left

»»»» joinType

Right

»»»» joinType

Cross

»»»» joinType

CrossApply

»»»» joinType

OuterApply

»»»»» constraintType

clause

»»»»» constraintType

constraint

»»»»» constraintType

expressionConstraint

»»»»» constraintType

likeConstraint

»»»»» constraintType

rowVersionConstraint

»»»»» constraintType

subQueryConstraint

»»»» direction

Ascending

»»»» direction

Descending

»»»» direction

AscendingNullsFirst

»»»» direction

DescendingNullsLast

»» type

String

»» type

LongString

»» type

MaxString

»» type

Date

»» type

DateTime

»» type

Decimal

»» type

Int

»» type

Long

»» type

Float

»» type

BLOB

»» type

Identity

»» type

CLOB

»» type

RowVersion

»» type

UID

»» type

VarCharMax

»» type

Boolean

Responses

Status

Meaning

Description

Schema

200

OK

View data source preview

Varicent.RESTAPI.v1.DTOs.ResultSetDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/datastores/preview", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/datastores/preview");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "name": "string",
  "sourceDefinition": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "dependencies": [
    "string"
  ],
  "columns": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "references": {
    "property1": "string",
    "property2": "string"
  },
  "timeReferences": {
    "property1": {
      "levelId": "string",
      "timeId": "string"
    },
    "property2": {
      "levelId": "string",
      "timeId": "string"
    }
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/datastores/preview',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/datastores/preview', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/datastores/preview',
  params: {
  }, headers: headers

p JSON.parse(result)

DDE

Get Admin DDE Session.

Parameters

Name

In

Type

Required

Description

forceRefresh

query

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Get Admin CDE Session code

RESTAPI.v1.DTOs.DDE.DDESessionDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/dde/admin/session/sessioncode", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/dde/admin/session/sessioncode");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/dde/admin/session/sessioncode',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/dde/admin/session/sessioncode', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/dde/admin/session/sessioncode',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "userID": "string",
  "sessionID": "string",
  "sessionCode": "string",
  "isAdmin": true,
  "expiryTime": "2019-08-24T14:15:22Z",
  "ddeAPIURL": "string"
}
{"userID":"string","sessionID":"string","sessionCode":"string","isAdmin":true,"expiryTime":"2019-08-24T14:15:22Z","ddeAPIURL":"string"}

Get all Admin DDE Reports.

Parameters

Name

In

Type

Required

Description

apiUrl

query

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Get all Admin DDE Reports

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.DDE.DDEReportDTO]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» specification

any

false

none

none

» author

string¦null

false

none

none

» isAdmin

boolean

false

none

none

» sources

[RESTAPI.v1.DTOs.DDE.DDESourceDTO]¦null

false

none

none

»» sourceName

string¦null

false

none

none

»» reportID

integer(int32)

false

none

none

»» sourceFilter

integer(int32)

false

none

none

»» payeeFilterColumnMapping

string¦null

false

none

none

»» hierarchyID

integer(int32)

false

none

none

»» periodFilterColumnMapping

string¦null

false

none

none

» workflowObjectID

integer(int32)

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/dde/admin/reports", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/dde/admin/reports");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/dde/admin/reports',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/dde/admin/reports', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/dde/admin/reports',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "name": "string",
    "specification": null,
    "author": "string",
    "isAdmin": true,
    "sources": [
      {}
    ],
    "workflowObjectID": 0,
    "version": {
      "rowVersion": 0
    }
  }
]
[{"id":0,"name":"string","specification":null,"author":"string","isAdmin":true,"sources":[{}],"workflowObjectID":0,"version":{"rowVersion":0}}]

Post an Admin DDE Report.

Body parameter

{
  "id": 0,
  "name": "string",
  "specification": null,
  "author": "string",
  "isAdmin": true,
  "sources": [
    {
      "sourceName": "string",
      "reportID": 0,
      "sourceFilter": 0,
      "payeeFilterColumnMapping": "string",
      "hierarchyID": 0,
      "periodFilterColumnMapping": "string"
    }
  ],
  "workflowObjectID": 0,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

apiUrl

query

string

false

none

body

body

RESTAPI.v1.DTOs.DDE.DDEReportDTO

false

none

» id

body

integer(int32)

false

none

» name

body

string¦null

false

none

» specification

body

any

false

none

» author

body

string¦null

false

none

» isAdmin

body

boolean

false

none

» sources

body

[RESTAPI.v1.DTOs.DDE.DDESourceDTO]¦null

false

none

»» sourceName

body

string¦null

false

none

»» reportID

body

integer(int32)

false

none

»» sourceFilter

body

integer(int32)

false

none

»» payeeFilterColumnMapping

body

string¦null

false

none

»» hierarchyID

body

integer(int32)

false

none

»» periodFilterColumnMapping

body

string¦null

false

none

» workflowObjectID

body

integer(int32)

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Post an Admin DDE Report

RESTAPI.v1.DTOs.DDE.DDEReportDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/dde/admin/reports", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/dde/admin/reports");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "name": "string",
  "specification": null,
  "author": "string",
  "isAdmin": true,
  "sources": [
    {
      "sourceName": "string",
      "reportID": 0,
      "sourceFilter": 0,
      "payeeFilterColumnMapping": "string",
      "hierarchyID": 0,
      "periodFilterColumnMapping": "string"
    }
  ],
  "workflowObjectID": 0,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/dde/admin/reports',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/dde/admin/reports', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/dde/admin/reports',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "specification": null,
  "author": "string",
  "isAdmin": true,
  "sources": [
    {
      "sourceName": "string",
      "reportID": 0,
      "sourceFilter": 0,
      "payeeFilterColumnMapping": "string",
      "hierarchyID": 0,
      "periodFilterColumnMapping": "string"
    }
  ],
  "workflowObjectID": 0,
  "version": {
    "rowVersion": 0
  }
}
{"id":0,"name":"string","specification":null,"author":"string","isAdmin":true,"sources":[{"sourceName":"string","reportID":0,"sourceFilter":0,"payeeFilterColumnMapping":"string","hierarchyID":0,"periodFilterColumnMapping":"string"}],"workflowObjectID":0,"version":{"rowVersion":0}}

Put an Admin DDE Report.

Body parameter

{
  "id": 0,
  "name": "string",
  "specification": null,
  "author": "string",
  "isAdmin": true,
  "sources": [
    {
      "sourceName": "string",
      "reportID": 0,
      "sourceFilter": 0,
      "payeeFilterColumnMapping": "string",
      "hierarchyID": 0,
      "periodFilterColumnMapping": "string"
    }
  ],
  "workflowObjectID": 0,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

apiUrl

query

string

false

none

body

body

RESTAPI.v1.DTOs.DDE.DDEReportDTO

false

none

» id

body

integer(int32)

false

none

» name

body

string¦null

false

none

» specification

body

any

false

none

» author

body

string¦null

false

none

» isAdmin

body

boolean

false

none

» sources

body

[RESTAPI.v1.DTOs.DDE.DDESourceDTO]¦null

false

none

»» sourceName

body

string¦null

false

none

»» reportID

body

integer(int32)

false

none

»» sourceFilter

body

integer(int32)

false

none

»» payeeFilterColumnMapping

body

string¦null

false

none

»» hierarchyID

body

integer(int32)

false

none

»» periodFilterColumnMapping

body

string¦null

false

none

» workflowObjectID

body

integer(int32)

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Edit an Admin DDE Report

RESTAPI.v1.DTOs.DDE.DDEReportDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/dde/admin/reports", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/dde/admin/reports");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "name": "string",
  "specification": null,
  "author": "string",
  "isAdmin": true,
  "sources": [
    {
      "sourceName": "string",
      "reportID": 0,
      "sourceFilter": 0,
      "payeeFilterColumnMapping": "string",
      "hierarchyID": 0,
      "periodFilterColumnMapping": "string"
    }
  ],
  "workflowObjectID": 0,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/dde/admin/reports',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/dde/admin/reports', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/dde/admin/reports',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "specification": null,
  "author": "string",
  "isAdmin": true,
  "sources": [
    {
      "sourceName": "string",
      "reportID": 0,
      "sourceFilter": 0,
      "payeeFilterColumnMapping": "string",
      "hierarchyID": 0,
      "periodFilterColumnMapping": "string"
    }
  ],
  "workflowObjectID": 0,
  "version": {
    "rowVersion": 0
  }
}
{"id":0,"name":"string","specification":null,"author":"string","isAdmin":true,"sources":[{"sourceName":"string","reportID":0,"sourceFilter":0,"payeeFilterColumnMapping":"string","hierarchyID":0,"periodFilterColumnMapping":"string"}],"workflowObjectID":0,"version":{"rowVersion":0}}

Get all Admin DDE Infographics.

Parameters

Name

In

Type

Required

Description

apiUrl

query

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Get all Admin DDE Infographics

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.DDE.DDEReportDTO]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» specification

any

false

none

none

» author

string¦null

false

none

none

» isAdmin

boolean

false

none

none

» sources

[RESTAPI.v1.DTOs.DDE.DDESourceDTO]¦null

false

none

none

»» sourceName

string¦null

false

none

none

»» reportID

integer(int32)

false

none

none

»» sourceFilter

integer(int32)

false

none

none

»» payeeFilterColumnMapping

string¦null

false

none

none

»» hierarchyID

integer(int32)

false

none

none

»» periodFilterColumnMapping

string¦null

false

none

none

» workflowObjectID

integer(int32)

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/dde/admin/infographics", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/dde/admin/infographics");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/dde/admin/infographics',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/dde/admin/infographics', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/dde/admin/infographics',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "name": "string",
    "specification": null,
    "author": "string",
    "isAdmin": true,
    "sources": [
      {}
    ],
    "workflowObjectID": 0,
    "version": {
      "rowVersion": 0
    }
  }
]
[{"id":0,"name":"string","specification":null,"author":"string","isAdmin":true,"sources":[{}],"workflowObjectID":0,"version":{"rowVersion":0}}]

Get an Admin DDE Report.

Parameters

Name

In

Type

Required

Description

reportID

path

integer(int32)

true

none

apiUrl

query

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Get an Admin DDE Report

RESTAPI.v1.DTOs.DDE.DDEReportDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/dde/admin/reports/{reportID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/dde/admin/reports/{reportID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/dde/admin/reports/{reportID}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/dde/admin/reports/{reportID}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/dde/admin/reports/{reportID}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "specification": null,
  "author": "string",
  "isAdmin": true,
  "sources": [
    {
      "sourceName": "string",
      "reportID": 0,
      "sourceFilter": 0,
      "payeeFilterColumnMapping": "string",
      "hierarchyID": 0,
      "periodFilterColumnMapping": "string"
    }
  ],
  "workflowObjectID": 0,
  "version": {
    "rowVersion": 0
  }
}
{"id":0,"name":"string","specification":null,"author":"string","isAdmin":true,"sources":[{"sourceName":"string","reportID":0,"sourceFilter":0,"payeeFilterColumnMapping":"string","hierarchyID":0,"periodFilterColumnMapping":"string"}],"workflowObjectID":0,"version":{"rowVersion":0}}

Delete an Admin DDE Report.

Parameters

Name

In

Type

Required

Description

reportID

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Delete an Admin DDE Report

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/dde/admin/reports/{reportID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/dde/admin/reports/{reportID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/dde/admin/reports/{reportID}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/dde/admin/reports/{reportID}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/dde/admin/reports/{reportID}',
  params: {
  }

p JSON.parse(result)

DiscoveryDashboardEmbeddedControllerV1_RenameAdminReport

Body parameter

{
  "name": "string"
}

Parameters

Name

In

Type

Required

Description

reportID

path

integer(int32)

true

none

body

body

RESTAPI.v1.DTOs.DDE.DDENameDTO

false

none

» name

body

string¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Rename an Admin DDE Report

string

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/dde/admin/reports/{reportID}/rename", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/dde/admin/reports/{reportID}/rename");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "name": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/dde/admin/reports/{reportID}/rename',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/dde/admin/reports/{reportID}/rename', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/dde/admin/reports/{reportID}/rename',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
"string"
"string"

Get all Admin DDE Report Sources.

Parameters

Name

In

Type

Required

Description

apiUrl

query

string

false

none

displayNameFilter

query

string

false

none

limit

query

integer(int32)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Get all Admin DDE Report Sources

string

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/dde/admin/sources", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/dde/admin/sources");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/dde/admin/sources',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/dde/admin/sources', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/dde/admin/sources',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
"string"
"string"

Get Admin DDE Report Source Data.

Parameters

Name

In

Type

Required

Description

reportID

path

integer(int32)

true

none

sourceName

path

string

true

none

cacheGuid

query

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Get Admin DDE Report Source Data

string

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/dde/admin/sources/data/{reportID}/{sourceName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/dde/admin/sources/data/{reportID}/{sourceName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/dde/admin/sources/data/{reportID}/{sourceName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/dde/admin/sources/data/{reportID}/{sourceName}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/dde/admin/sources/data/{reportID}/{sourceName}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
"string"
"string"

Get Admin DDE Report Source Data Stream

Parameters

Name

In

Type

Required

Description

reportID

path

integer(int32)

true

none

sourceName

path

string

true

none

cacheGuid

query

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Get Admin DDE Report Source Data

string

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/dde/admin/sources/datastream/{reportID}/{sourceName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/dde/admin/sources/datastream/{reportID}/{sourceName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/dde/admin/sources/datastream/{reportID}/{sourceName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/dde/admin/sources/datastream/{reportID}/{sourceName}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/dde/admin/sources/datastream/{reportID}/{sourceName}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
"string"
"string"

Get Payee Report Context.

Parameters

Name

In

Type

Required

Description

objectID

path

integer(int32)

true

none

apiUrl

query

string

false

none

forceRefresh

query

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Get Payee DDE Report Context

RESTAPI.v1.DTOs.DDE.DDEReportContextDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/payee/dde/reportContext/{objectID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payee/dde/reportContext/{objectID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/payee/dde/reportContext/{objectID}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/payee/dde/reportContext/{objectID}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/payee/dde/reportContext/{objectID}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "specification": null,
  "sessionCode": "string",
  "ddeAPIURL": "string"
}
{"specification":null,"sessionCode":"string","ddeAPIURL":"string"}

Get Payee DDE Report Source Data.

Parameters

Name

In

Type

Required

Description

reportID

path

integer(int32)

true

none

sourceName

path

string

true

none

cacheGuid

query

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Get Payee DDE Report Source Data

string

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/payee/dde/sources/datastream/{reportID}/{sourceName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payee/dde/sources/datastream/{reportID}/{sourceName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/payee/dde/sources/datastream/{reportID}/{sourceName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/payee/dde/sources/datastream/{reportID}/{sourceName}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/payee/dde/sources/datastream/{reportID}/{sourceName}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
"string"
"string"

Renew Admin DDE Session.

Parameters

Name

In

Type

Required

Description

sessionId

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Renew Admin CDE Session code

RESTAPI.v1.DTOs.DDE.DDESessionDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/dde/admin/session/sessioncode/{sessionId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/dde/admin/session/sessioncode/{sessionId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/dde/admin/session/sessioncode/{sessionId}',
{
  method: 'PATCH',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/dde/admin/session/sessioncode/{sessionId}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/dde/admin/session/sessioncode/{sessionId}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "userID": "string",
  "sessionID": "string",
  "sessionCode": "string",
  "isAdmin": true,
  "expiryTime": "2019-08-24T14:15:22Z",
  "ddeAPIURL": "string"
}
{"userID":"string","sessionID":"string","sessionCode":"string","isAdmin":true,"expiryTime":"2019-08-24T14:15:22Z","ddeAPIURL":"string"}

EHelp

EHelpControllerV2_GetEHelpConfig

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v2.DTOs.HelpVideoKBConfigDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v2/ehelp/config", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v2/ehelp/config");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v2/ehelp/config',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v2/ehelp/config', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v2/ehelp/config',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "cloudBase": "string",
  "kBBase": "string",
  "kBOn": true,
  "cloudOn": true,
  "publicKeyID": "string",
  "signature": "string",
  "encodedCustomPolicy": "string",
  "expires": "string",
  "sampleQuery": "string"
}
{"cloudBase":"string","kBBase":"string","kBOn":true,"cloudOn":true,"publicKeyID":"string","signature":"string","encodedCustomPolicy":"string","expires":"string","sampleQuery":"string"}

Element

Copy and paste the given elements.

Body parameter

{
  "elementIDs": [
    0
  ],
  "currentBlockID": 0,
  "targetBlockID": 0,
  "location": {
    "x": 0.1,
    "y": 0.1
  },
  "suffix": "string",
  "sourceMapping": [
    [
      "string"
    ]
  ]
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Composer.ElementPasteDTO

false

Element paste DTO

» elementIDs

body

[integer]¦null

false

none

» currentBlockID

body

integer(int32)

false

none

» targetBlockID

body

integer(int32)

false

none

» location

body

System.Drawing.PointF

false

none

»» isEmpty

body

boolean

false

none

»» x

body

number(float)

false

none

»» y

body

number(float)

false

none

» suffix

body

string¦null

false

none

» sourceMapping

body

[array]¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Copy paste composer elements

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.DataEventDTO]

false

none

none

» type

string

false

none

none

» current

any

false

none

none

» original

any

false

none

none

Enumerated Values

Property

Value

type

Added

type

Deleted

type

Modified

type

Unchanged

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/composer/copypaste", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/composer/copypaste");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "elementIDs": [
    0
  ],
  "currentBlockID": 0,
  "targetBlockID": 0,
  "location": {
    "x": 0.1,
    "y": 0.1
  },
  "suffix": "string",
  "sourceMapping": [
    [
      "string"
    ]
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/composer/copypaste',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/composer/copypaste', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/composer/copypaste',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "type": "Added",
    "current": null,
    "original": null
  }
]
[{"type":"Added","current":null,"original":null}]

Cut and paste the given elements.

Body parameter

{
  "elementIDs": [
    0
  ],
  "currentBlockID": 0,
  "targetBlockID": 0,
  "location": {
    "x": 0.1,
    "y": 0.1
  },
  "suffix": "string",
  "sourceMapping": [
    [
      "string"
    ]
  ]
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Composer.ElementPasteDTO

false

Element paste DTO

» elementIDs

body

[integer]¦null

false

none

» currentBlockID

body

integer(int32)

false

none

» targetBlockID

body

integer(int32)

false

none

» location

body

System.Drawing.PointF

false

none

»» isEmpty

body

boolean

false

none

»» x

body

number(float)

false

none

»» y

body

number(float)

false

none

» suffix

body

string¦null

false

none

» sourceMapping

body

[array]¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Cut paste composer elements

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.DataEventDTO]

false

none

none

» type

string

false

none

none

» current

any

false

none

none

» original

any

false

none

none

Enumerated Values

Property

Value

type

Added

type

Deleted

type

Modified

type

Unchanged

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/composer/cutpaste", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/composer/cutpaste");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "elementIDs": [
    0
  ],
  "currentBlockID": 0,
  "targetBlockID": 0,
  "location": {
    "x": 0.1,
    "y": 0.1
  },
  "suffix": "string",
  "sourceMapping": [
    [
      "string"
    ]
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/composer/cutpaste',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/composer/cutpaste', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/composer/cutpaste',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "type": "Added",
    "current": null,
    "original": null
  }
]
[{"type":"Added","current":null,"original":null}]

Globalize the given table.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Table Element ID

Responses

Status

Meaning

Description

Schema

200

OK

Globalize composer table

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/composer/globalize/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/composer/globalize/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/composer/globalize/{id}',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/v1/composer/globalize/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/v1/composer/globalize/{id}',
  params: {
  }

p JSON.parse(result)

Localize the given table.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Table Element ID

Responses

Status

Meaning

Description

Schema

200

OK

Localize composer table

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/composer/localize/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/composer/localize/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/composer/localize/{id}',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/v1/composer/localize/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/v1/composer/localize/{id}',
  params: {
  }

p JSON.parse(result)

Globalize the given table and replace the ports.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Table Element ID

Responses

Status

Meaning

Description

Schema

200

OK

Globalize and replace ports

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/composer/globalizereplaceports/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/composer/globalizereplaceports/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/composer/globalizereplaceports/{id}',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/v1/composer/globalizereplaceports/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/v1/composer/globalizereplaceports/{id}',
  params: {
  }

p JSON.parse(result)

ELearning

ELearningControllerV1_GetELearningCourses

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.ELearningCoursesInfoDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/elearning/eLearningCourses", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/elearning/eLearningCourses");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/elearning/eLearningCourses',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/elearning/eLearningCourses', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/elearning/eLearningCourses',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "categories": [
    {
      "categoryID": "string",
      "name": "string",
      "parentCategoryID": "string",
      "parentName": "string",
      "courses": []
    }
  ]
}
{"categories":[{"categoryID":"string","name":"string","parentCategoryID":"string","parentName":"string","courses":[]}]}

ELearningControllerV1_GetELearningCourseUnits

Parameters

Name

In

Type

Required

Description

courseID

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.ELearningUnitDTO]

false

none

none

» unitID

string¦null

false

none

none

» name

string¦null

false

none

none

» type

string¦null

false

none

none

» completionStatus

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/elearning/eLearningCourseUnits/{courseID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/elearning/eLearningCourseUnits/{courseID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/elearning/eLearningCourseUnits/{courseID}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/elearning/eLearningCourseUnits/{courseID}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/elearning/eLearningCourseUnits/{courseID}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "unitID": "string",
    "name": "string",
    "type": "string",
    "completionStatus": "string"
  }
]
[{"unitID":"string","name":"string","type":"string","completionStatus":"string"}]

ELearningControllerV1_GetELearningCourseLink

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/elearning/eLearningCourseLink/{courseID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/elearning/eLearningCourseLink/{courseID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/elearning/eLearningCourseLink/{courseID}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/elearning/eLearningCourseLink/{courseID}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/elearning/eLearningCourseLink/{courseID}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
"string"
"string"

ELearningControllerV1_ELearningLoginUser

Body parameter

{
  "username": "string",
  "password": "string"
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.ELearningLoginDTO

false

none

» username

body

string¦null

false

none

» password

body

string¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

string

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/elearning/eLearningLogin", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/elearning/eLearningLogin");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "username": "string",
  "password": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/elearning/eLearningLogin',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/elearning/eLearningLogin', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/elearning/eLearningLogin',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
"string"
"string"

ELearningControllerV1_ValidateELearningUser

Responses

Status

Meaning

Description

Schema

200

OK

Success

boolean

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/elearning/eLearningValidation", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/elearning/eLearningValidation");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/elearning/eLearningValidation',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/elearning/eLearningValidation', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/elearning/eLearningValidation',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
true
true

ELearningControllerV1_ValidateELearningSettings

Responses

Status

Meaning

Description

Schema

200

OK

Success

boolean

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/elearning/eLearningSettingsValidation", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/elearning/eLearningSettingsValidation");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/elearning/eLearningSettingsValidation',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/elearning/eLearningSettingsValidation', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/elearning/eLearningSettingsValidation',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
true
true

GlobalActionStatus

Get the global action status.

Parameters

Name

In

Type

Required

Description

importTableName

query

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Get global action status

boolean

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/globalactionstatus", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/globalactionstatus");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/globalactionstatus',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/globalactionstatus', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/globalactionstatus',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
true
true

Get all active global tokens

Responses

Status

Meaning

Description

Schema

200

OK

Get all global tokens

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.GlobalAction.GlobalTokenDTO]

false

none

none

» tokenID

integer(int32)

false

none

none

» adminID

string¦null

false

none

none

» action

string¦null

false

none

none

» heldFor

string(date-span)

false

none

none

» isExclusive

boolean

false

none

none

» locks

[Varicent.RESTAPI.v1.DTOs.GlobalAction.TokenLockDTO]¦null

false

none

none

»» id

integer(int32)

false

none

none

»» objectType

string¦null

false

none

none

»» objectName

string¦null

false

none

none

»» isReadonly

boolean

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/globalstatus/tokens", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/globalstatus/tokens");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/globalstatus/tokens',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/globalstatus/tokens', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/globalstatus/tokens',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "tokenID": 0,
    "adminID": "string",
    "action": "string",
    "heldFor": "string",
    "isExclusive": true,
    "locks": [
      {}
    ]
  }
]
[{"tokenID":0,"adminID":"string","action":"string","heldFor":"string","isExclusive":true,"locks":[{}]}]

Get a flat list of all token locks held by all active global tokens

Responses

Status

Meaning

Description

Schema

200

OK

Get all global token locks

Varicent.RESTAPI.v1.DTOs.GlobalAction.AggeregateTokenLocksDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/globalstatus/locks", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/globalstatus/locks");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/globalstatus/locks',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/globalstatus/locks', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/globalstatus/locks',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "numTokens": 0,
  "hasExclusiveToken": true,
  "locks": [
    {
      "id": 0,
      "objectType": "string",
      "objectName": "string",
      "isReadonly": true
    }
  ]
}
{"numTokens":0,"hasExclusiveToken":true,"locks":[{"id":0,"objectType":"string","objectName":"string","isReadonly":true}]}

Get the global token

Parameters

Name

In

Type

Required

Description

isImport

query

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Find the global token.

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/getglobaltoken", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/getglobaltoken");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/getglobaltoken',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/getglobaltoken', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/getglobaltoken',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  [
    "string"
  ]
]
[["string"]]

Get the import limit status

Responses

Status

Meaning

Description

Schema

200

OK

get the status of import limit at the same time

boolean

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/getimportlimitstatus", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/getimportlimitstatus");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/getimportlimitstatus',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/getimportlimitstatus', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/getimportlimitstatus',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
true
true

Import

Get local imports.

Shouldn’t be used as there are no longer local saved imports

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/localimports", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/localimports");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/localimports',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/localimports', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/localimports',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  "string"
]
["string"]

Get remote imports.

Parameters

Name

In

Type

Required

Description

filter

query

string

false

####Supported operations

orderBy

query

string

false

####Description

ignoreMappingImports

query

boolean

false

none

Detailed descriptions

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

name

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

name

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/remoteimports", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/remoteimports");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/remoteimports',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/remoteimports', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/remoteimports',
  params: {
  }, headers: headers

p JSON.parse(result)

Get all user file names that have been referenced by this model.

Parameters

Name

In

Type

Required

Description

filter

query

string

false

####Supported operations

Detailed descriptions

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

FileId, FileName, FileType, ChunkSize, Size, CurrSize, AdminId, Time, IsComplete

Responses

Status

Meaning

Description

Schema

200

OK

get all the file names attached to this model

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.ImportFileDTO]

false

none

none

» fileId

integer(int32)

false

none

none

» fileName

string¦null

false

none

none

» fileType

string

false

none

none

» chunkSize

integer(int32)

false

none

none

» size

integer(int64)

false

none

none

» currSize

integer(int64)

false

none

none

» adminId

string¦null

false

none

none

» time

string(date-time)

false

none

none

» tempFileName

string¦null

false

none

none

» isComplete

boolean

false

read-only

none

Enumerated Values

Property

Value

fileType

None

fileType

Data

fileType

Script

fileType

Image

fileType

Document

fileType

Publication

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/serverfilenames", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/serverfilenames");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/serverfilenames',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/serverfilenames', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/serverfilenames',
  params: {
  }, headers: headers

p JSON.parse(result)

Get all user files that have been referenced by this model.

Parameters

Name

In

Type

Required

Description

filter

query

string

false

####Supported operations

Detailed descriptions

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

FileId, FileName, FileType, ChunkSize, Size, CurrSize, AdminId, Time, IsComplete

Responses

Status

Meaning

Description

Schema

200

OK

get all the files attached to this model

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.ImportFileDTO]

false

none

none

» fileId

integer(int32)

false

none

none

» fileName

string¦null

false

none

none

» fileType

string

false

none

none

» chunkSize

integer(int32)

false

none

none

» size

integer(int64)

false

none

none

» currSize

integer(int64)

false

none

none

» adminId

string¦null

false

none

none

» time

string(date-time)

false

none

none

» tempFileName

string¦null

false

none

none

» isComplete

boolean

false

read-only

none

Enumerated Values

Property

Value

fileType

None

fileType

Data

fileType

Script

fileType

Image

fileType

Document

fileType

Publication

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v2/serverfiles", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v2/serverfiles");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v2/serverfiles',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v2/serverfiles', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v2/serverfiles',
  params: {
  }, headers: headers

p JSON.parse(result)

Append content to an existing file.

Body parameter

{
  "fileId": 0,
  "data64": "string",
  "chunkNo": 0,
  "tempFileName": "string"
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v2.DTOs.FileDTO

false

The JSON object which points to the file to be appended to.

» fileId

body

integer(int32)

false

none

» data64

body

string¦null

false

none

» chunkNo

body

integer(int32)

false

none

» tempFileName

body

string¦null

false

none

Responses

Status

Meaning

Description

Schema

201

Created

Created

RESTAPI.v2.DTOs.ImportFileDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v2/serverfiles", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v2/serverfiles");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "fileId": 0,
  "data64": "string",
  "chunkNo": 0,
  "tempFileName": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v2/serverfiles',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v2/serverfiles', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v2/serverfiles',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "fileId": 0,
  "fileName": "string",
  "fileType": "None",
  "chunkSize": 0,
  "size": 0,
  "currSize": 0,
  "adminId": "string",
  "time": "2019-08-24T14:15:22Z",
  "tempFileName": "string",
  "isComplete": true
}
{"fileId":0,"fileName":"string","fileType":"None","chunkSize":0,"size":0,"currSize":0,"adminId":"string","time":"2019-08-24T14:15:22Z","tempFileName":"string","isComplete":true}

Add a file to this model.

Body parameter

{
  "fileId": 0,
  "fileName": "string",
  "fileType": "None",
  "size": 0,
  "currSize": 0,
  "chunkSize": 0,
  "overwrite": true
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v2.DTOs.NewFileDTO

false

The JSON object containing a user friendly name for the file (in effect, MyFile.csv) and base64 encoding of the content of the file.

» fileId

body

integer(int32)

false

none

» fileName

body

string¦null

false

none

» fileType

body

string

false

none

» size

body

integer(int64)

false

none

» currSize

body

integer(int64)

false

none

» chunkSize

body

integer(int32)

false

none

» overwrite

body

boolean

false

none

Enumerated Values

Parameter

Value

» fileType

None

» fileType

Data

» fileType

Script

» fileType

Image

» fileType

Document

» fileType

Publication

Responses

Status

Meaning

Description

Schema

201

Created

Created

RESTAPI.v2.DTOs.ImportFileDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v2/serverfiles", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v2/serverfiles");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "fileId": 0,
  "fileName": "string",
  "fileType": "None",
  "size": 0,
  "currSize": 0,
  "chunkSize": 0,
  "overwrite": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v2/serverfiles',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v2/serverfiles', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v2/serverfiles',
  params: {
  }, headers: headers

p JSON.parse(result)

Get info about a specific file from this model.

Parameters

Name

In

Type

Required

Description

filename

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get a specific file from this model

RESTAPI.v1.DTOs.ImportFileDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v2/serverfiles/{filename}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v2/serverfiles/{filename}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v2/serverfiles/{filename}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v2/serverfiles/{filename}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v2/serverfiles/{filename}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "fileId": 0,
  "fileName": "string",
  "fileType": "None",
  "chunkSize": 0,
  "size": 0,
  "currSize": 0,
  "adminId": "string",
  "time": "2019-08-24T14:15:22Z",
  "tempFileName": "string",
  "isComplete": true
}
{"fileId":0,"fileName":"string","fileType":"None","chunkSize":0,"size":0,"currSize":0,"adminId":"string","time":"2019-08-24T14:15:22Z","tempFileName":"string","isComplete":true}

Remove a file from this model.

Parameters

Name

In

Type

Required

Description

fileName

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Delete a specific file from this model

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v2/serverfiles/{filename}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v2/serverfiles/{filename}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v2/serverfiles/{filename}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v2/serverfiles/{filename}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v2/serverfiles/{filename}',
  params: {
  }

p JSON.parse(result)

RemoteImportsControllerV1_RunImport

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Run a saved import

Inline

404

Not Found

Import does not exist.

None

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/imports/{id}/run", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/imports/{id}/run");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/imports/{id}/run',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/imports/{id}/run', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/imports/{id}/run',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "property1": "string",
  "property2": "string"
}
{"property1":"string","property2":"string"}

RemoteImportsControllerV1_RunAdHocImport

Body parameter

{
  "name": "string",
  "importType": "None",
  "hasHeader": true,
  "table": "string",
  "columnMatchings": {
    "columns": [
      "string"
    ],
    "matched": [
      "string"
    ]
  },
  "dateFormat": "Default",
  "listSubitems": [
    "string"
  ],
  "subitemMap": {
    "property1": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    },
    "property2": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    }
  },
  "addMember": true,
  "updateExistingRows": true,
  "tableType": "System",
  "isLocal": true,
  "localCulture": {},
  "useIncrementalImport": true,
  "culture": "string",
  "tableEffectiveDated": true,
  "isODBCTextDriver": true,
  "version": {
    "rowVersion": 0
  },
  "fileOverwrite": true,
  "importId": 0,
  "filename": "string",
  "localPath": "string",
  "username": "string",
  "password": "string",
  "delimiter": "string",
  "sheetName": "string",
  "cellRange": "string",
  "query": "string",
  "queryTimeout": 0,
  "connectionString": "string",
  "useAdvanced": true,
  "model": "string",
  "importMethod": 0,
  "sourceTableName": "string",
  "securityToken": "string",
  "customColumns": [
    "string"
  ],
  "userSelected": true,
  "sandbox": true,
  "fileLocation": "string",
  "codePage": 0,
  "ignoreFirst": true,
  "ignoreLast": true,
  "recordLength": 0,
  "fields": [
    {
      "name": "string",
      "offset": 0,
      "length": 0,
      "dataType": "String"
    }
  ],
  "selectRowNode": "string",
  "pipeConnection": {
    "pipeID": "string",
    "inputID": "string",
    "outputID": "string",
    "outputName": "string",
    "lastValidated": "2019-08-24T14:15:22Z",
    "inputMapping": [
      {}
    ],
    "outputMapping": [
      {}
    ]
  },
  "inputTable": "string",
  "uploadStage": true,
  "predictStage": true,
  "downloadStage": true,
  "symonImportType": "None",
  "refreshAllPipeDatasources": true,
  "connectorID": "string",
  "streamID": "string",
  "importConfig": null,
  "outputMapping": [
    {
      "source": "string",
      "destination": "string",
      "type": "String"
    }
  ],
  "cosLocations": [
    {
      "bucket": "string",
      "key": "string"
    }
  ],
  "cosCredentials": {
    "endpoint": "string",
    "accessKey": "string",
    "secretKey": "string",
    "sessionToken": "string",
    "taskAuthToken": "string",
    "taskAuthEndpoint": "string",
    "taskAuthExpiration": "string"
  }
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Composer.DataImport.ImportParamsDTO

false

none

» name

body

string¦null

false

none

» importType

body

string

false

none

» hasHeader

body

boolean

false

none

» table

body

string¦null

false

none

» columnMatchings

body

RESTAPI.v1.DTOs.ColumnMatchingsDTO

false

none

»» columns

body

[string]¦null

false

none

»» matched

body

[string]¦null

false

none

» dateFormat

body

string

false

none

» listSubitems

body

[string]¦null

false

none

» subitemMap

body

object¦null

false

none

»» additionalProperties

body

RESTAPI.v1.DTOs.Composer.DataImport.SubitemDTO

false

none

»»» name

body

[string]¦null

false

none

»»» fieldName

body

[string]¦null

false

none

»»» type

body

string

false

none

»»» delimiter

body

string¦null

false

none

»»» segment

body

integer(int32)

false

none

»»» selection

body

[string]¦null

false

none

»»» fieldIndices

body

[integer]¦null

false

none

» addMember

body

boolean

false

none

» updateExistingRows

body

boolean

false

none

» tableType

body

string

false

none

» isLocal

body

boolean

false

none

» localCulture

body

System.IFormatProvider

false

none

» useIncrementalImport

body

boolean

false

none

» culture

body

string¦null

false

none

» tableEffectiveDated

body

boolean

false

none

» isODBCTextDriver

body

boolean

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

» fileOverwrite

body

boolean

false

none

» importId

body

integer(int32)

false

none

» filename

body

string¦null

false

none

» localPath

body

string¦null

false

none

» username

body

string¦null

false

none

» password

body

string¦null

false

none

» delimiter

body

string

false

none

» sheetName

body

string¦null

false

none

» cellRange

body

string¦null

false

none

» query

body

string¦null

false

none

» queryTimeout

body

integer(int32)

false

none

» connectionString

body

string¦null

false

none

» useAdvanced

body

boolean

false

none

» model

body

string¦null

false

none

» importMethod

body

integer(int32)

false

none

» sourceTableName

body

string¦null

false

none

» securityToken

body

string¦null

false

none

» customColumns

body

[string]¦null

false

none

» userSelected

body

boolean

false

none

» sandbox

body

boolean

false

none

» fileLocation

body

string¦null

false

none

» codePage

body

integer(int32)

false

none

» ignoreFirst

body

boolean

false

none

» ignoreLast

body

boolean

false

none

» recordLength

body

integer(int32)

false

none

» fields

body

[RESTAPI.v1.DTOs.Composer.DataImport.EBCDICFieldDTO]¦null

false

none

»» name

body

string¦null

false

none

»» offset

body

integer(int32)

false

none

»» length

body

integer(int32)

false

none

»» dataType

body

string

false

none

» selectRowNode

body

string¦null

false

none

» pipeConnection

body

Varicent.RESTAPI.v1.DTOs.Symon.PipeConnectionDTO

false

none

»» pipeID

body

string¦null

false

none

»» inputID

body

string¦null

false

none

»» outputID

body

string¦null

false

none

»» outputName

body

string¦null

false

none

»» lastValidated

body

string(date-time)

false

none

»» inputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»»» source

body

string¦null

false

none

»»» destination

body

string¦null

false

none

»»» type

body

string

false

none

»» outputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

» inputTable

body

string¦null

false

none

» uploadStage

body

boolean

false

none

» predictStage

body

boolean

false

none

» downloadStage

body

boolean

false

none

» symonImportType

body

string

false

none

» refreshAllPipeDatasources

body

boolean

false

none

» connectorID

body

string¦null

false

none

» streamID

body

string¦null

false

none

» importConfig

body

any

false

none

» outputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

» cosLocations

body

[RESTAPI.v1.DTOs.Symon.CosLocationDTO]¦null

false

none

»» bucket

body

string¦null

false

none

»» key

body

string¦null

false

none

» cosCredentials

body

RESTAPI.v1.DTOs.Composer.DataImport.CosCredentialsDTO

false

none

»» endpoint

body

string¦null

false

none

»» accessKey

body

string¦null

false

none

»» secretKey

body

string¦null

false

none

»» sessionToken

body

string¦null

false

none

»» taskAuthToken

body

string¦null

false

none

»» taskAuthEndpoint

body

string¦null

false

none

»» taskAuthExpiration

body

string¦null

false

none

Enumerated Values

Parameter

Value

» importType

None

» importType

Text

» importType

Excel

» importType

DBImport

» importType

Salesforce

» importType

MSCRM

» importType

EBCDICText

» importType

TerrAlign

» importType

XML

» importType

ODBCImport

» importType

SymonImport

» importType

SymonConnectorImport

» importType

Cos

» importType

SQLServer

» importType

Dynamics

» importType

GoogleSheets

» importType

MySql

» importType

AmazonAurora

» importType

AmazonS3

» importType

Snowflake

» importType

Shopify

» importType

Hubspot

» importType

Oracle

» importType

AmazonRedshift

» importType

Workday

» dateFormat

Default

» dateFormat

DayFirst

» dateFormat

MonthFirst

»»» type

Delimited

»»» type

Selection

»»» type

Merged

» tableType

System

» tableType

Dimension

» tableType

Structural

» tableType

Lookup

» tableType

Data

» tableType

View

» tableType

Custom

» tableType

StarSchema

» tableType

ExportTable

» tableType

CreditingRule

» tableType

AssignTable

» tableType

PlcmCustomTable

» tableType

PlcmStructuralTable

» tableType

PlcmTable

» tableType

DataSource

» tableType

Cached

» tableType

MaterializedView

»» dataType

String

»» dataType

Decimal

»»» type

String

»»» type

Number

»»» type

Boolean

»»» type

Date

» symonImportType

None

» symonImportType

Text

» symonImportType

Excel

» symonImportType

DBImport

» symonImportType

Salesforce

» symonImportType

MSCRM

» symonImportType

EBCDICText

» symonImportType

TerrAlign

» symonImportType

XML

» symonImportType

ODBCImport

» symonImportType

SymonImport

» symonImportType

SymonConnectorImport

» symonImportType

Cos

» symonImportType

SQLServer

» symonImportType

Dynamics

» symonImportType

GoogleSheets

» symonImportType

MySql

» symonImportType

AmazonAurora

» symonImportType

AmazonS3

» symonImportType

Snowflake

» symonImportType

Shopify

» symonImportType

Hubspot

» symonImportType

Oracle

» symonImportType

AmazonRedshift

» symonImportType

Workday

Responses

Status

Meaning

Description

Schema

200

OK

Run an ad hoc import

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/imports/runAdHoc", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/imports/runAdHoc");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "name": "string",
  "importType": "None",
  "hasHeader": true,
  "table": "string",
  "columnMatchings": {
    "columns": [
      "string"
    ],
    "matched": [
      "string"
    ]
  },
  "dateFormat": "Default",
  "listSubitems": [
    "string"
  ],
  "subitemMap": {
    "property1": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    },
    "property2": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    }
  },
  "addMember": true,
  "updateExistingRows": true,
  "tableType": "System",
  "isLocal": true,
  "localCulture": {},
  "useIncrementalImport": true,
  "culture": "string",
  "tableEffectiveDated": true,
  "isODBCTextDriver": true,
  "version": {
    "rowVersion": 0
  },
  "fileOverwrite": true,
  "importId": 0,
  "filename": "string",
  "localPath": "string",
  "username": "string",
  "password": "string",
  "delimiter": "string",
  "sheetName": "string",
  "cellRange": "string",
  "query": "string",
  "queryTimeout": 0,
  "connectionString": "string",
  "useAdvanced": true,
  "model": "string",
  "importMethod": 0,
  "sourceTableName": "string",
  "securityToken": "string",
  "customColumns": [
    "string"
  ],
  "userSelected": true,
  "sandbox": true,
  "fileLocation": "string",
  "codePage": 0,
  "ignoreFirst": true,
  "ignoreLast": true,
  "recordLength": 0,
  "fields": [
    {
      "name": "string",
      "offset": 0,
      "length": 0,
      "dataType": "String"
    }
  ],
  "selectRowNode": "string",
  "pipeConnection": {
    "pipeID": "string",
    "inputID": "string",
    "outputID": "string",
    "outputName": "string",
    "lastValidated": "2019-08-24T14:15:22Z",
    "inputMapping": [
      {}
    ],
    "outputMapping": [
      {}
    ]
  },
  "inputTable": "string",
  "uploadStage": true,
  "predictStage": true,
  "downloadStage": true,
  "symonImportType": "None",
  "refreshAllPipeDatasources": true,
  "connectorID": "string",
  "streamID": "string",
  "importConfig": null,
  "outputMapping": [
    {
      "source": "string",
      "destination": "string",
      "type": "String"
    }
  ],
  "cosLocations": [
    {
      "bucket": "string",
      "key": "string"
    }
  ],
  "cosCredentials": {
    "endpoint": "string",
    "accessKey": "string",
    "secretKey": "string",
    "sessionToken": "string",
    "taskAuthToken": "string",
    "taskAuthEndpoint": "string",
    "taskAuthExpiration": "string"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/imports/runAdHoc',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/imports/runAdHoc', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/imports/runAdHoc',
  params: {
  }, headers: headers

p JSON.parse(result)

Get column headers from a file on the server.

Body parameter

{
  "name": "string",
  "importType": "None",
  "hasHeader": true,
  "table": "string",
  "columnMatchings": {
    "columns": [
      "string"
    ],
    "matched": [
      "string"
    ]
  },
  "dateFormat": "Default",
  "listSubitems": [
    "string"
  ],
  "subitemMap": {
    "property1": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    },
    "property2": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    }
  },
  "addMember": true,
  "updateExistingRows": true,
  "tableType": "System",
  "isLocal": true,
  "localCulture": {},
  "useIncrementalImport": true,
  "culture": "string",
  "tableEffectiveDated": true,
  "isODBCTextDriver": true,
  "version": {
    "rowVersion": 0
  },
  "fileOverwrite": true,
  "importId": 0,
  "filename": "string",
  "localPath": "string",
  "username": "string",
  "password": "string",
  "delimiter": "string",
  "sheetName": "string",
  "cellRange": "string",
  "query": "string",
  "queryTimeout": 0,
  "connectionString": "string",
  "useAdvanced": true,
  "model": "string",
  "importMethod": 0,
  "sourceTableName": "string",
  "securityToken": "string",
  "customColumns": [
    "string"
  ],
  "userSelected": true,
  "sandbox": true,
  "fileLocation": "string",
  "codePage": 0,
  "ignoreFirst": true,
  "ignoreLast": true,
  "recordLength": 0,
  "fields": [
    {
      "name": "string",
      "offset": 0,
      "length": 0,
      "dataType": "String"
    }
  ],
  "selectRowNode": "string",
  "pipeConnection": {
    "pipeID": "string",
    "inputID": "string",
    "outputID": "string",
    "outputName": "string",
    "lastValidated": "2019-08-24T14:15:22Z",
    "inputMapping": [
      {}
    ],
    "outputMapping": [
      {}
    ]
  },
  "inputTable": "string",
  "uploadStage": true,
  "predictStage": true,
  "downloadStage": true,
  "symonImportType": "None",
  "refreshAllPipeDatasources": true,
  "connectorID": "string",
  "streamID": "string",
  "importConfig": null,
  "outputMapping": [
    {
      "source": "string",
      "destination": "string",
      "type": "String"
    }
  ],
  "cosLocations": [
    {
      "bucket": "string",
      "key": "string"
    }
  ],
  "cosCredentials": {
    "endpoint": "string",
    "accessKey": "string",
    "secretKey": "string",
    "sessionToken": "string",
    "taskAuthToken": "string",
    "taskAuthEndpoint": "string",
    "taskAuthExpiration": "string"
  }
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Composer.DataImport.ImportParamsDTO

false

the import params to use to get the file headers.

» name

body

string¦null

false

none

» importType

body

string

false

none

» hasHeader

body

boolean

false

none

» table

body

string¦null

false

none

» columnMatchings

body

RESTAPI.v1.DTOs.ColumnMatchingsDTO

false

none

»» columns

body

[string]¦null

false

none

»» matched

body

[string]¦null

false

none

» dateFormat

body

string

false

none

» listSubitems

body

[string]¦null

false

none

» subitemMap

body

object¦null

false

none

»» additionalProperties

body

RESTAPI.v1.DTOs.Composer.DataImport.SubitemDTO

false

none

»»» name

body

[string]¦null

false

none

»»» fieldName

body

[string]¦null

false

none

»»» type

body

string

false

none

»»» delimiter

body

string¦null

false

none

»»» segment

body

integer(int32)

false

none

»»» selection

body

[string]¦null

false

none

»»» fieldIndices

body

[integer]¦null

false

none

» addMember

body

boolean

false

none

» updateExistingRows

body

boolean

false

none

» tableType

body

string

false

none

» isLocal

body

boolean

false

none

» localCulture

body

System.IFormatProvider

false

none

» useIncrementalImport

body

boolean

false

none

» culture

body

string¦null

false

none

» tableEffectiveDated

body

boolean

false

none

» isODBCTextDriver

body

boolean

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

» fileOverwrite

body

boolean

false

none

» importId

body

integer(int32)

false

none

» filename

body

string¦null

false

none

» localPath

body

string¦null

false

none

» username

body

string¦null

false

none

» password

body

string¦null

false

none

» delimiter

body

string

false

none

» sheetName

body

string¦null

false

none

» cellRange

body

string¦null

false

none

» query

body

string¦null

false

none

» queryTimeout

body

integer(int32)

false

none

» connectionString

body

string¦null

false

none

» useAdvanced

body

boolean

false

none

» model

body

string¦null

false

none

» importMethod

body

integer(int32)

false

none

» sourceTableName

body

string¦null

false

none

» securityToken

body

string¦null

false

none

» customColumns

body

[string]¦null

false

none

» userSelected

body

boolean

false

none

» sandbox

body

boolean

false

none

» fileLocation

body

string¦null

false

none

» codePage

body

integer(int32)

false

none

» ignoreFirst

body

boolean

false

none

» ignoreLast

body

boolean

false

none

» recordLength

body

integer(int32)

false

none

» fields

body

[RESTAPI.v1.DTOs.Composer.DataImport.EBCDICFieldDTO]¦null

false

none

»» name

body

string¦null

false

none

»» offset

body

integer(int32)

false

none

»» length

body

integer(int32)

false

none

»» dataType

body

string

false

none

» selectRowNode

body

string¦null

false

none

» pipeConnection

body

Varicent.RESTAPI.v1.DTOs.Symon.PipeConnectionDTO

false

none

»» pipeID

body

string¦null

false

none

»» inputID

body

string¦null

false

none

»» outputID

body

string¦null

false

none

»» outputName

body

string¦null

false

none

»» lastValidated

body

string(date-time)

false

none

»» inputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»»» source

body

string¦null

false

none

»»» destination

body

string¦null

false

none

»»» type

body

string

false

none

»» outputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

» inputTable

body

string¦null

false

none

» uploadStage

body

boolean

false

none

» predictStage

body

boolean

false

none

» downloadStage

body

boolean

false

none

» symonImportType

body

string

false

none

» refreshAllPipeDatasources

body

boolean

false

none

» connectorID

body

string¦null

false

none

» streamID

body

string¦null

false

none

» importConfig

body

any

false

none

» outputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

» cosLocations

body

[RESTAPI.v1.DTOs.Symon.CosLocationDTO]¦null

false

none

»» bucket

body

string¦null

false

none

»» key

body

string¦null

false

none

» cosCredentials

body

RESTAPI.v1.DTOs.Composer.DataImport.CosCredentialsDTO

false

none

»» endpoint

body

string¦null

false

none

»» accessKey

body

string¦null

false

none

»» secretKey

body

string¦null

false

none

»» sessionToken

body

string¦null

false

none

»» taskAuthToken

body

string¦null

false

none

»» taskAuthEndpoint

body

string¦null

false

none

»» taskAuthExpiration

body

string¦null

false

none

Enumerated Values

Parameter

Value

» importType

None

» importType

Text

» importType

Excel

» importType

DBImport

» importType

Salesforce

» importType

MSCRM

» importType

EBCDICText

» importType

TerrAlign

» importType

XML

» importType

ODBCImport

» importType

SymonImport

» importType

SymonConnectorImport

» importType

Cos

» importType

SQLServer

» importType

Dynamics

» importType

GoogleSheets

» importType

MySql

» importType

AmazonAurora

» importType

AmazonS3

» importType

Snowflake

» importType

Shopify

» importType

Hubspot

» importType

Oracle

» importType

AmazonRedshift

» importType

Workday

» dateFormat

Default

» dateFormat

DayFirst

» dateFormat

MonthFirst

»»» type

Delimited

»»» type

Selection

»»» type

Merged

» tableType

System

» tableType

Dimension

» tableType

Structural

» tableType

Lookup

» tableType

Data

» tableType

View

» tableType

Custom

» tableType

StarSchema

» tableType

ExportTable

» tableType

CreditingRule

» tableType

AssignTable

» tableType

PlcmCustomTable

» tableType

PlcmStructuralTable

» tableType

PlcmTable

» tableType

DataSource

» tableType

Cached

» tableType

MaterializedView

»» dataType

String

»» dataType

Decimal

»»» type

String

»»» type

Number

»»» type

Boolean

»»» type

Date

» symonImportType

None

» symonImportType

Text

» symonImportType

Excel

» symonImportType

DBImport

» symonImportType

Salesforce

» symonImportType

MSCRM

» symonImportType

EBCDICText

» symonImportType

TerrAlign

» symonImportType

XML

» symonImportType

ODBCImport

» symonImportType

SymonImport

» symonImportType

SymonConnectorImport

» symonImportType

Cos

» symonImportType

SQLServer

» symonImportType

Dynamics

» symonImportType

GoogleSheets

» symonImportType

MySql

» symonImportType

AmazonAurora

» symonImportType

AmazonS3

» symonImportType

Snowflake

» symonImportType

Shopify

» symonImportType

Hubspot

» symonImportType

Oracle

» symonImportType

AmazonRedshift

» symonImportType

Workday

Responses

Status

Meaning

Description

Schema

200

OK

The column headers were obtained.

Inline

400

Bad Request

Import file was not found on the server.

None

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/imports/getheaders", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/imports/getheaders");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "name": "string",
  "importType": "None",
  "hasHeader": true,
  "table": "string",
  "columnMatchings": {
    "columns": [
      "string"
    ],
    "matched": [
      "string"
    ]
  },
  "dateFormat": "Default",
  "listSubitems": [
    "string"
  ],
  "subitemMap": {
    "property1": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    },
    "property2": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    }
  },
  "addMember": true,
  "updateExistingRows": true,
  "tableType": "System",
  "isLocal": true,
  "localCulture": {},
  "useIncrementalImport": true,
  "culture": "string",
  "tableEffectiveDated": true,
  "isODBCTextDriver": true,
  "version": {
    "rowVersion": 0
  },
  "fileOverwrite": true,
  "importId": 0,
  "filename": "string",
  "localPath": "string",
  "username": "string",
  "password": "string",
  "delimiter": "string",
  "sheetName": "string",
  "cellRange": "string",
  "query": "string",
  "queryTimeout": 0,
  "connectionString": "string",
  "useAdvanced": true,
  "model": "string",
  "importMethod": 0,
  "sourceTableName": "string",
  "securityToken": "string",
  "customColumns": [
    "string"
  ],
  "userSelected": true,
  "sandbox": true,
  "fileLocation": "string",
  "codePage": 0,
  "ignoreFirst": true,
  "ignoreLast": true,
  "recordLength": 0,
  "fields": [
    {
      "name": "string",
      "offset": 0,
      "length": 0,
      "dataType": "String"
    }
  ],
  "selectRowNode": "string",
  "pipeConnection": {
    "pipeID": "string",
    "inputID": "string",
    "outputID": "string",
    "outputName": "string",
    "lastValidated": "2019-08-24T14:15:22Z",
    "inputMapping": [
      {}
    ],
    "outputMapping": [
      {}
    ]
  },
  "inputTable": "string",
  "uploadStage": true,
  "predictStage": true,
  "downloadStage": true,
  "symonImportType": "None",
  "refreshAllPipeDatasources": true,
  "connectorID": "string",
  "streamID": "string",
  "importConfig": null,
  "outputMapping": [
    {
      "source": "string",
      "destination": "string",
      "type": "String"
    }
  ],
  "cosLocations": [
    {
      "bucket": "string",
      "key": "string"
    }
  ],
  "cosCredentials": {
    "endpoint": "string",
    "accessKey": "string",
    "secretKey": "string",
    "sessionToken": "string",
    "taskAuthToken": "string",
    "taskAuthEndpoint": "string",
    "taskAuthExpiration": "string"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/imports/getheaders',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/imports/getheaders', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/imports/getheaders',
  params: {
  }, headers: headers

p JSON.parse(result)

RemoteImportsControllerV1_GetDBPreview

Body parameter

{
  "importParams": {
    "name": "string",
    "importType": "None",
    "hasHeader": true,
    "table": "string",
    "columnMatchings": {
      "columns": [],
      "matched": []
    },
    "dateFormat": "Default",
    "listSubitems": [
      "string"
    ],
    "subitemMap": {
      "property1": {},
      "property2": {}
    },
    "addMember": true,
    "updateExistingRows": true,
    "tableType": "System",
    "isLocal": true,
    "localCulture": {},
    "useIncrementalImport": true,
    "culture": "string",
    "tableEffectiveDated": true,
    "isODBCTextDriver": true,
    "version": {
      "rowVersion": 0
    },
    "fileOverwrite": true,
    "importId": 0,
    "filename": "string",
    "localPath": "string",
    "username": "string",
    "password": "string",
    "delimiter": "string",
    "sheetName": "string",
    "cellRange": "string",
    "query": "string",
    "queryTimeout": 0,
    "connectionString": "string",
    "useAdvanced": true,
    "model": "string",
    "importMethod": 0,
    "sourceTableName": "string",
    "securityToken": "string",
    "customColumns": [
      "string"
    ],
    "userSelected": true,
    "sandbox": true,
    "fileLocation": "string",
    "codePage": 0,
    "ignoreFirst": true,
    "ignoreLast": true,
    "recordLength": 0,
    "fields": [
      {}
    ],
    "selectRowNode": "string",
    "pipeConnection": {
      "pipeID": "string",
      "inputID": "string",
      "outputID": "string",
      "outputName": "string",
      "lastValidated": "2019-08-24T14:15:22Z",
      "inputMapping": [],
      "outputMapping": []
    },
    "inputTable": "string",
    "uploadStage": true,
    "predictStage": true,
    "downloadStage": true,
    "symonImportType": "None",
    "refreshAllPipeDatasources": true,
    "connectorID": "string",
    "streamID": "string",
    "importConfig": null,
    "outputMapping": [
      {}
    ],
    "cosLocations": [
      {}
    ],
    "cosCredentials": {
      "endpoint": "string",
      "accessKey": "string",
      "secretKey": "string",
      "sessionToken": "string",
      "taskAuthToken": "string",
      "taskAuthEndpoint": "string",
      "taskAuthExpiration": "string"
    }
  },
  "numLines": 0
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Composer.DataImport.ImportPreviewDTO

false

none

» importParams

body

RESTAPI.v1.DTOs.Composer.DataImport.ImportParamsDTO

false

none

»» name

body

string¦null

false

none

»» importType

body

string

false

none

»» hasHeader

body

boolean

false

none

»» table

body

string¦null

false

none

»» columnMatchings

body

RESTAPI.v1.DTOs.ColumnMatchingsDTO

false

none

»»» columns

body

[string]¦null

false

none

»»» matched

body

[string]¦null

false

none

»» dateFormat

body

string

false

none

»» listSubitems

body

[string]¦null

false

none

»» subitemMap

body

object¦null

false

none

»»» additionalProperties

body

RESTAPI.v1.DTOs.Composer.DataImport.SubitemDTO

false

none

»»»» name

body

[string]¦null

false

none

»»»» fieldName

body

[string]¦null

false

none

»»»» type

body

string

false

none

»»»» delimiter

body

string¦null

false

none

»»»» segment

body

integer(int32)

false

none

»»»» selection

body

[string]¦null

false

none

»»»» fieldIndices

body

[integer]¦null

false

none

»» addMember

body

boolean

false

none

»» updateExistingRows

body

boolean

false

none

»» tableType

body

string

false

none

»» isLocal

body

boolean

false

none

»» localCulture

body

System.IFormatProvider

false

none

»» useIncrementalImport

body

boolean

false

none

»» culture

body

string¦null

false

none

»» tableEffectiveDated

body

boolean

false

none

»» isODBCTextDriver

body

boolean

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» rowVersion

body

integer(int64)

false

none

»» fileOverwrite

body

boolean

false

none

»» importId

body

integer(int32)

false

none

»» filename

body

string¦null

false

none

»» localPath

body

string¦null

false

none

»» username

body

string¦null

false

none

»» password

body

string¦null

false

none

»» delimiter

body

string

false

none

»» sheetName

body

string¦null

false

none

»» cellRange

body

string¦null

false

none

»» query

body

string¦null

false

none

»» queryTimeout

body

integer(int32)

false

none

»» connectionString

body

string¦null

false

none

»» useAdvanced

body

boolean

false

none

»» model

body

string¦null

false

none

»» importMethod

body

integer(int32)

false

none

»» sourceTableName

body

string¦null

false

none

»» securityToken

body

string¦null

false

none

»» customColumns

body

[string]¦null

false

none

»» userSelected

body

boolean

false

none

»» sandbox

body

boolean

false

none

»» fileLocation

body

string¦null

false

none

»» codePage

body

integer(int32)

false

none

»» ignoreFirst

body

boolean

false

none

»» ignoreLast

body

boolean

false

none

»» recordLength

body

integer(int32)

false

none

»» fields

body

[RESTAPI.v1.DTOs.Composer.DataImport.EBCDICFieldDTO]¦null

false

none

»»» name

body

string¦null

false

none

»»» offset

body

integer(int32)

false

none

»»» length

body

integer(int32)

false

none

»»» dataType

body

string

false

none

»» selectRowNode

body

string¦null

false

none

»» pipeConnection

body

Varicent.RESTAPI.v1.DTOs.Symon.PipeConnectionDTO

false

none

»»» pipeID

body

string¦null

false

none

»»» inputID

body

string¦null

false

none

»»» outputID

body

string¦null

false

none

»»» outputName

body

string¦null

false

none

»»» lastValidated

body

string(date-time)

false

none

»»» inputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»»»» source

body

string¦null

false

none

»»»» destination

body

string¦null

false

none

»»»» type

body

string

false

none

»»» outputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»» inputTable

body

string¦null

false

none

»» uploadStage

body

boolean

false

none

»» predictStage

body

boolean

false

none

»» downloadStage

body

boolean

false

none

»» symonImportType

body

string

false

none

»» refreshAllPipeDatasources

body

boolean

false

none

»» connectorID

body

string¦null

false

none

»» streamID

body

string¦null

false

none

»» importConfig

body

any

false

none

»» outputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»» cosLocations

body

[RESTAPI.v1.DTOs.Symon.CosLocationDTO]¦null

false

none

»»» bucket

body

string¦null

false

none

»»» key

body

string¦null

false

none

»» cosCredentials

body

RESTAPI.v1.DTOs.Composer.DataImport.CosCredentialsDTO

false

none

»»» endpoint

body

string¦null

false

none

»»» accessKey

body

string¦null

false

none

»»» secretKey

body

string¦null

false

none

»»» sessionToken

body

string¦null

false

none

»»» taskAuthToken

body

string¦null

false

none

»»» taskAuthEndpoint

body

string¦null

false

none

»»» taskAuthExpiration

body

string¦null

false

none

» numLines

body

integer(int32)

false

none

Enumerated Values

Parameter

Value

»» importType

None

»» importType

Text

»» importType

Excel

»» importType

DBImport

»» importType

Salesforce

»» importType

MSCRM

»» importType

EBCDICText

»» importType

TerrAlign

»» importType

XML

»» importType

ODBCImport

»» importType

SymonImport

»» importType

SymonConnectorImport

»» importType

Cos

»» importType

SQLServer

»» importType

Dynamics

»» importType

GoogleSheets

»» importType

MySql

»» importType

AmazonAurora

»» importType

AmazonS3

»» importType

Snowflake

»» importType

Shopify

»» importType

Hubspot

»» importType

Oracle

»» importType

AmazonRedshift

»» importType

Workday

»» dateFormat

Default

»» dateFormat

DayFirst

»» dateFormat

MonthFirst

»»»» type

Delimited

»»»» type

Selection

»»»» type

Merged

»» tableType

System

»» tableType

Dimension

»» tableType

Structural

»» tableType

Lookup

»» tableType

Data

»» tableType

View

»» tableType

Custom

»» tableType

StarSchema

»» tableType

ExportTable

»» tableType

CreditingRule

»» tableType

AssignTable

»» tableType

PlcmCustomTable

»» tableType

PlcmStructuralTable

»» tableType

PlcmTable

»» tableType

DataSource

»» tableType

Cached

»» tableType

MaterializedView

»»» dataType

String

»»» dataType

Decimal

»»»» type

String

»»»» type

Number

»»»» type

Boolean

»»»» type

Date

»» symonImportType

None

»» symonImportType

Text

»» symonImportType

Excel

»» symonImportType

DBImport

»» symonImportType

Salesforce

»» symonImportType

MSCRM

»» symonImportType

EBCDICText

»» symonImportType

TerrAlign

»» symonImportType

XML

»» symonImportType

ODBCImport

»» symonImportType

SymonImport

»» symonImportType

SymonConnectorImport

»» symonImportType

Cos

»» symonImportType

SQLServer

»» symonImportType

Dynamics

»» symonImportType

GoogleSheets

»» symonImportType

MySql

»» symonImportType

AmazonAurora

»» symonImportType

AmazonS3

»» symonImportType

Snowflake

»» symonImportType

Shopify

»» symonImportType

Hubspot

»» symonImportType

Oracle

»» symonImportType

AmazonRedshift

»» symonImportType

Workday

Responses

Status

Meaning

Description

Schema

200

OK

The data was obtained.

Inline

400

Bad Request

The query could not be run.

None

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/imports/getdbpreview", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/imports/getdbpreview");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "importParams": {
    "name": "string",
    "importType": "None",
    "hasHeader": true,
    "table": "string",
    "columnMatchings": {
      "columns": [],
      "matched": []
    },
    "dateFormat": "Default",
    "listSubitems": [
      "string"
    ],
    "subitemMap": {
      "property1": {},
      "property2": {}
    },
    "addMember": true,
    "updateExistingRows": true,
    "tableType": "System",
    "isLocal": true,
    "localCulture": {},
    "useIncrementalImport": true,
    "culture": "string",
    "tableEffectiveDated": true,
    "isODBCTextDriver": true,
    "version": {
      "rowVersion": 0
    },
    "fileOverwrite": true,
    "importId": 0,
    "filename": "string",
    "localPath": "string",
    "username": "string",
    "password": "string",
    "delimiter": "string",
    "sheetName": "string",
    "cellRange": "string",
    "query": "string",
    "queryTimeout": 0,
    "connectionString": "string",
    "useAdvanced": true,
    "model": "string",
    "importMethod": 0,
    "sourceTableName": "string",
    "securityToken": "string",
    "customColumns": [
      "string"
    ],
    "userSelected": true,
    "sandbox": true,
    "fileLocation": "string",
    "codePage": 0,
    "ignoreFirst": true,
    "ignoreLast": true,
    "recordLength": 0,
    "fields": [
      {}
    ],
    "selectRowNode": "string",
    "pipeConnection": {
      "pipeID": "string",
      "inputID": "string",
      "outputID": "string",
      "outputName": "string",
      "lastValidated": "2019-08-24T14:15:22Z",
      "inputMapping": [],
      "outputMapping": []
    },
    "inputTable": "string",
    "uploadStage": true,
    "predictStage": true,
    "downloadStage": true,
    "symonImportType": "None",
    "refreshAllPipeDatasources": true,
    "connectorID": "string",
    "streamID": "string",
    "importConfig": null,
    "outputMapping": [
      {}
    ],
    "cosLocations": [
      {}
    ],
    "cosCredentials": {
      "endpoint": "string",
      "accessKey": "string",
      "secretKey": "string",
      "sessionToken": "string",
      "taskAuthToken": "string",
      "taskAuthEndpoint": "string",
      "taskAuthExpiration": "string"
    }
  },
  "numLines": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/imports/getdbpreview',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/imports/getdbpreview', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/imports/getdbpreview',
  params: {
  }, headers: headers

p JSON.parse(result)

RemoteImportsControllerV1_GetTextPreview

Body parameter

{
  "importParams": {
    "name": "string",
    "importType": "None",
    "hasHeader": true,
    "table": "string",
    "columnMatchings": {
      "columns": [],
      "matched": []
    },
    "dateFormat": "Default",
    "listSubitems": [
      "string"
    ],
    "subitemMap": {
      "property1": {},
      "property2": {}
    },
    "addMember": true,
    "updateExistingRows": true,
    "tableType": "System",
    "isLocal": true,
    "localCulture": {},
    "useIncrementalImport": true,
    "culture": "string",
    "tableEffectiveDated": true,
    "isODBCTextDriver": true,
    "version": {
      "rowVersion": 0
    },
    "fileOverwrite": true,
    "importId": 0,
    "filename": "string",
    "localPath": "string",
    "username": "string",
    "password": "string",
    "delimiter": "string",
    "sheetName": "string",
    "cellRange": "string",
    "query": "string",
    "queryTimeout": 0,
    "connectionString": "string",
    "useAdvanced": true,
    "model": "string",
    "importMethod": 0,
    "sourceTableName": "string",
    "securityToken": "string",
    "customColumns": [
      "string"
    ],
    "userSelected": true,
    "sandbox": true,
    "fileLocation": "string",
    "codePage": 0,
    "ignoreFirst": true,
    "ignoreLast": true,
    "recordLength": 0,
    "fields": [
      {}
    ],
    "selectRowNode": "string",
    "pipeConnection": {
      "pipeID": "string",
      "inputID": "string",
      "outputID": "string",
      "outputName": "string",
      "lastValidated": "2019-08-24T14:15:22Z",
      "inputMapping": [],
      "outputMapping": []
    },
    "inputTable": "string",
    "uploadStage": true,
    "predictStage": true,
    "downloadStage": true,
    "symonImportType": "None",
    "refreshAllPipeDatasources": true,
    "connectorID": "string",
    "streamID": "string",
    "importConfig": null,
    "outputMapping": [
      {}
    ],
    "cosLocations": [
      {}
    ],
    "cosCredentials": {
      "endpoint": "string",
      "accessKey": "string",
      "secretKey": "string",
      "sessionToken": "string",
      "taskAuthToken": "string",
      "taskAuthEndpoint": "string",
      "taskAuthExpiration": "string"
    }
  },
  "numLines": 0
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Composer.DataImport.ImportPreviewDTO

false

none

» importParams

body

RESTAPI.v1.DTOs.Composer.DataImport.ImportParamsDTO

false

none

»» name

body

string¦null

false

none

»» importType

body

string

false

none

»» hasHeader

body

boolean

false

none

»» table

body

string¦null

false

none

»» columnMatchings

body

RESTAPI.v1.DTOs.ColumnMatchingsDTO

false

none

»»» columns

body

[string]¦null

false

none

»»» matched

body

[string]¦null

false

none

»» dateFormat

body

string

false

none

»» listSubitems

body

[string]¦null

false

none

»» subitemMap

body

object¦null

false

none

»»» additionalProperties

body

RESTAPI.v1.DTOs.Composer.DataImport.SubitemDTO

false

none

»»»» name

body

[string]¦null

false

none

»»»» fieldName

body

[string]¦null

false

none

»»»» type

body

string

false

none

»»»» delimiter

body

string¦null

false

none

»»»» segment

body

integer(int32)

false

none

»»»» selection

body

[string]¦null

false

none

»»»» fieldIndices

body

[integer]¦null

false

none

»» addMember

body

boolean

false

none

»» updateExistingRows

body

boolean

false

none

»» tableType

body

string

false

none

»» isLocal

body

boolean

false

none

»» localCulture

body

System.IFormatProvider

false

none

»» useIncrementalImport

body

boolean

false

none

»» culture

body

string¦null

false

none

»» tableEffectiveDated

body

boolean

false

none

»» isODBCTextDriver

body

boolean

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» rowVersion

body

integer(int64)

false

none

»» fileOverwrite

body

boolean

false

none

»» importId

body

integer(int32)

false

none

»» filename

body

string¦null

false

none

»» localPath

body

string¦null

false

none

»» username

body

string¦null

false

none

»» password

body

string¦null

false

none

»» delimiter

body

string

false

none

»» sheetName

body

string¦null

false

none

»» cellRange

body

string¦null

false

none

»» query

body

string¦null

false

none

»» queryTimeout

body

integer(int32)

false

none

»» connectionString

body

string¦null

false

none

»» useAdvanced

body

boolean

false

none

»» model

body

string¦null

false

none

»» importMethod

body

integer(int32)

false

none

»» sourceTableName

body

string¦null

false

none

»» securityToken

body

string¦null

false

none

»» customColumns

body

[string]¦null

false

none

»» userSelected

body

boolean

false

none

»» sandbox

body

boolean

false

none

»» fileLocation

body

string¦null

false

none

»» codePage

body

integer(int32)

false

none

»» ignoreFirst

body

boolean

false

none

»» ignoreLast

body

boolean

false

none

»» recordLength

body

integer(int32)

false

none

»» fields

body

[RESTAPI.v1.DTOs.Composer.DataImport.EBCDICFieldDTO]¦null

false

none

»»» name

body

string¦null

false

none

»»» offset

body

integer(int32)

false

none

»»» length

body

integer(int32)

false

none

»»» dataType

body

string

false

none

»» selectRowNode

body

string¦null

false

none

»» pipeConnection

body

Varicent.RESTAPI.v1.DTOs.Symon.PipeConnectionDTO

false

none

»»» pipeID

body

string¦null

false

none

»»» inputID

body

string¦null

false

none

»»» outputID

body

string¦null

false

none

»»» outputName

body

string¦null

false

none

»»» lastValidated

body

string(date-time)

false

none

»»» inputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»»»» source

body

string¦null

false

none

»»»» destination

body

string¦null

false

none

»»»» type

body

string

false

none

»»» outputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»» inputTable

body

string¦null

false

none

»» uploadStage

body

boolean

false

none

»» predictStage

body

boolean

false

none

»» downloadStage

body

boolean

false

none

»» symonImportType

body

string

false

none

»» refreshAllPipeDatasources

body

boolean

false

none

»» connectorID

body

string¦null

false

none

»» streamID

body

string¦null

false

none

»» importConfig

body

any

false

none

»» outputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»» cosLocations

body

[RESTAPI.v1.DTOs.Symon.CosLocationDTO]¦null

false

none

»»» bucket

body

string¦null

false

none

»»» key

body

string¦null

false

none

»» cosCredentials

body

RESTAPI.v1.DTOs.Composer.DataImport.CosCredentialsDTO

false

none

»»» endpoint

body

string¦null

false

none

»»» accessKey

body

string¦null

false

none

»»» secretKey

body

string¦null

false

none

»»» sessionToken

body

string¦null

false

none

»»» taskAuthToken

body

string¦null

false

none

»»» taskAuthEndpoint

body

string¦null

false

none

»»» taskAuthExpiration

body

string¦null

false

none

» numLines

body

integer(int32)

false

none

Enumerated Values

Parameter

Value

»» importType

None

»» importType

Text

»» importType

Excel

»» importType

DBImport

»» importType

Salesforce

»» importType

MSCRM

»» importType

EBCDICText

»» importType

TerrAlign

»» importType

XML

»» importType

ODBCImport

»» importType

SymonImport

»» importType

SymonConnectorImport

»» importType

Cos

»» importType

SQLServer

»» importType

Dynamics

»» importType

GoogleSheets

»» importType

MySql

»» importType

AmazonAurora

»» importType

AmazonS3

»» importType

Snowflake

»» importType

Shopify

»» importType

Hubspot

»» importType

Oracle

»» importType

AmazonRedshift

»» importType

Workday

»» dateFormat

Default

»» dateFormat

DayFirst

»» dateFormat

MonthFirst

»»»» type

Delimited

»»»» type

Selection

»»»» type

Merged

»» tableType

System

»» tableType

Dimension

»» tableType

Structural

»» tableType

Lookup

»» tableType

Data

»» tableType

View

»» tableType

Custom

»» tableType

StarSchema

»» tableType

ExportTable

»» tableType

CreditingRule

»» tableType

AssignTable

»» tableType

PlcmCustomTable

»» tableType

PlcmStructuralTable

»» tableType

PlcmTable

»» tableType

DataSource

»» tableType

Cached

»» tableType

MaterializedView

»»» dataType

String

»»» dataType

Decimal

»»»» type

String

»»»» type

Number

»»»» type

Boolean

»»»» type

Date

»» symonImportType

None

»» symonImportType

Text

»» symonImportType

Excel

»» symonImportType

DBImport

»» symonImportType

Salesforce

»» symonImportType

MSCRM

»» symonImportType

EBCDICText

»» symonImportType

TerrAlign

»» symonImportType

XML

»» symonImportType

ODBCImport

»» symonImportType

SymonImport

»» symonImportType

SymonConnectorImport

»» symonImportType

Cos

»» symonImportType

SQLServer

»» symonImportType

Dynamics

»» symonImportType

GoogleSheets

»» symonImportType

MySql

»» symonImportType

AmazonAurora

»» symonImportType

AmazonS3

»» symonImportType

Snowflake

»» symonImportType

Shopify

»» symonImportType

Hubspot

»» symonImportType

Oracle

»» symonImportType

AmazonRedshift

»» symonImportType

Workday

Responses

Status

Meaning

Description

Schema

200

OK

The preview was obtained.

Inline

400

Bad Request

The text file could not be found.

None

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/imports/gettextpreview", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/imports/gettextpreview");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "importParams": {
    "name": "string",
    "importType": "None",
    "hasHeader": true,
    "table": "string",
    "columnMatchings": {
      "columns": [],
      "matched": []
    },
    "dateFormat": "Default",
    "listSubitems": [
      "string"
    ],
    "subitemMap": {
      "property1": {},
      "property2": {}
    },
    "addMember": true,
    "updateExistingRows": true,
    "tableType": "System",
    "isLocal": true,
    "localCulture": {},
    "useIncrementalImport": true,
    "culture": "string",
    "tableEffectiveDated": true,
    "isODBCTextDriver": true,
    "version": {
      "rowVersion": 0
    },
    "fileOverwrite": true,
    "importId": 0,
    "filename": "string",
    "localPath": "string",
    "username": "string",
    "password": "string",
    "delimiter": "string",
    "sheetName": "string",
    "cellRange": "string",
    "query": "string",
    "queryTimeout": 0,
    "connectionString": "string",
    "useAdvanced": true,
    "model": "string",
    "importMethod": 0,
    "sourceTableName": "string",
    "securityToken": "string",
    "customColumns": [
      "string"
    ],
    "userSelected": true,
    "sandbox": true,
    "fileLocation": "string",
    "codePage": 0,
    "ignoreFirst": true,
    "ignoreLast": true,
    "recordLength": 0,
    "fields": [
      {}
    ],
    "selectRowNode": "string",
    "pipeConnection": {
      "pipeID": "string",
      "inputID": "string",
      "outputID": "string",
      "outputName": "string",
      "lastValidated": "2019-08-24T14:15:22Z",
      "inputMapping": [],
      "outputMapping": []
    },
    "inputTable": "string",
    "uploadStage": true,
    "predictStage": true,
    "downloadStage": true,
    "symonImportType": "None",
    "refreshAllPipeDatasources": true,
    "connectorID": "string",
    "streamID": "string",
    "importConfig": null,
    "outputMapping": [
      {}
    ],
    "cosLocations": [
      {}
    ],
    "cosCredentials": {
      "endpoint": "string",
      "accessKey": "string",
      "secretKey": "string",
      "sessionToken": "string",
      "taskAuthToken": "string",
      "taskAuthEndpoint": "string",
      "taskAuthExpiration": "string"
    }
  },
  "numLines": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/imports/gettextpreview',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/imports/gettextpreview', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/imports/gettextpreview',
  params: {
  }, headers: headers

p JSON.parse(result)

RemoteImportsControllerV1_GetSymonPreview

Body parameter

{
  "importParams": {
    "name": "string",
    "importType": "None",
    "hasHeader": true,
    "table": "string",
    "columnMatchings": {
      "columns": [],
      "matched": []
    },
    "dateFormat": "Default",
    "listSubitems": [
      "string"
    ],
    "subitemMap": {
      "property1": {},
      "property2": {}
    },
    "addMember": true,
    "updateExistingRows": true,
    "tableType": "System",
    "isLocal": true,
    "localCulture": {},
    "useIncrementalImport": true,
    "culture": "string",
    "tableEffectiveDated": true,
    "isODBCTextDriver": true,
    "version": {
      "rowVersion": 0
    },
    "fileOverwrite": true,
    "importId": 0,
    "filename": "string",
    "localPath": "string",
    "username": "string",
    "password": "string",
    "delimiter": "string",
    "sheetName": "string",
    "cellRange": "string",
    "query": "string",
    "queryTimeout": 0,
    "connectionString": "string",
    "useAdvanced": true,
    "model": "string",
    "importMethod": 0,
    "sourceTableName": "string",
    "securityToken": "string",
    "customColumns": [
      "string"
    ],
    "userSelected": true,
    "sandbox": true,
    "fileLocation": "string",
    "codePage": 0,
    "ignoreFirst": true,
    "ignoreLast": true,
    "recordLength": 0,
    "fields": [
      {}
    ],
    "selectRowNode": "string",
    "pipeConnection": {
      "pipeID": "string",
      "inputID": "string",
      "outputID": "string",
      "outputName": "string",
      "lastValidated": "2019-08-24T14:15:22Z",
      "inputMapping": [],
      "outputMapping": []
    },
    "inputTable": "string",
    "uploadStage": true,
    "predictStage": true,
    "downloadStage": true,
    "symonImportType": "None",
    "refreshAllPipeDatasources": true,
    "connectorID": "string",
    "streamID": "string",
    "importConfig": null,
    "outputMapping": [
      {}
    ],
    "cosLocations": [
      {}
    ],
    "cosCredentials": {
      "endpoint": "string",
      "accessKey": "string",
      "secretKey": "string",
      "sessionToken": "string",
      "taskAuthToken": "string",
      "taskAuthEndpoint": "string",
      "taskAuthExpiration": "string"
    }
  },
  "numLines": 0
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Composer.DataImport.ImportPreviewDTO

false

none

» importParams

body

RESTAPI.v1.DTOs.Composer.DataImport.ImportParamsDTO

false

none

»» name

body

string¦null

false

none

»» importType

body

string

false

none

»» hasHeader

body

boolean

false

none

»» table

body

string¦null

false

none

»» columnMatchings

body

RESTAPI.v1.DTOs.ColumnMatchingsDTO

false

none

»»» columns

body

[string]¦null

false

none

»»» matched

body

[string]¦null

false

none

»» dateFormat

body

string

false

none

»» listSubitems

body

[string]¦null

false

none

»» subitemMap

body

object¦null

false

none

»»» additionalProperties

body

RESTAPI.v1.DTOs.Composer.DataImport.SubitemDTO

false

none

»»»» name

body

[string]¦null

false

none

»»»» fieldName

body

[string]¦null

false

none

»»»» type

body

string

false

none

»»»» delimiter

body

string¦null

false

none

»»»» segment

body

integer(int32)

false

none

»»»» selection

body

[string]¦null

false

none

»»»» fieldIndices

body

[integer]¦null

false

none

»» addMember

body

boolean

false

none

»» updateExistingRows

body

boolean

false

none

»» tableType

body

string

false

none

»» isLocal

body

boolean

false

none

»» localCulture

body

System.IFormatProvider

false

none

»» useIncrementalImport

body

boolean

false

none

»» culture

body

string¦null

false

none

»» tableEffectiveDated

body

boolean

false

none

»» isODBCTextDriver

body

boolean

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» rowVersion

body

integer(int64)

false

none

»» fileOverwrite

body

boolean

false

none

»» importId

body

integer(int32)

false

none

»» filename

body

string¦null

false

none

»» localPath

body

string¦null

false

none

»» username

body

string¦null

false

none

»» password

body

string¦null

false

none

»» delimiter

body

string

false

none

»» sheetName

body

string¦null

false

none

»» cellRange

body

string¦null

false

none

»» query

body

string¦null

false

none

»» queryTimeout

body

integer(int32)

false

none

»» connectionString

body

string¦null

false

none

»» useAdvanced

body

boolean

false

none

»» model

body

string¦null

false

none

»» importMethod

body

integer(int32)

false

none

»» sourceTableName

body

string¦null

false

none

»» securityToken

body

string¦null

false

none

»» customColumns

body

[string]¦null

false

none

»» userSelected

body

boolean

false

none

»» sandbox

body

boolean

false

none

»» fileLocation

body

string¦null

false

none

»» codePage

body

integer(int32)

false

none

»» ignoreFirst

body

boolean

false

none

»» ignoreLast

body

boolean

false

none

»» recordLength

body

integer(int32)

false

none

»» fields

body

[RESTAPI.v1.DTOs.Composer.DataImport.EBCDICFieldDTO]¦null

false

none

»»» name

body

string¦null

false

none

»»» offset

body

integer(int32)

false

none

»»» length

body

integer(int32)

false

none

»»» dataType

body

string

false

none

»» selectRowNode

body

string¦null

false

none

»» pipeConnection

body

Varicent.RESTAPI.v1.DTOs.Symon.PipeConnectionDTO

false

none

»»» pipeID

body

string¦null

false

none

»»» inputID

body

string¦null

false

none

»»» outputID

body

string¦null

false

none

»»» outputName

body

string¦null

false

none

»»» lastValidated

body

string(date-time)

false

none

»»» inputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»»»» source

body

string¦null

false

none

»»»» destination

body

string¦null

false

none

»»»» type

body

string

false

none

»»» outputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»» inputTable

body

string¦null

false

none

»» uploadStage

body

boolean

false

none

»» predictStage

body

boolean

false

none

»» downloadStage

body

boolean

false

none

»» symonImportType

body

string

false

none

»» refreshAllPipeDatasources

body

boolean

false

none

»» connectorID

body

string¦null

false

none

»» streamID

body

string¦null

false

none

»» importConfig

body

any

false

none

»» outputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»» cosLocations

body

[RESTAPI.v1.DTOs.Symon.CosLocationDTO]¦null

false

none

»»» bucket

body

string¦null

false

none

»»» key

body

string¦null

false

none

»» cosCredentials

body

RESTAPI.v1.DTOs.Composer.DataImport.CosCredentialsDTO

false

none

»»» endpoint

body

string¦null

false

none

»»» accessKey

body

string¦null

false

none

»»» secretKey

body

string¦null

false

none

»»» sessionToken

body

string¦null

false

none

»»» taskAuthToken

body

string¦null

false

none

»»» taskAuthEndpoint

body

string¦null

false

none

»»» taskAuthExpiration

body

string¦null

false

none

» numLines

body

integer(int32)

false

none

Enumerated Values

Parameter

Value

»» importType

None

»» importType

Text

»» importType

Excel

»» importType

DBImport

»» importType

Salesforce

»» importType

MSCRM

»» importType

EBCDICText

»» importType

TerrAlign

»» importType

XML

»» importType

ODBCImport

»» importType

SymonImport

»» importType

SymonConnectorImport

»» importType

Cos

»» importType

SQLServer

»» importType

Dynamics

»» importType

GoogleSheets

»» importType

MySql

»» importType

AmazonAurora

»» importType

AmazonS3

»» importType

Snowflake

»» importType

Shopify

»» importType

Hubspot

»» importType

Oracle

»» importType

AmazonRedshift

»» importType

Workday

»» dateFormat

Default

»» dateFormat

DayFirst

»» dateFormat

MonthFirst

»»»» type

Delimited

»»»» type

Selection

»»»» type

Merged

»» tableType

System

»» tableType

Dimension

»» tableType

Structural

»» tableType

Lookup

»» tableType

Data

»» tableType

View

»» tableType

Custom

»» tableType

StarSchema

»» tableType

ExportTable

»» tableType

CreditingRule

»» tableType

AssignTable

»» tableType

PlcmCustomTable

»» tableType

PlcmStructuralTable

»» tableType

PlcmTable

»» tableType

DataSource

»» tableType

Cached

»» tableType

MaterializedView

»»» dataType

String

»»» dataType

Decimal

»»»» type

String

»»»» type

Number

»»»» type

Boolean

»»»» type

Date

»» symonImportType

None

»» symonImportType

Text

»» symonImportType

Excel

»» symonImportType

DBImport

»» symonImportType

Salesforce

»» symonImportType

MSCRM

»» symonImportType

EBCDICText

»» symonImportType

TerrAlign

»» symonImportType

XML

»» symonImportType

ODBCImport

»» symonImportType

SymonImport

»» symonImportType

SymonConnectorImport

»» symonImportType

Cos

»» symonImportType

SQLServer

»» symonImportType

Dynamics

»» symonImportType

GoogleSheets

»» symonImportType

MySql

»» symonImportType

AmazonAurora

»» symonImportType

AmazonS3

»» symonImportType

Snowflake

»» symonImportType

Shopify

»» symonImportType

Hubspot

»» symonImportType

Oracle

»» symonImportType

AmazonRedshift

»» symonImportType

Workday

Responses

Status

Meaning

Description

Schema

200

OK

The preview was obtained.

Inline

400

Bad Request

The symon pipe could not be found.

None

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/imports/getsymonpreview", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/imports/getsymonpreview");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "importParams": {
    "name": "string",
    "importType": "None",
    "hasHeader": true,
    "table": "string",
    "columnMatchings": {
      "columns": [],
      "matched": []
    },
    "dateFormat": "Default",
    "listSubitems": [
      "string"
    ],
    "subitemMap": {
      "property1": {},
      "property2": {}
    },
    "addMember": true,
    "updateExistingRows": true,
    "tableType": "System",
    "isLocal": true,
    "localCulture": {},
    "useIncrementalImport": true,
    "culture": "string",
    "tableEffectiveDated": true,
    "isODBCTextDriver": true,
    "version": {
      "rowVersion": 0
    },
    "fileOverwrite": true,
    "importId": 0,
    "filename": "string",
    "localPath": "string",
    "username": "string",
    "password": "string",
    "delimiter": "string",
    "sheetName": "string",
    "cellRange": "string",
    "query": "string",
    "queryTimeout": 0,
    "connectionString": "string",
    "useAdvanced": true,
    "model": "string",
    "importMethod": 0,
    "sourceTableName": "string",
    "securityToken": "string",
    "customColumns": [
      "string"
    ],
    "userSelected": true,
    "sandbox": true,
    "fileLocation": "string",
    "codePage": 0,
    "ignoreFirst": true,
    "ignoreLast": true,
    "recordLength": 0,
    "fields": [
      {}
    ],
    "selectRowNode": "string",
    "pipeConnection": {
      "pipeID": "string",
      "inputID": "string",
      "outputID": "string",
      "outputName": "string",
      "lastValidated": "2019-08-24T14:15:22Z",
      "inputMapping": [],
      "outputMapping": []
    },
    "inputTable": "string",
    "uploadStage": true,
    "predictStage": true,
    "downloadStage": true,
    "symonImportType": "None",
    "refreshAllPipeDatasources": true,
    "connectorID": "string",
    "streamID": "string",
    "importConfig": null,
    "outputMapping": [
      {}
    ],
    "cosLocations": [
      {}
    ],
    "cosCredentials": {
      "endpoint": "string",
      "accessKey": "string",
      "secretKey": "string",
      "sessionToken": "string",
      "taskAuthToken": "string",
      "taskAuthEndpoint": "string",
      "taskAuthExpiration": "string"
    }
  },
  "numLines": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/imports/getsymonpreview',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/imports/getsymonpreview', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/imports/getsymonpreview',
  params: {
  }, headers: headers

p JSON.parse(result)

RemoteImportsControllerV1_GetSymonConnectorPreview

Body parameter

{
  "importParams": {
    "name": "string",
    "importType": "None",
    "hasHeader": true,
    "table": "string",
    "columnMatchings": {
      "columns": [],
      "matched": []
    },
    "dateFormat": "Default",
    "listSubitems": [
      "string"
    ],
    "subitemMap": {
      "property1": {},
      "property2": {}
    },
    "addMember": true,
    "updateExistingRows": true,
    "tableType": "System",
    "isLocal": true,
    "localCulture": {},
    "useIncrementalImport": true,
    "culture": "string",
    "tableEffectiveDated": true,
    "isODBCTextDriver": true,
    "version": {
      "rowVersion": 0
    },
    "fileOverwrite": true,
    "importId": 0,
    "filename": "string",
    "localPath": "string",
    "username": "string",
    "password": "string",
    "delimiter": "string",
    "sheetName": "string",
    "cellRange": "string",
    "query": "string",
    "queryTimeout": 0,
    "connectionString": "string",
    "useAdvanced": true,
    "model": "string",
    "importMethod": 0,
    "sourceTableName": "string",
    "securityToken": "string",
    "customColumns": [
      "string"
    ],
    "userSelected": true,
    "sandbox": true,
    "fileLocation": "string",
    "codePage": 0,
    "ignoreFirst": true,
    "ignoreLast": true,
    "recordLength": 0,
    "fields": [
      {}
    ],
    "selectRowNode": "string",
    "pipeConnection": {
      "pipeID": "string",
      "inputID": "string",
      "outputID": "string",
      "outputName": "string",
      "lastValidated": "2019-08-24T14:15:22Z",
      "inputMapping": [],
      "outputMapping": []
    },
    "inputTable": "string",
    "uploadStage": true,
    "predictStage": true,
    "downloadStage": true,
    "symonImportType": "None",
    "refreshAllPipeDatasources": true,
    "connectorID": "string",
    "streamID": "string",
    "importConfig": null,
    "outputMapping": [
      {}
    ],
    "cosLocations": [
      {}
    ],
    "cosCredentials": {
      "endpoint": "string",
      "accessKey": "string",
      "secretKey": "string",
      "sessionToken": "string",
      "taskAuthToken": "string",
      "taskAuthEndpoint": "string",
      "taskAuthExpiration": "string"
    }
  },
  "numLines": 0
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Composer.DataImport.ImportPreviewDTO

false

none

» importParams

body

RESTAPI.v1.DTOs.Composer.DataImport.ImportParamsDTO

false

none

»» name

body

string¦null

false

none

»» importType

body

string

false

none

»» hasHeader

body

boolean

false

none

»» table

body

string¦null

false

none

»» columnMatchings

body

RESTAPI.v1.DTOs.ColumnMatchingsDTO

false

none

»»» columns

body

[string]¦null

false

none

»»» matched

body

[string]¦null

false

none

»» dateFormat

body

string

false

none

»» listSubitems

body

[string]¦null

false

none

»» subitemMap

body

object¦null

false

none

»»» additionalProperties

body

RESTAPI.v1.DTOs.Composer.DataImport.SubitemDTO

false

none

»»»» name

body

[string]¦null

false

none

»»»» fieldName

body

[string]¦null

false

none

»»»» type

body

string

false

none

»»»» delimiter

body

string¦null

false

none

»»»» segment

body

integer(int32)

false

none

»»»» selection

body

[string]¦null

false

none

»»»» fieldIndices

body

[integer]¦null

false

none

»» addMember

body

boolean

false

none

»» updateExistingRows

body

boolean

false

none

»» tableType

body

string

false

none

»» isLocal

body

boolean

false

none

»» localCulture

body

System.IFormatProvider

false

none

»» useIncrementalImport

body

boolean

false

none

»» culture

body

string¦null

false

none

»» tableEffectiveDated

body

boolean

false

none

»» isODBCTextDriver

body

boolean

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» rowVersion

body

integer(int64)

false

none

»» fileOverwrite

body

boolean

false

none

»» importId

body

integer(int32)

false

none

»» filename

body

string¦null

false

none

»» localPath

body

string¦null

false

none

»» username

body

string¦null

false

none

»» password

body

string¦null

false

none

»» delimiter

body

string

false

none

»» sheetName

body

string¦null

false

none

»» cellRange

body

string¦null

false

none

»» query

body

string¦null

false

none

»» queryTimeout

body

integer(int32)

false

none

»» connectionString

body

string¦null

false

none

»» useAdvanced

body

boolean

false

none

»» model

body

string¦null

false

none

»» importMethod

body

integer(int32)

false

none

»» sourceTableName

body

string¦null

false

none

»» securityToken

body

string¦null

false

none

»» customColumns

body

[string]¦null

false

none

»» userSelected

body

boolean

false

none

»» sandbox

body

boolean

false

none

»» fileLocation

body

string¦null

false

none

»» codePage

body

integer(int32)

false

none

»» ignoreFirst

body

boolean

false

none

»» ignoreLast

body

boolean

false

none

»» recordLength

body

integer(int32)

false

none

»» fields

body

[RESTAPI.v1.DTOs.Composer.DataImport.EBCDICFieldDTO]¦null

false

none

»»» name

body

string¦null

false

none

»»» offset

body

integer(int32)

false

none

»»» length

body

integer(int32)

false

none

»»» dataType

body

string

false

none

»» selectRowNode

body

string¦null

false

none

»» pipeConnection

body

Varicent.RESTAPI.v1.DTOs.Symon.PipeConnectionDTO

false

none

»»» pipeID

body

string¦null

false

none

»»» inputID

body

string¦null

false

none

»»» outputID

body

string¦null

false

none

»»» outputName

body

string¦null

false

none

»»» lastValidated

body

string(date-time)

false

none

»»» inputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»»»» source

body

string¦null

false

none

»»»» destination

body

string¦null

false

none

»»»» type

body

string

false

none

»»» outputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»» inputTable

body

string¦null

false

none

»» uploadStage

body

boolean

false

none

»» predictStage

body

boolean

false

none

»» downloadStage

body

boolean

false

none

»» symonImportType

body

string

false

none

»» refreshAllPipeDatasources

body

boolean

false

none

»» connectorID

body

string¦null

false

none

»» streamID

body

string¦null

false

none

»» importConfig

body

any

false

none

»» outputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»» cosLocations

body

[RESTAPI.v1.DTOs.Symon.CosLocationDTO]¦null

false

none

»»» bucket

body

string¦null

false

none

»»» key

body

string¦null

false

none

»» cosCredentials

body

RESTAPI.v1.DTOs.Composer.DataImport.CosCredentialsDTO

false

none

»»» endpoint

body

string¦null

false

none

»»» accessKey

body

string¦null

false

none

»»» secretKey

body

string¦null

false

none

»»» sessionToken

body

string¦null

false

none

»»» taskAuthToken

body

string¦null

false

none

»»» taskAuthEndpoint

body

string¦null

false

none

»»» taskAuthExpiration

body

string¦null

false

none

» numLines

body

integer(int32)

false

none

Enumerated Values

Parameter

Value

»» importType

None

»» importType

Text

»» importType

Excel

»» importType

DBImport

»» importType

Salesforce

»» importType

MSCRM

»» importType

EBCDICText

»» importType

TerrAlign

»» importType

XML

»» importType

ODBCImport

»» importType

SymonImport

»» importType

SymonConnectorImport

»» importType

Cos

»» importType

SQLServer

»» importType

Dynamics

»» importType

GoogleSheets

»» importType

MySql

»» importType

AmazonAurora

»» importType

AmazonS3

»» importType

Snowflake

»» importType

Shopify

»» importType

Hubspot

»» importType

Oracle

»» importType

AmazonRedshift

»» importType

Workday

»» dateFormat

Default

»» dateFormat

DayFirst

»» dateFormat

MonthFirst

»»»» type

Delimited

»»»» type

Selection

»»»» type

Merged

»» tableType

System

»» tableType

Dimension

»» tableType

Structural

»» tableType

Lookup

»» tableType

Data

»» tableType

View

»» tableType

Custom

»» tableType

StarSchema

»» tableType

ExportTable

»» tableType

CreditingRule

»» tableType

AssignTable

»» tableType

PlcmCustomTable

»» tableType

PlcmStructuralTable

»» tableType

PlcmTable

»» tableType

DataSource

»» tableType

Cached

»» tableType

MaterializedView

»»» dataType

String

»»» dataType

Decimal

»»»» type

String

»»»» type

Number

»»»» type

Boolean

»»»» type

Date

»» symonImportType

None

»» symonImportType

Text

»» symonImportType

Excel

»» symonImportType

DBImport

»» symonImportType

Salesforce

»» symonImportType

MSCRM

»» symonImportType

EBCDICText

»» symonImportType

TerrAlign

»» symonImportType

XML

»» symonImportType

ODBCImport

»» symonImportType

SymonImport

»» symonImportType

SymonConnectorImport

»» symonImportType

Cos

»» symonImportType

SQLServer

»» symonImportType

Dynamics

»» symonImportType

GoogleSheets

»» symonImportType

MySql

»» symonImportType

AmazonAurora

»» symonImportType

AmazonS3

»» symonImportType

Snowflake

»» symonImportType

Shopify

»» symonImportType

Hubspot

»» symonImportType

Oracle

»» symonImportType

AmazonRedshift

»» symonImportType

Workday

Responses

Status

Meaning

Description

Schema

200

OK

The preview was obtained.

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/imports/getsymonconnectorpreview", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/imports/getsymonconnectorpreview");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "importParams": {
    "name": "string",
    "importType": "None",
    "hasHeader": true,
    "table": "string",
    "columnMatchings": {
      "columns": [],
      "matched": []
    },
    "dateFormat": "Default",
    "listSubitems": [
      "string"
    ],
    "subitemMap": {
      "property1": {},
      "property2": {}
    },
    "addMember": true,
    "updateExistingRows": true,
    "tableType": "System",
    "isLocal": true,
    "localCulture": {},
    "useIncrementalImport": true,
    "culture": "string",
    "tableEffectiveDated": true,
    "isODBCTextDriver": true,
    "version": {
      "rowVersion": 0
    },
    "fileOverwrite": true,
    "importId": 0,
    "filename": "string",
    "localPath": "string",
    "username": "string",
    "password": "string",
    "delimiter": "string",
    "sheetName": "string",
    "cellRange": "string",
    "query": "string",
    "queryTimeout": 0,
    "connectionString": "string",
    "useAdvanced": true,
    "model": "string",
    "importMethod": 0,
    "sourceTableName": "string",
    "securityToken": "string",
    "customColumns": [
      "string"
    ],
    "userSelected": true,
    "sandbox": true,
    "fileLocation": "string",
    "codePage": 0,
    "ignoreFirst": true,
    "ignoreLast": true,
    "recordLength": 0,
    "fields": [
      {}
    ],
    "selectRowNode": "string",
    "pipeConnection": {
      "pipeID": "string",
      "inputID": "string",
      "outputID": "string",
      "outputName": "string",
      "lastValidated": "2019-08-24T14:15:22Z",
      "inputMapping": [],
      "outputMapping": []
    },
    "inputTable": "string",
    "uploadStage": true,
    "predictStage": true,
    "downloadStage": true,
    "symonImportType": "None",
    "refreshAllPipeDatasources": true,
    "connectorID": "string",
    "streamID": "string",
    "importConfig": null,
    "outputMapping": [
      {}
    ],
    "cosLocations": [
      {}
    ],
    "cosCredentials": {
      "endpoint": "string",
      "accessKey": "string",
      "secretKey": "string",
      "sessionToken": "string",
      "taskAuthToken": "string",
      "taskAuthEndpoint": "string",
      "taskAuthExpiration": "string"
    }
  },
  "numLines": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/imports/getsymonconnectorpreview',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/imports/getsymonconnectorpreview', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/imports/getsymonconnectorpreview',
  params: {
  }, headers: headers

p JSON.parse(result)

RemoteImportsControllerV1_GetExcelPreview

Body parameter

{
  "importParams": {
    "name": "string",
    "importType": "None",
    "hasHeader": true,
    "table": "string",
    "columnMatchings": {
      "columns": [],
      "matched": []
    },
    "dateFormat": "Default",
    "listSubitems": [
      "string"
    ],
    "subitemMap": {
      "property1": {},
      "property2": {}
    },
    "addMember": true,
    "updateExistingRows": true,
    "tableType": "System",
    "isLocal": true,
    "localCulture": {},
    "useIncrementalImport": true,
    "culture": "string",
    "tableEffectiveDated": true,
    "isODBCTextDriver": true,
    "version": {
      "rowVersion": 0
    },
    "fileOverwrite": true,
    "importId": 0,
    "filename": "string",
    "localPath": "string",
    "username": "string",
    "password": "string",
    "delimiter": "string",
    "sheetName": "string",
    "cellRange": "string",
    "query": "string",
    "queryTimeout": 0,
    "connectionString": "string",
    "useAdvanced": true,
    "model": "string",
    "importMethod": 0,
    "sourceTableName": "string",
    "securityToken": "string",
    "customColumns": [
      "string"
    ],
    "userSelected": true,
    "sandbox": true,
    "fileLocation": "string",
    "codePage": 0,
    "ignoreFirst": true,
    "ignoreLast": true,
    "recordLength": 0,
    "fields": [
      {}
    ],
    "selectRowNode": "string",
    "pipeConnection": {
      "pipeID": "string",
      "inputID": "string",
      "outputID": "string",
      "outputName": "string",
      "lastValidated": "2019-08-24T14:15:22Z",
      "inputMapping": [],
      "outputMapping": []
    },
    "inputTable": "string",
    "uploadStage": true,
    "predictStage": true,
    "downloadStage": true,
    "symonImportType": "None",
    "refreshAllPipeDatasources": true,
    "connectorID": "string",
    "streamID": "string",
    "importConfig": null,
    "outputMapping": [
      {}
    ],
    "cosLocations": [
      {}
    ],
    "cosCredentials": {
      "endpoint": "string",
      "accessKey": "string",
      "secretKey": "string",
      "sessionToken": "string",
      "taskAuthToken": "string",
      "taskAuthEndpoint": "string",
      "taskAuthExpiration": "string"
    }
  },
  "numLines": 0
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Composer.DataImport.ImportPreviewDTO

false

none

» importParams

body

RESTAPI.v1.DTOs.Composer.DataImport.ImportParamsDTO

false

none

»» name

body

string¦null

false

none

»» importType

body

string

false

none

»» hasHeader

body

boolean

false

none

»» table

body

string¦null

false

none

»» columnMatchings

body

RESTAPI.v1.DTOs.ColumnMatchingsDTO

false

none

»»» columns

body

[string]¦null

false

none

»»» matched

body

[string]¦null

false

none

»» dateFormat

body

string

false

none

»» listSubitems

body

[string]¦null

false

none

»» subitemMap

body

object¦null

false

none

»»» additionalProperties

body

RESTAPI.v1.DTOs.Composer.DataImport.SubitemDTO

false

none

»»»» name

body

[string]¦null

false

none

»»»» fieldName

body

[string]¦null

false

none

»»»» type

body

string

false

none

»»»» delimiter

body

string¦null

false

none

»»»» segment

body

integer(int32)

false

none

»»»» selection

body

[string]¦null

false

none

»»»» fieldIndices

body

[integer]¦null

false

none

»» addMember

body

boolean

false

none

»» updateExistingRows

body

boolean

false

none

»» tableType

body

string

false

none

»» isLocal

body

boolean

false

none

»» localCulture

body

System.IFormatProvider

false

none

»» useIncrementalImport

body

boolean

false

none

»» culture

body

string¦null

false

none

»» tableEffectiveDated

body

boolean

false

none

»» isODBCTextDriver

body

boolean

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» rowVersion

body

integer(int64)

false

none

»» fileOverwrite

body

boolean

false

none

»» importId

body

integer(int32)

false

none

»» filename

body

string¦null

false

none

»» localPath

body

string¦null

false

none

»» username

body

string¦null

false

none

»» password

body

string¦null

false

none

»» delimiter

body

string

false

none

»» sheetName

body

string¦null

false

none

»» cellRange

body

string¦null

false

none

»» query

body

string¦null

false

none

»» queryTimeout

body

integer(int32)

false

none

»» connectionString

body

string¦null

false

none

»» useAdvanced

body

boolean

false

none

»» model

body

string¦null

false

none

»» importMethod

body

integer(int32)

false

none

»» sourceTableName

body

string¦null

false

none

»» securityToken

body

string¦null

false

none

»» customColumns

body

[string]¦null

false

none

»» userSelected

body

boolean

false

none

»» sandbox

body

boolean

false

none

»» fileLocation

body

string¦null

false

none

»» codePage

body

integer(int32)

false

none

»» ignoreFirst

body

boolean

false

none

»» ignoreLast

body

boolean

false

none

»» recordLength

body

integer(int32)

false

none

»» fields

body

[RESTAPI.v1.DTOs.Composer.DataImport.EBCDICFieldDTO]¦null

false

none

»»» name

body

string¦null

false

none

»»» offset

body

integer(int32)

false

none

»»» length

body

integer(int32)

false

none

»»» dataType

body

string

false

none

»» selectRowNode

body

string¦null

false

none

»» pipeConnection

body

Varicent.RESTAPI.v1.DTOs.Symon.PipeConnectionDTO

false

none

»»» pipeID

body

string¦null

false

none

»»» inputID

body

string¦null

false

none

»»» outputID

body

string¦null

false

none

»»» outputName

body

string¦null

false

none

»»» lastValidated

body

string(date-time)

false

none

»»» inputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»»»» source

body

string¦null

false

none

»»»» destination

body

string¦null

false

none

»»»» type

body

string

false

none

»»» outputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»» inputTable

body

string¦null

false

none

»» uploadStage

body

boolean

false

none

»» predictStage

body

boolean

false

none

»» downloadStage

body

boolean

false

none

»» symonImportType

body

string

false

none

»» refreshAllPipeDatasources

body

boolean

false

none

»» connectorID

body

string¦null

false

none

»» streamID

body

string¦null

false

none

»» importConfig

body

any

false

none

»» outputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»» cosLocations

body

[RESTAPI.v1.DTOs.Symon.CosLocationDTO]¦null

false

none

»»» bucket

body

string¦null

false

none

»»» key

body

string¦null

false

none

»» cosCredentials

body

RESTAPI.v1.DTOs.Composer.DataImport.CosCredentialsDTO

false

none

»»» endpoint

body

string¦null

false

none

»»» accessKey

body

string¦null

false

none

»»» secretKey

body

string¦null

false

none

»»» sessionToken

body

string¦null

false

none

»»» taskAuthToken

body

string¦null

false

none

»»» taskAuthEndpoint

body

string¦null

false

none

»»» taskAuthExpiration

body

string¦null

false

none

» numLines

body

integer(int32)

false

none

Enumerated Values

Parameter

Value

»» importType

None

»» importType

Text

»» importType

Excel

»» importType

DBImport

»» importType

Salesforce

»» importType

MSCRM

»» importType

EBCDICText

»» importType

TerrAlign

»» importType

XML

»» importType

ODBCImport

»» importType

SymonImport

»» importType

SymonConnectorImport

»» importType

Cos

»» importType

SQLServer

»» importType

Dynamics

»» importType

GoogleSheets

»» importType

MySql

»» importType

AmazonAurora

»» importType

AmazonS3

»» importType

Snowflake

»» importType

Shopify

»» importType

Hubspot

»» importType

Oracle

»» importType

AmazonRedshift

»» importType

Workday

»» dateFormat

Default

»» dateFormat

DayFirst

»» dateFormat

MonthFirst

»»»» type

Delimited

»»»» type

Selection

»»»» type

Merged

»» tableType

System

»» tableType

Dimension

»» tableType

Structural

»» tableType

Lookup

»» tableType

Data

»» tableType

View

»» tableType

Custom

»» tableType

StarSchema

»» tableType

ExportTable

»» tableType

CreditingRule

»» tableType

AssignTable

»» tableType

PlcmCustomTable

»» tableType

PlcmStructuralTable

»» tableType

PlcmTable

»» tableType

DataSource

»» tableType

Cached

»» tableType

MaterializedView

»»» dataType

String

»»» dataType

Decimal

»»»» type

String

»»»» type

Number

»»»» type

Boolean

»»»» type

Date

»» symonImportType

None

»» symonImportType

Text

»» symonImportType

Excel

»» symonImportType

DBImport

»» symonImportType

Salesforce

»» symonImportType

MSCRM

»» symonImportType

EBCDICText

»» symonImportType

TerrAlign

»» symonImportType

XML

»» symonImportType

ODBCImport

»» symonImportType

SymonImport

»» symonImportType

SymonConnectorImport

»» symonImportType

Cos

»» symonImportType

SQLServer

»» symonImportType

Dynamics

»» symonImportType

GoogleSheets

»» symonImportType

MySql

»» symonImportType

AmazonAurora

»» symonImportType

AmazonS3

»» symonImportType

Snowflake

»» symonImportType

Shopify

»» symonImportType

Hubspot

»» symonImportType

Oracle

»» symonImportType

AmazonRedshift

»» symonImportType

Workday

Responses

Status

Meaning

Description

Schema

200

OK

The preview was obtained.

Inline

400

Bad Request

The excel file could not be found.

None

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/imports/getexcelpreview", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/imports/getexcelpreview");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "importParams": {
    "name": "string",
    "importType": "None",
    "hasHeader": true,
    "table": "string",
    "columnMatchings": {
      "columns": [],
      "matched": []
    },
    "dateFormat": "Default",
    "listSubitems": [
      "string"
    ],
    "subitemMap": {
      "property1": {},
      "property2": {}
    },
    "addMember": true,
    "updateExistingRows": true,
    "tableType": "System",
    "isLocal": true,
    "localCulture": {},
    "useIncrementalImport": true,
    "culture": "string",
    "tableEffectiveDated": true,
    "isODBCTextDriver": true,
    "version": {
      "rowVersion": 0
    },
    "fileOverwrite": true,
    "importId": 0,
    "filename": "string",
    "localPath": "string",
    "username": "string",
    "password": "string",
    "delimiter": "string",
    "sheetName": "string",
    "cellRange": "string",
    "query": "string",
    "queryTimeout": 0,
    "connectionString": "string",
    "useAdvanced": true,
    "model": "string",
    "importMethod": 0,
    "sourceTableName": "string",
    "securityToken": "string",
    "customColumns": [
      "string"
    ],
    "userSelected": true,
    "sandbox": true,
    "fileLocation": "string",
    "codePage": 0,
    "ignoreFirst": true,
    "ignoreLast": true,
    "recordLength": 0,
    "fields": [
      {}
    ],
    "selectRowNode": "string",
    "pipeConnection": {
      "pipeID": "string",
      "inputID": "string",
      "outputID": "string",
      "outputName": "string",
      "lastValidated": "2019-08-24T14:15:22Z",
      "inputMapping": [],
      "outputMapping": []
    },
    "inputTable": "string",
    "uploadStage": true,
    "predictStage": true,
    "downloadStage": true,
    "symonImportType": "None",
    "refreshAllPipeDatasources": true,
    "connectorID": "string",
    "streamID": "string",
    "importConfig": null,
    "outputMapping": [
      {}
    ],
    "cosLocations": [
      {}
    ],
    "cosCredentials": {
      "endpoint": "string",
      "accessKey": "string",
      "secretKey": "string",
      "sessionToken": "string",
      "taskAuthToken": "string",
      "taskAuthEndpoint": "string",
      "taskAuthExpiration": "string"
    }
  },
  "numLines": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/imports/getexcelpreview',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/imports/getexcelpreview', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/imports/getexcelpreview',
  params: {
  }, headers: headers

p JSON.parse(result)

RemoteImportsControllerV1_GetWorksheetInfo

Body parameter

{
  "name": "string",
  "importType": "None",
  "hasHeader": true,
  "table": "string",
  "columnMatchings": {
    "columns": [
      "string"
    ],
    "matched": [
      "string"
    ]
  },
  "dateFormat": "Default",
  "listSubitems": [
    "string"
  ],
  "subitemMap": {
    "property1": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    },
    "property2": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    }
  },
  "addMember": true,
  "updateExistingRows": true,
  "tableType": "System",
  "isLocal": true,
  "localCulture": {},
  "useIncrementalImport": true,
  "culture": "string",
  "tableEffectiveDated": true,
  "isODBCTextDriver": true,
  "version": {
    "rowVersion": 0
  },
  "fileOverwrite": true,
  "importId": 0,
  "filename": "string",
  "localPath": "string",
  "username": "string",
  "password": "string",
  "delimiter": "string",
  "sheetName": "string",
  "cellRange": "string",
  "query": "string",
  "queryTimeout": 0,
  "connectionString": "string",
  "useAdvanced": true,
  "model": "string",
  "importMethod": 0,
  "sourceTableName": "string",
  "securityToken": "string",
  "customColumns": [
    "string"
  ],
  "userSelected": true,
  "sandbox": true,
  "fileLocation": "string",
  "codePage": 0,
  "ignoreFirst": true,
  "ignoreLast": true,
  "recordLength": 0,
  "fields": [
    {
      "name": "string",
      "offset": 0,
      "length": 0,
      "dataType": "String"
    }
  ],
  "selectRowNode": "string",
  "pipeConnection": {
    "pipeID": "string",
    "inputID": "string",
    "outputID": "string",
    "outputName": "string",
    "lastValidated": "2019-08-24T14:15:22Z",
    "inputMapping": [
      {}
    ],
    "outputMapping": [
      {}
    ]
  },
  "inputTable": "string",
  "uploadStage": true,
  "predictStage": true,
  "downloadStage": true,
  "symonImportType": "None",
  "refreshAllPipeDatasources": true,
  "connectorID": "string",
  "streamID": "string",
  "importConfig": null,
  "outputMapping": [
    {
      "source": "string",
      "destination": "string",
      "type": "String"
    }
  ],
  "cosLocations": [
    {
      "bucket": "string",
      "key": "string"
    }
  ],
  "cosCredentials": {
    "endpoint": "string",
    "accessKey": "string",
    "secretKey": "string",
    "sessionToken": "string",
    "taskAuthToken": "string",
    "taskAuthEndpoint": "string",
    "taskAuthExpiration": "string"
  }
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Composer.DataImport.ImportParamsDTO

false

none

» name

body

string¦null

false

none

» importType

body

string

false

none

» hasHeader

body

boolean

false

none

» table

body

string¦null

false

none

» columnMatchings

body

RESTAPI.v1.DTOs.ColumnMatchingsDTO

false

none

»» columns

body

[string]¦null

false

none

»» matched

body

[string]¦null

false

none

» dateFormat

body

string

false

none

» listSubitems

body

[string]¦null

false

none

» subitemMap

body

object¦null

false

none

»» additionalProperties

body

RESTAPI.v1.DTOs.Composer.DataImport.SubitemDTO

false

none

»»» name

body

[string]¦null

false

none

»»» fieldName

body

[string]¦null

false

none

»»» type

body

string

false

none

»»» delimiter

body

string¦null

false

none

»»» segment

body

integer(int32)

false

none

»»» selection

body

[string]¦null

false

none

»»» fieldIndices

body

[integer]¦null

false

none

» addMember

body

boolean

false

none

» updateExistingRows

body

boolean

false

none

» tableType

body

string

false

none

» isLocal

body

boolean

false

none

» localCulture

body

System.IFormatProvider

false

none

» useIncrementalImport

body

boolean

false

none

» culture

body

string¦null

false

none

» tableEffectiveDated

body

boolean

false

none

» isODBCTextDriver

body

boolean

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

» fileOverwrite

body

boolean

false

none

» importId

body

integer(int32)

false

none

» filename

body

string¦null

false

none

» localPath

body

string¦null

false

none

» username

body

string¦null

false

none

» password

body

string¦null

false

none

» delimiter

body

string

false

none

» sheetName

body

string¦null

false

none

» cellRange

body

string¦null

false

none

» query

body

string¦null

false

none

» queryTimeout

body

integer(int32)

false

none

» connectionString

body

string¦null

false

none

» useAdvanced

body

boolean

false

none

» model

body

string¦null

false

none

» importMethod

body

integer(int32)

false

none

» sourceTableName

body

string¦null

false

none

» securityToken

body

string¦null

false

none

» customColumns

body

[string]¦null

false

none

» userSelected

body

boolean

false

none

» sandbox

body

boolean

false

none

» fileLocation

body

string¦null

false

none

» codePage

body

integer(int32)

false

none

» ignoreFirst

body

boolean

false

none

» ignoreLast

body

boolean

false

none

» recordLength

body

integer(int32)

false

none

» fields

body

[RESTAPI.v1.DTOs.Composer.DataImport.EBCDICFieldDTO]¦null

false

none

»» name

body

string¦null

false

none

»» offset

body

integer(int32)

false

none

»» length

body

integer(int32)

false

none

»» dataType

body

string

false

none

» selectRowNode

body

string¦null

false

none

» pipeConnection

body

Varicent.RESTAPI.v1.DTOs.Symon.PipeConnectionDTO

false

none

»» pipeID

body

string¦null

false

none

»» inputID

body

string¦null

false

none

»» outputID

body

string¦null

false

none

»» outputName

body

string¦null

false

none

»» lastValidated

body

string(date-time)

false

none

»» inputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»»» source

body

string¦null

false

none

»»» destination

body

string¦null

false

none

»»» type

body

string

false

none

»» outputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

» inputTable

body

string¦null

false

none

» uploadStage

body

boolean

false

none

» predictStage

body

boolean

false

none

» downloadStage

body

boolean

false

none

» symonImportType

body

string

false

none

» refreshAllPipeDatasources

body

boolean

false

none

» connectorID

body

string¦null

false

none

» streamID

body

string¦null

false

none

» importConfig

body

any

false

none

» outputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

» cosLocations

body

[RESTAPI.v1.DTOs.Symon.CosLocationDTO]¦null

false

none

»» bucket

body

string¦null

false

none

»» key

body

string¦null

false

none

» cosCredentials

body

RESTAPI.v1.DTOs.Composer.DataImport.CosCredentialsDTO

false

none

»» endpoint

body

string¦null

false

none

»» accessKey

body

string¦null

false

none

»» secretKey

body

string¦null

false

none

»» sessionToken

body

string¦null

false

none

»» taskAuthToken

body

string¦null

false

none

»» taskAuthEndpoint

body

string¦null

false

none

»» taskAuthExpiration

body

string¦null

false

none

Enumerated Values

Parameter

Value

» importType

None

» importType

Text

» importType

Excel

» importType

DBImport

» importType

Salesforce

» importType

MSCRM

» importType

EBCDICText

» importType

TerrAlign

» importType

XML

» importType

ODBCImport

» importType

SymonImport

» importType

SymonConnectorImport

» importType

Cos

» importType

SQLServer

» importType

Dynamics

» importType

GoogleSheets

» importType

MySql

» importType

AmazonAurora

» importType

AmazonS3

» importType

Snowflake

» importType

Shopify

» importType

Hubspot

» importType

Oracle

» importType

AmazonRedshift

» importType

Workday

» dateFormat

Default

» dateFormat

DayFirst

» dateFormat

MonthFirst

»»» type

Delimited

»»» type

Selection

»»» type

Merged

» tableType

System

» tableType

Dimension

» tableType

Structural

» tableType

Lookup

» tableType

Data

» tableType

View

» tableType

Custom

» tableType

StarSchema

» tableType

ExportTable

» tableType

CreditingRule

» tableType

AssignTable

» tableType

PlcmCustomTable

» tableType

PlcmStructuralTable

» tableType

PlcmTable

» tableType

DataSource

» tableType

Cached

» tableType

MaterializedView

»» dataType

String

»» dataType

Decimal

»»» type

String

»»» type

Number

»»» type

Boolean

»»» type

Date

» symonImportType

None

» symonImportType

Text

» symonImportType

Excel

» symonImportType

DBImport

» symonImportType

Salesforce

» symonImportType

MSCRM

» symonImportType

EBCDICText

» symonImportType

TerrAlign

» symonImportType

XML

» symonImportType

ODBCImport

» symonImportType

SymonImport

» symonImportType

SymonConnectorImport

» symonImportType

Cos

» symonImportType

SQLServer

» symonImportType

Dynamics

» symonImportType

GoogleSheets

» symonImportType

MySql

» symonImportType

AmazonAurora

» symonImportType

AmazonS3

» symonImportType

Snowflake

» symonImportType

Shopify

» symonImportType

Hubspot

» symonImportType

Oracle

» symonImportType

AmazonRedshift

» symonImportType

Workday

Responses

Status

Meaning

Description

Schema

200

OK

The worksheet info was obtained.

RESTAPI.v1.DTOs.Composer.DataImport.ExcelInfoDTO

400

Bad Request

The excel file could not be found.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/imports/getworksheetinfo", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/imports/getworksheetinfo");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "name": "string",
  "importType": "None",
  "hasHeader": true,
  "table": "string",
  "columnMatchings": {
    "columns": [
      "string"
    ],
    "matched": [
      "string"
    ]
  },
  "dateFormat": "Default",
  "listSubitems": [
    "string"
  ],
  "subitemMap": {
    "property1": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    },
    "property2": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    }
  },
  "addMember": true,
  "updateExistingRows": true,
  "tableType": "System",
  "isLocal": true,
  "localCulture": {},
  "useIncrementalImport": true,
  "culture": "string",
  "tableEffectiveDated": true,
  "isODBCTextDriver": true,
  "version": {
    "rowVersion": 0
  },
  "fileOverwrite": true,
  "importId": 0,
  "filename": "string",
  "localPath": "string",
  "username": "string",
  "password": "string",
  "delimiter": "string",
  "sheetName": "string",
  "cellRange": "string",
  "query": "string",
  "queryTimeout": 0,
  "connectionString": "string",
  "useAdvanced": true,
  "model": "string",
  "importMethod": 0,
  "sourceTableName": "string",
  "securityToken": "string",
  "customColumns": [
    "string"
  ],
  "userSelected": true,
  "sandbox": true,
  "fileLocation": "string",
  "codePage": 0,
  "ignoreFirst": true,
  "ignoreLast": true,
  "recordLength": 0,
  "fields": [
    {
      "name": "string",
      "offset": 0,
      "length": 0,
      "dataType": "String"
    }
  ],
  "selectRowNode": "string",
  "pipeConnection": {
    "pipeID": "string",
    "inputID": "string",
    "outputID": "string",
    "outputName": "string",
    "lastValidated": "2019-08-24T14:15:22Z",
    "inputMapping": [
      {}
    ],
    "outputMapping": [
      {}
    ]
  },
  "inputTable": "string",
  "uploadStage": true,
  "predictStage": true,
  "downloadStage": true,
  "symonImportType": "None",
  "refreshAllPipeDatasources": true,
  "connectorID": "string",
  "streamID": "string",
  "importConfig": null,
  "outputMapping": [
    {
      "source": "string",
      "destination": "string",
      "type": "String"
    }
  ],
  "cosLocations": [
    {
      "bucket": "string",
      "key": "string"
    }
  ],
  "cosCredentials": {
    "endpoint": "string",
    "accessKey": "string",
    "secretKey": "string",
    "sessionToken": "string",
    "taskAuthToken": "string",
    "taskAuthEndpoint": "string",
    "taskAuthExpiration": "string"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/imports/getworksheetinfo',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/imports/getworksheetinfo', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/imports/getworksheetinfo',
  params: {
  }, headers: headers

p JSON.parse(result)

RemoteImportsControllerV1_GetXmlRowNodes

Body parameter

{
  "name": "string",
  "importType": "None",
  "hasHeader": true,
  "table": "string",
  "columnMatchings": {
    "columns": [
      "string"
    ],
    "matched": [
      "string"
    ]
  },
  "dateFormat": "Default",
  "listSubitems": [
    "string"
  ],
  "subitemMap": {
    "property1": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    },
    "property2": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    }
  },
  "addMember": true,
  "updateExistingRows": true,
  "tableType": "System",
  "isLocal": true,
  "localCulture": {},
  "useIncrementalImport": true,
  "culture": "string",
  "tableEffectiveDated": true,
  "isODBCTextDriver": true,
  "version": {
    "rowVersion": 0
  },
  "fileOverwrite": true,
  "importId": 0,
  "filename": "string",
  "localPath": "string",
  "username": "string",
  "password": "string",
  "delimiter": "string",
  "sheetName": "string",
  "cellRange": "string",
  "query": "string",
  "queryTimeout": 0,
  "connectionString": "string",
  "useAdvanced": true,
  "model": "string",
  "importMethod": 0,
  "sourceTableName": "string",
  "securityToken": "string",
  "customColumns": [
    "string"
  ],
  "userSelected": true,
  "sandbox": true,
  "fileLocation": "string",
  "codePage": 0,
  "ignoreFirst": true,
  "ignoreLast": true,
  "recordLength": 0,
  "fields": [
    {
      "name": "string",
      "offset": 0,
      "length": 0,
      "dataType": "String"
    }
  ],
  "selectRowNode": "string",
  "pipeConnection": {
    "pipeID": "string",
    "inputID": "string",
    "outputID": "string",
    "outputName": "string",
    "lastValidated": "2019-08-24T14:15:22Z",
    "inputMapping": [
      {}
    ],
    "outputMapping": [
      {}
    ]
  },
  "inputTable": "string",
  "uploadStage": true,
  "predictStage": true,
  "downloadStage": true,
  "symonImportType": "None",
  "refreshAllPipeDatasources": true,
  "connectorID": "string",
  "streamID": "string",
  "importConfig": null,
  "outputMapping": [
    {
      "source": "string",
      "destination": "string",
      "type": "String"
    }
  ],
  "cosLocations": [
    {
      "bucket": "string",
      "key": "string"
    }
  ],
  "cosCredentials": {
    "endpoint": "string",
    "accessKey": "string",
    "secretKey": "string",
    "sessionToken": "string",
    "taskAuthToken": "string",
    "taskAuthEndpoint": "string",
    "taskAuthExpiration": "string"
  }
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Composer.DataImport.ImportParamsDTO

false

none

» name

body

string¦null

false

none

» importType

body

string

false

none

» hasHeader

body

boolean

false

none

» table

body

string¦null

false

none

» columnMatchings

body

RESTAPI.v1.DTOs.ColumnMatchingsDTO

false

none

»» columns

body

[string]¦null

false

none

»» matched

body

[string]¦null

false

none

» dateFormat

body

string

false

none

» listSubitems

body

[string]¦null

false

none

» subitemMap

body

object¦null

false

none

»» additionalProperties

body

RESTAPI.v1.DTOs.Composer.DataImport.SubitemDTO

false

none

»»» name

body

[string]¦null

false

none

»»» fieldName

body

[string]¦null

false

none

»»» type

body

string

false

none

»»» delimiter

body

string¦null

false

none

»»» segment

body

integer(int32)

false

none

»»» selection

body

[string]¦null

false

none

»»» fieldIndices

body

[integer]¦null

false

none

» addMember

body

boolean

false

none

» updateExistingRows

body

boolean

false

none

» tableType

body

string

false

none

» isLocal

body

boolean

false

none

» localCulture

body

System.IFormatProvider

false

none

» useIncrementalImport

body

boolean

false

none

» culture

body

string¦null

false

none

» tableEffectiveDated

body

boolean

false

none

» isODBCTextDriver

body

boolean

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

» fileOverwrite

body

boolean

false

none

» importId

body

integer(int32)

false

none

» filename

body

string¦null

false

none

» localPath

body

string¦null

false

none

» username

body

string¦null

false

none

» password

body

string¦null

false

none

» delimiter

body

string

false

none

» sheetName

body

string¦null

false

none

» cellRange

body

string¦null

false

none

» query

body

string¦null

false

none

» queryTimeout

body

integer(int32)

false

none

» connectionString

body

string¦null

false

none

» useAdvanced

body

boolean

false

none

» model

body

string¦null

false

none

» importMethod

body

integer(int32)

false

none

» sourceTableName

body

string¦null

false

none

» securityToken

body

string¦null

false

none

» customColumns

body

[string]¦null

false

none

» userSelected

body

boolean

false

none

» sandbox

body

boolean

false

none

» fileLocation

body

string¦null

false

none

» codePage

body

integer(int32)

false

none

» ignoreFirst

body

boolean

false

none

» ignoreLast

body

boolean

false

none

» recordLength

body

integer(int32)

false

none

» fields

body

[RESTAPI.v1.DTOs.Composer.DataImport.EBCDICFieldDTO]¦null

false

none

»» name

body

string¦null

false

none

»» offset

body

integer(int32)

false

none

»» length

body

integer(int32)

false

none

»» dataType

body

string

false

none

» selectRowNode

body

string¦null

false

none

» pipeConnection

body

Varicent.RESTAPI.v1.DTOs.Symon.PipeConnectionDTO

false

none

»» pipeID

body

string¦null

false

none

»» inputID

body

string¦null

false

none

»» outputID

body

string¦null

false

none

»» outputName

body

string¦null

false

none

»» lastValidated

body

string(date-time)

false

none

»» inputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»»» source

body

string¦null

false

none

»»» destination

body

string¦null

false

none

»»» type

body

string

false

none

»» outputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

» inputTable

body

string¦null

false

none

» uploadStage

body

boolean

false

none

» predictStage

body

boolean

false

none

» downloadStage

body

boolean

false

none

» symonImportType

body

string

false

none

» refreshAllPipeDatasources

body

boolean

false

none

» connectorID

body

string¦null

false

none

» streamID

body

string¦null

false

none

» importConfig

body

any

false

none

» outputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

» cosLocations

body

[RESTAPI.v1.DTOs.Symon.CosLocationDTO]¦null

false

none

»» bucket

body

string¦null

false

none

»» key

body

string¦null

false

none

» cosCredentials

body

RESTAPI.v1.DTOs.Composer.DataImport.CosCredentialsDTO

false

none

»» endpoint

body

string¦null

false

none

»» accessKey

body

string¦null

false

none

»» secretKey

body

string¦null

false

none

»» sessionToken

body

string¦null

false

none

»» taskAuthToken

body

string¦null

false

none

»» taskAuthEndpoint

body

string¦null

false

none

»» taskAuthExpiration

body

string¦null

false

none

Enumerated Values

Parameter

Value

» importType

None

» importType

Text

» importType

Excel

» importType

DBImport

» importType

Salesforce

» importType

MSCRM

» importType

EBCDICText

» importType

TerrAlign

» importType

XML

» importType

ODBCImport

» importType

SymonImport

» importType

SymonConnectorImport

» importType

Cos

» importType

SQLServer

» importType

Dynamics

» importType

GoogleSheets

» importType

MySql

» importType

AmazonAurora

» importType

AmazonS3

» importType

Snowflake

» importType

Shopify

» importType

Hubspot

» importType

Oracle

» importType

AmazonRedshift

» importType

Workday

» dateFormat

Default

» dateFormat

DayFirst

» dateFormat

MonthFirst

»»» type

Delimited

»»» type

Selection

»»» type

Merged

» tableType

System

» tableType

Dimension

» tableType

Structural

» tableType

Lookup

» tableType

Data

» tableType

View

» tableType

Custom

» tableType

StarSchema

» tableType

ExportTable

» tableType

CreditingRule

» tableType

AssignTable

» tableType

PlcmCustomTable

» tableType

PlcmStructuralTable

» tableType

PlcmTable

» tableType

DataSource

» tableType

Cached

» tableType

MaterializedView

»» dataType

String

»» dataType

Decimal

»»» type

String

»»» type

Number

»»» type

Boolean

»»» type

Date

» symonImportType

None

» symonImportType

Text

» symonImportType

Excel

» symonImportType

DBImport

» symonImportType

Salesforce

» symonImportType

MSCRM

» symonImportType

EBCDICText

» symonImportType

TerrAlign

» symonImportType

XML

» symonImportType

ODBCImport

» symonImportType

SymonImport

» symonImportType

SymonConnectorImport

» symonImportType

Cos

» symonImportType

SQLServer

» symonImportType

Dynamics

» symonImportType

GoogleSheets

» symonImportType

MySql

» symonImportType

AmazonAurora

» symonImportType

AmazonS3

» symonImportType

Snowflake

» symonImportType

Shopify

» symonImportType

Hubspot

» symonImportType

Oracle

» symonImportType

AmazonRedshift

» symonImportType

Workday

Responses

Status

Meaning

Description

Schema

200

OK

The row nodes for the given XML file name was obtained.

Inline

400

Bad Request

The XML file could not be found.

None

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/imports/getrownodes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/imports/getrownodes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "name": "string",
  "importType": "None",
  "hasHeader": true,
  "table": "string",
  "columnMatchings": {
    "columns": [
      "string"
    ],
    "matched": [
      "string"
    ]
  },
  "dateFormat": "Default",
  "listSubitems": [
    "string"
  ],
  "subitemMap": {
    "property1": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    },
    "property2": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    }
  },
  "addMember": true,
  "updateExistingRows": true,
  "tableType": "System",
  "isLocal": true,
  "localCulture": {},
  "useIncrementalImport": true,
  "culture": "string",
  "tableEffectiveDated": true,
  "isODBCTextDriver": true,
  "version": {
    "rowVersion": 0
  },
  "fileOverwrite": true,
  "importId": 0,
  "filename": "string",
  "localPath": "string",
  "username": "string",
  "password": "string",
  "delimiter": "string",
  "sheetName": "string",
  "cellRange": "string",
  "query": "string",
  "queryTimeout": 0,
  "connectionString": "string",
  "useAdvanced": true,
  "model": "string",
  "importMethod": 0,
  "sourceTableName": "string",
  "securityToken": "string",
  "customColumns": [
    "string"
  ],
  "userSelected": true,
  "sandbox": true,
  "fileLocation": "string",
  "codePage": 0,
  "ignoreFirst": true,
  "ignoreLast": true,
  "recordLength": 0,
  "fields": [
    {
      "name": "string",
      "offset": 0,
      "length": 0,
      "dataType": "String"
    }
  ],
  "selectRowNode": "string",
  "pipeConnection": {
    "pipeID": "string",
    "inputID": "string",
    "outputID": "string",
    "outputName": "string",
    "lastValidated": "2019-08-24T14:15:22Z",
    "inputMapping": [
      {}
    ],
    "outputMapping": [
      {}
    ]
  },
  "inputTable": "string",
  "uploadStage": true,
  "predictStage": true,
  "downloadStage": true,
  "symonImportType": "None",
  "refreshAllPipeDatasources": true,
  "connectorID": "string",
  "streamID": "string",
  "importConfig": null,
  "outputMapping": [
    {
      "source": "string",
      "destination": "string",
      "type": "String"
    }
  ],
  "cosLocations": [
    {
      "bucket": "string",
      "key": "string"
    }
  ],
  "cosCredentials": {
    "endpoint": "string",
    "accessKey": "string",
    "secretKey": "string",
    "sessionToken": "string",
    "taskAuthToken": "string",
    "taskAuthEndpoint": "string",
    "taskAuthExpiration": "string"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/imports/getrownodes',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/imports/getrownodes', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/imports/getrownodes',
  params: {
  }, headers: headers

p JSON.parse(result)

RemoteImportsControllerV1_GetXMLPreview

Body parameter

{
  "importParams": {
    "name": "string",
    "importType": "None",
    "hasHeader": true,
    "table": "string",
    "columnMatchings": {
      "columns": [],
      "matched": []
    },
    "dateFormat": "Default",
    "listSubitems": [
      "string"
    ],
    "subitemMap": {
      "property1": {},
      "property2": {}
    },
    "addMember": true,
    "updateExistingRows": true,
    "tableType": "System",
    "isLocal": true,
    "localCulture": {},
    "useIncrementalImport": true,
    "culture": "string",
    "tableEffectiveDated": true,
    "isODBCTextDriver": true,
    "version": {
      "rowVersion": 0
    },
    "fileOverwrite": true,
    "importId": 0,
    "filename": "string",
    "localPath": "string",
    "username": "string",
    "password": "string",
    "delimiter": "string",
    "sheetName": "string",
    "cellRange": "string",
    "query": "string",
    "queryTimeout": 0,
    "connectionString": "string",
    "useAdvanced": true,
    "model": "string",
    "importMethod": 0,
    "sourceTableName": "string",
    "securityToken": "string",
    "customColumns": [
      "string"
    ],
    "userSelected": true,
    "sandbox": true,
    "fileLocation": "string",
    "codePage": 0,
    "ignoreFirst": true,
    "ignoreLast": true,
    "recordLength": 0,
    "fields": [
      {}
    ],
    "selectRowNode": "string",
    "pipeConnection": {
      "pipeID": "string",
      "inputID": "string",
      "outputID": "string",
      "outputName": "string",
      "lastValidated": "2019-08-24T14:15:22Z",
      "inputMapping": [],
      "outputMapping": []
    },
    "inputTable": "string",
    "uploadStage": true,
    "predictStage": true,
    "downloadStage": true,
    "symonImportType": "None",
    "refreshAllPipeDatasources": true,
    "connectorID": "string",
    "streamID": "string",
    "importConfig": null,
    "outputMapping": [
      {}
    ],
    "cosLocations": [
      {}
    ],
    "cosCredentials": {
      "endpoint": "string",
      "accessKey": "string",
      "secretKey": "string",
      "sessionToken": "string",
      "taskAuthToken": "string",
      "taskAuthEndpoint": "string",
      "taskAuthExpiration": "string"
    }
  },
  "numLines": 0
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Composer.DataImport.ImportPreviewDTO

false

none

» importParams

body

RESTAPI.v1.DTOs.Composer.DataImport.ImportParamsDTO

false

none

»» name

body

string¦null

false

none

»» importType

body

string

false

none

»» hasHeader

body

boolean

false

none

»» table

body

string¦null

false

none

»» columnMatchings

body

RESTAPI.v1.DTOs.ColumnMatchingsDTO

false

none

»»» columns

body

[string]¦null

false

none

»»» matched

body

[string]¦null

false

none

»» dateFormat

body

string

false

none

»» listSubitems

body

[string]¦null

false

none

»» subitemMap

body

object¦null

false

none

»»» additionalProperties

body

RESTAPI.v1.DTOs.Composer.DataImport.SubitemDTO

false

none

»»»» name

body

[string]¦null

false

none

»»»» fieldName

body

[string]¦null

false

none

»»»» type

body

string

false

none

»»»» delimiter

body

string¦null

false

none

»»»» segment

body

integer(int32)

false

none

»»»» selection

body

[string]¦null

false

none

»»»» fieldIndices

body

[integer]¦null

false

none

»» addMember

body

boolean

false

none

»» updateExistingRows

body

boolean

false

none

»» tableType

body

string

false

none

»» isLocal

body

boolean

false

none

»» localCulture

body

System.IFormatProvider

false

none

»» useIncrementalImport

body

boolean

false

none

»» culture

body

string¦null

false

none

»» tableEffectiveDated

body

boolean

false

none

»» isODBCTextDriver

body

boolean

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» rowVersion

body

integer(int64)

false

none

»» fileOverwrite

body

boolean

false

none

»» importId

body

integer(int32)

false

none

»» filename

body

string¦null

false

none

»» localPath

body

string¦null

false

none

»» username

body

string¦null

false

none

»» password

body

string¦null

false

none

»» delimiter

body

string

false

none

»» sheetName

body

string¦null

false

none

»» cellRange

body

string¦null

false

none

»» query

body

string¦null

false

none

»» queryTimeout

body

integer(int32)

false

none

»» connectionString

body

string¦null

false

none

»» useAdvanced

body

boolean

false

none

»» model

body

string¦null

false

none

»» importMethod

body

integer(int32)

false

none

»» sourceTableName

body

string¦null

false

none

»» securityToken

body

string¦null

false

none

»» customColumns

body

[string]¦null

false

none

»» userSelected

body

boolean

false

none

»» sandbox

body

boolean

false

none

»» fileLocation

body

string¦null

false

none

»» codePage

body

integer(int32)

false

none

»» ignoreFirst

body

boolean

false

none

»» ignoreLast

body

boolean

false

none

»» recordLength

body

integer(int32)

false

none

»» fields

body

[RESTAPI.v1.DTOs.Composer.DataImport.EBCDICFieldDTO]¦null

false

none

»»» name

body

string¦null

false

none

»»» offset

body

integer(int32)

false

none

»»» length

body

integer(int32)

false

none

»»» dataType

body

string

false

none

»» selectRowNode

body

string¦null

false

none

»» pipeConnection

body

Varicent.RESTAPI.v1.DTOs.Symon.PipeConnectionDTO

false

none

»»» pipeID

body

string¦null

false

none

»»» inputID

body

string¦null

false

none

»»» outputID

body

string¦null

false

none

»»» outputName

body

string¦null

false

none

»»» lastValidated

body

string(date-time)

false

none

»»» inputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»»»» source

body

string¦null

false

none

»»»» destination

body

string¦null

false

none

»»»» type

body

string

false

none

»»» outputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»» inputTable

body

string¦null

false

none

»» uploadStage

body

boolean

false

none

»» predictStage

body

boolean

false

none

»» downloadStage

body

boolean

false

none

»» symonImportType

body

string

false

none

»» refreshAllPipeDatasources

body

boolean

false

none

»» connectorID

body

string¦null

false

none

»» streamID

body

string¦null

false

none

»» importConfig

body

any

false

none

»» outputMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»» cosLocations

body

[RESTAPI.v1.DTOs.Symon.CosLocationDTO]¦null

false

none

»»» bucket

body

string¦null

false

none

»»» key

body

string¦null

false

none

»» cosCredentials

body

RESTAPI.v1.DTOs.Composer.DataImport.CosCredentialsDTO

false

none

»»» endpoint

body

string¦null

false

none

»»» accessKey

body

string¦null

false

none

»»» secretKey

body

string¦null

false

none

»»» sessionToken

body

string¦null

false

none

»»» taskAuthToken

body

string¦null

false

none

»»» taskAuthEndpoint

body

string¦null

false

none

»»» taskAuthExpiration

body

string¦null

false

none

» numLines

body

integer(int32)

false

none

Enumerated Values

Parameter

Value

»» importType

None

»» importType

Text

»» importType

Excel

»» importType

DBImport

»» importType

Salesforce

»» importType

MSCRM

»» importType

EBCDICText

»» importType

TerrAlign

»» importType

XML

»» importType

ODBCImport

»» importType

SymonImport

»» importType

SymonConnectorImport

»» importType

Cos

»» importType

SQLServer

»» importType

Dynamics

»» importType

GoogleSheets

»» importType

MySql

»» importType

AmazonAurora

»» importType

AmazonS3

»» importType

Snowflake

»» importType

Shopify

»» importType

Hubspot

»» importType

Oracle

»» importType

AmazonRedshift

»» importType

Workday

»» dateFormat

Default

»» dateFormat

DayFirst

»» dateFormat

MonthFirst

»»»» type

Delimited

»»»» type

Selection

»»»» type

Merged

»» tableType

System

»» tableType

Dimension

»» tableType

Structural

»» tableType

Lookup

»» tableType

Data

»» tableType

View

»» tableType

Custom

»» tableType

StarSchema

»» tableType

ExportTable

»» tableType

CreditingRule

»» tableType

AssignTable

»» tableType

PlcmCustomTable

»» tableType

PlcmStructuralTable

»» tableType

PlcmTable

»» tableType

DataSource

»» tableType

Cached

»» tableType

MaterializedView

»»» dataType

String

»»» dataType

Decimal

»»»» type

String

»»»» type

Number

»»»» type

Boolean

»»»» type

Date

»» symonImportType

None

»» symonImportType

Text

»» symonImportType

Excel

»» symonImportType

DBImport

»» symonImportType

Salesforce

»» symonImportType

MSCRM

»» symonImportType

EBCDICText

»» symonImportType

TerrAlign

»» symonImportType

XML

»» symonImportType

ODBCImport

»» symonImportType

SymonImport

»» symonImportType

SymonConnectorImport

»» symonImportType

Cos

»» symonImportType

SQLServer

»» symonImportType

Dynamics

»» symonImportType

GoogleSheets

»» symonImportType

MySql

»» symonImportType

AmazonAurora

»» symonImportType

AmazonS3

»» symonImportType

Snowflake

»» symonImportType

Shopify

»» symonImportType

Hubspot

»» symonImportType

Oracle

»» symonImportType

AmazonRedshift

»» symonImportType

Workday

Responses

Status

Meaning

Description

Schema

200

OK

The xml preview was obtained.

Inline

400

Bad Request

The xml file could not be found.

None

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/imports/getxmlpreview", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/imports/getxmlpreview");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "importParams": {
    "name": "string",
    "importType": "None",
    "hasHeader": true,
    "table": "string",
    "columnMatchings": {
      "columns": [],
      "matched": []
    },
    "dateFormat": "Default",
    "listSubitems": [
      "string"
    ],
    "subitemMap": {
      "property1": {},
      "property2": {}
    },
    "addMember": true,
    "updateExistingRows": true,
    "tableType": "System",
    "isLocal": true,
    "localCulture": {},
    "useIncrementalImport": true,
    "culture": "string",
    "tableEffectiveDated": true,
    "isODBCTextDriver": true,
    "version": {
      "rowVersion": 0
    },
    "fileOverwrite": true,
    "importId": 0,
    "filename": "string",
    "localPath": "string",
    "username": "string",
    "password": "string",
    "delimiter": "string",
    "sheetName": "string",
    "cellRange": "string",
    "query": "string",
    "queryTimeout": 0,
    "connectionString": "string",
    "useAdvanced": true,
    "model": "string",
    "importMethod": 0,
    "sourceTableName": "string",
    "securityToken": "string",
    "customColumns": [
      "string"
    ],
    "userSelected": true,
    "sandbox": true,
    "fileLocation": "string",
    "codePage": 0,
    "ignoreFirst": true,
    "ignoreLast": true,
    "recordLength": 0,
    "fields": [
      {}
    ],
    "selectRowNode": "string",
    "pipeConnection": {
      "pipeID": "string",
      "inputID": "string",
      "outputID": "string",
      "outputName": "string",
      "lastValidated": "2019-08-24T14:15:22Z",
      "inputMapping": [],
      "outputMapping": []
    },
    "inputTable": "string",
    "uploadStage": true,
    "predictStage": true,
    "downloadStage": true,
    "symonImportType": "None",
    "refreshAllPipeDatasources": true,
    "connectorID": "string",
    "streamID": "string",
    "importConfig": null,
    "outputMapping": [
      {}
    ],
    "cosLocations": [
      {}
    ],
    "cosCredentials": {
      "endpoint": "string",
      "accessKey": "string",
      "secretKey": "string",
      "sessionToken": "string",
      "taskAuthToken": "string",
      "taskAuthEndpoint": "string",
      "taskAuthExpiration": "string"
    }
  },
  "numLines": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/imports/getxmlpreview',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/imports/getxmlpreview', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/imports/getxmlpreview',
  params: {
  }, headers: headers

p JSON.parse(result)

RemoteImportsControllerV2_RunCosImport

Body parameter

{
  "columnMapping": [
    {
      "source": "string",
      "destination": "string",
      "type": "String"
    }
  ],
  "cosLocations": [
    {
      "bucket": "string",
      "key": "string"
    }
  ],
  "cosCredentials": {
    "endpoint": "string",
    "accessKey": "string",
    "secretKey": "string",
    "sessionToken": "string",
    "taskAuthToken": "string",
    "taskAuthEndpoint": "string",
    "taskAuthExpiration": "string"
  },
  "addMembers": true,
  "updateExistingRows": true,
  "cancelOnUpdates": true,
  "isEffectiveDated": true,
  "csvDateFormat": "Default"
}

Parameters

Name

In

Type

Required

Description

table

path

string

true

none

body

body

RESTAPI.v2.DTOs.Symon.CosSourceDTO

false

none

» columnMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»» source

body

string¦null

false

none

»» destination

body

string¦null

false

none

»» type

body

string

false

none

» cosLocations

body

[RESTAPI.v1.DTOs.Symon.CosLocationDTO]¦null

false

none

»» bucket

body

string¦null

false

none

»» key

body

string¦null

false

none

» cosCredentials

body

RESTAPI.v1.DTOs.Composer.DataImport.CosCredentialsDTO

false

none

»» endpoint

body

string¦null

false

none

»» accessKey

body

string¦null

false

none

»» secretKey

body

string¦null

false

none

»» sessionToken

body

string¦null

false

none

»» taskAuthToken

body

string¦null

false

none

»» taskAuthEndpoint

body

string¦null

false

none

»» taskAuthExpiration

body

string¦null

false

none

» addMembers

body

boolean

false

none

» updateExistingRows

body

boolean

false

none

» cancelOnUpdates

body

boolean

false

none

» isEffectiveDated

body

boolean¦null

false

none

» csvDateFormat

body

string

false

none

Enumerated Values

Parameter

Value

»» type

String

»» type

Number

»» type

Boolean

»» type

Date

» csvDateFormat

Default

» csvDateFormat

DayFirst

» csvDateFormat

MonthFirst

Responses

Status

Meaning

Description

Schema

200

OK

Run Cos import

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v2/rpc/imports/cos/{table}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v2/rpc/imports/cos/{table}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "columnMapping": [
    {
      "source": "string",
      "destination": "string",
      "type": "String"
    }
  ],
  "cosLocations": [
    {
      "bucket": "string",
      "key": "string"
    }
  ],
  "cosCredentials": {
    "endpoint": "string",
    "accessKey": "string",
    "secretKey": "string",
    "sessionToken": "string",
    "taskAuthToken": "string",
    "taskAuthEndpoint": "string",
    "taskAuthExpiration": "string"
  },
  "addMembers": true,
  "updateExistingRows": true,
  "cancelOnUpdates": true,
  "isEffectiveDated": true,
  "csvDateFormat": "Default"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v2/rpc/imports/cos/{table}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v2/rpc/imports/cos/{table}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v2/rpc/imports/cos/{table}',
  params: {
  }, headers: headers

p JSON.parse(result)

RemoteImportsControllerV2_RunCosCustomTableImport

Body parameter

{
  "columnMapping": [
    {
      "source": "string",
      "destination": "string",
      "type": "String"
    }
  ],
  "cosLocations": [
    {
      "bucket": "string",
      "key": "string"
    }
  ],
  "cosCredentials": {
    "endpoint": "string",
    "accessKey": "string",
    "secretKey": "string",
    "sessionToken": "string",
    "taskAuthToken": "string",
    "taskAuthEndpoint": "string",
    "taskAuthExpiration": "string"
  },
  "addMembers": true,
  "updateExistingRows": true,
  "cancelOnUpdates": true,
  "isEffectiveDated": true,
  "csvDateFormat": "Default"
}

Parameters

Name

In

Type

Required

Description

table

path

string

true

none

body

body

RESTAPI.v2.DTOs.Symon.CosSourceDTO

false

none

» columnMapping

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»» source

body

string¦null

false

none

»» destination

body

string¦null

false

none

»» type

body

string

false

none

» cosLocations

body

[RESTAPI.v1.DTOs.Symon.CosLocationDTO]¦null

false

none

»» bucket

body

string¦null

false

none

»» key

body

string¦null

false

none

» cosCredentials

body

RESTAPI.v1.DTOs.Composer.DataImport.CosCredentialsDTO

false

none

»» endpoint

body

string¦null

false

none

»» accessKey

body

string¦null

false

none

»» secretKey

body

string¦null

false

none

»» sessionToken

body

string¦null

false

none

»» taskAuthToken

body

string¦null

false

none

»» taskAuthEndpoint

body

string¦null

false

none

»» taskAuthExpiration

body

string¦null

false

none

» addMembers

body

boolean

false

none

» updateExistingRows

body

boolean

false

none

» cancelOnUpdates

body

boolean

false

none

» isEffectiveDated

body

boolean¦null

false

none

» csvDateFormat

body

string

false

none

Enumerated Values

Parameter

Value

»» type

String

»» type

Number

»» type

Boolean

»» type

Date

» csvDateFormat

Default

» csvDateFormat

DayFirst

» csvDateFormat

MonthFirst

Responses

Status

Meaning

Description

Schema

200

OK

Run Cos customtable import

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v2/rpc/imports/cos/customtable/{table}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v2/rpc/imports/cos/customtable/{table}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "columnMapping": [
    {
      "source": "string",
      "destination": "string",
      "type": "String"
    }
  ],
  "cosLocations": [
    {
      "bucket": "string",
      "key": "string"
    }
  ],
  "cosCredentials": {
    "endpoint": "string",
    "accessKey": "string",
    "secretKey": "string",
    "sessionToken": "string",
    "taskAuthToken": "string",
    "taskAuthEndpoint": "string",
    "taskAuthExpiration": "string"
  },
  "addMembers": true,
  "updateExistingRows": true,
  "cancelOnUpdates": true,
  "isEffectiveDated": true,
  "csvDateFormat": "Default"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v2/rpc/imports/cos/customtable/{table}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v2/rpc/imports/cos/customtable/{table}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v2/rpc/imports/cos/customtable/{table}',
  params: {
  }, headers: headers

p JSON.parse(result)

Input Form

Get all input forms for the given tablename.

Parameters

Name

In

Type

Required

Description

tablename

path

string

true

Table Name

filter

query

string

false

####Supported operations

orderBy

query

string

false

####Description

limit

query

integer(int32)

false

Number of records to retrieve.

offset

query

integer(int32)

false

Offset number of records.

Detailed descriptions

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

currentname

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

id, currentname

limit: Number of records to retrieve.

Default: 50

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.InputFormNameDTO]

false

none

none

» id

integer(int32)

false

none

none

» currentName

string¦null

false

none

none

» basedOnTable

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/customtables/{tablename}/inputforms", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtables/{tablename}/inputforms");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/customtables/{tablename}/inputforms',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/customtables/{tablename}/inputforms', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/customtables/{tablename}/inputforms',
  params: {
  }, headers: headers

p JSON.parse(result)

Create an input form.

Body parameter

{
  "id": 0,
  "basedOnTable": "string",
  "query": {
    "selectItems": [
      {}
    ],
    "source": {
      "namespaceTable": {},
      "query": null,
      "alias": "string",
      "sourceType": "Table"
    },
    "joins": [
      {}
    ],
    "whereClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "order": [
      {}
    ],
    "group": [
      {}
    ],
    "havingClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "distinct": true,
    "unionWith": null,
    "exceptWith": null
  },
  "columns": [
    {
      "column": {},
      "defaultValue": {},
      "isReadOnly": true,
      "alias": "string",
      "referenceOptions": []
    }
  ],
  "rules": [
    {
      "name": "string",
      "table": "string",
      "column": "string",
      "comment": "string",
      "rule": "string",
      "type": "Text"
    }
  ],
  "name": "string",
  "table": {
    "version": {
      "rowVersion": 0
    },
    "name": "string",
    "tableType": "System",
    "effectiveDated": true,
    "workflowObjectID": 0,
    "hierarchyMetadata": {
      "tableName": "string",
      "idColumnName": "string",
      "parentColumnName": "string"
    },
    "lastUpdatedTracking": true
  },
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

tablename

path

string

true

none

body

body

Varicent.RESTAPI.v1.DTOs.InputFormDTO

false

none

» id

body

integer(int32)

false

none

» basedOnTable

body

string¦null

false

none

» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»» alias

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» table

body

string¦null

false

none

»»» customSelect

body

string¦null

false

none

»»» dataType

body

string

false

none

»»» type

body

string

false

none

»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» expressionType

body

string

false

none

»»»» cases

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» op

body

string¦null

false

none

»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»» constraintType

body

string

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» expressionType

body

string

false

none

»»»»»»» cases

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» arguments

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» condition

body

any

false

none

»»»»»»» trueValue

body

any

false

none

»»»»»»» falseValue

body

any

false

none

»»»»»»» isDate

body

boolean

false

none

»»»»»»» literalType

body

string

false

none

»»»»»»» value

body

any

false

none

»»»»»» caseSensitive

body

boolean

false

none

»»»»»» constraints

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» literalRight

body

any

false

none

»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»» right

body

any

false

none

»»»»»» expressionLeft

body

any

false

none

»»»»»» expressionRight

body

any

false

none

»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»» like

body

string¦null

false

none

»»»»»» escapeWildcards

body

boolean

false

none

»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» queryDefinitionRight

body

any

false

none

»»»»» trueValue

body

any

false

none

»»»»» falseValue

body

any

false

none

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» isDate

body

boolean

false

none

»»»» literalType

body

string

false

none

»»»» value

body

any

false

none

»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»» m_namespace

body

string¦null

false

none

»»»» name

body

string¦null

false

none

»»» query

body

any

false

none

»»» alias

body

string¦null

false

none

»»» sourceType

body

string

false

none

»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»» joinType

body

string

false

none

»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»» constraintType

body

string

false

none

»»»» op

body

string¦null

false

none

»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» caseSensitive

body

boolean

false

none

»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» isPreciseDecimal

body

boolean

false

none

»»»» like

body

string¦null

false

none

»»»» escapeWildcards

body

boolean

false

none

»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»» table

body

string¦null

false

none

»»»» queryDefinitionRight

body

any

false

none

»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» direction

body

string

false

none

»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» distinct

body

boolean

false

none

»» unionWith

body

any

false

none

»» exceptWith

body

any

false

none

» columns

body

[Varicent.RESTAPI.v1.DTOs.InputFormColumnDTO]¦null

false

none

»» column

body

Varicent.RESTAPI.v1.DTOs.ColumnDefinitionDTO

false

none

»»» column

body

Varicent.RESTAPI.v1.DTOs.CustomColumnDTO

false

none

»»»» name

body

string¦null

false

none

»»»» type

body

string

false

none

»»»» referencedTable

body

string¦null

false

none

»»»» referencedName

body

string¦null

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»»»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»»»» sourceNames

body

object¦null

false

none

»»»»»» additionalProperties

body

string¦null

false

none

»»»» pickListParams

body

[Varicent.RESTAPI.v1.DTOs.PickListParamDTO]¦null

false

none

»»»»» joinAlias

body

string¦null

false

none

»»»»» joinColumn

body

string¦null

false

none

»»»»» op

body

string

false

none

»»»» isKey

body

boolean

false

none

»»» isRemovable

body

boolean

false

none

»»» isNullable

body

boolean

false

none

»»» referencedColumn

body

string¦null

false

none

»» defaultValue

body

Varicent.RESTAPI.v1.DTOs.DefaultValueDTO

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» dataType

body

string

false

none

»»» value

body

any

false

none

»»» valid

body

boolean

false

none

»» isReadOnly

body

boolean

false

none

»» alias

body

string¦null

false

none

»» referenceOptions

body

[Varicent.RESTAPI.v1.DTOs.ReferenceOptionDTO]¦null

false

none

»»» type

body

string

false

none

»»» referencedColumn

body

string¦null

false

none

»»» isJumpTo

body

boolean

false

none

»»» tabName

body

string¦null

false

none

»»» referencedInputFormName

body

string¦null

false

none

»»» referencedInputFormId

body

integer(int32)

false

none

»»» referencedTable

body

string¦null

false

none

» rules

body

[Varicent.RESTAPI.v1.DTOs.ValidationRuleDTO]¦null

false

none

»» name

body

string¦null

false

none

»» table

body

string¦null

false

none

»» column

body

string¦null

false

none

»» comment

body

string¦null

false

none

»» rule

body

string¦null

false

none

»» type

body

string

false

none

» name

body

string¦null

false

none

» table

body

Varicent.RESTAPI.v1.DTOs.CustomTableDTO

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» name

body

string¦null

false

none

»» tableType

body

string

false

none

»» effectiveDated

body

boolean

false

none

»» workflowObjectID

body

integer(int32)

false

none

»» hierarchyMetadata

body

RESTAPI.v1.DTOs.Hierarchy.HierarchyMetadataDTO

false

none

»»» tableName

body

string¦null

false

none

»»» idColumnName

body

string¦null

false

none

»»» parentColumnName

body

string¦null

false

none

»» lastUpdatedTracking

body

boolean¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

»»» dataType

Int

»»» dataType

Decimal

»»» dataType

DateTime

»»» dataType

None

»»» dataType

String

»»» type

SelectAll

»»» type

SelectItem

»»» type

SelectLiteral

»»» type

SelectCustom

»»» type

SelectExpression

»»»» expressionType

caseExpression

»»»» expressionType

dataField

»»»» expressionType

function

»»»» expressionType

ifExpression

»»»» expressionType

literal

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» constraintType

clause

»»»»»» constraintType

constraint

»»»»»» constraintType

expressionConstraint

»»»»»» constraintType

likeConstraint

»»»»»» constraintType

rowVersionConstraint

»»»»»» constraintType

subQueryConstraint

»»»»»»» expressionType

caseExpression

»»»»»»» expressionType

dataField

»»»»»»» expressionType

function

»»»»»»» expressionType

ifExpression

»»»»»»» expressionType

literal

»»»»»»» literalType

Integer

»»»»»»» literalType

Decimal

»»»»»»» literalType

Date

»»»»»»» literalType

DateTime

»»»»»»» literalType

String

»»»»»»» literalType

Float

»»»»»»» literalType

Long

»»»»»»» literalType

Null

»»»»»»» literalType

Parameter

»»»»»»» literalType

Guid

»»»»»»» literalType

SystemUtcTime

»»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» literalType

Integer

»»»» literalType

Decimal

»»»» literalType

Date

»»»» literalType

DateTime

»»»» literalType

String

»»»» literalType

Float

»»»» literalType

Long

»»»» literalType

Null

»»»» literalType

Parameter

»»»» literalType

Guid

»»»» literalType

SystemUtcTime

»»»» literalType

Boolean

»»» sourceType

Table

»»» sourceType

Query

»»» joinType

Inner

»»» joinType

Left

»»» joinType

Right

»»» joinType

Cross

»»» joinType

CrossApply

»»» joinType

OuterApply

»»»» constraintType

clause

»»»» constraintType

constraint

»»»» constraintType

expressionConstraint

»»»» constraintType

likeConstraint

»»»» constraintType

rowVersionConstraint

»»»» constraintType

subQueryConstraint

»»» direction

Ascending

»»» direction

Descending

»»» direction

AscendingNullsFirst

»»» direction

DescendingNullsLast

»»»» type

Text

»»»» type

Date

»»»» type

List

»»»» type

Numeric

»»»» type

Email

»»»» type

Url

»»»» type

Comment

»»»» type

DateTime

»»»»» op

LessThan

»»»»» op

LessThanEquals

»»»»» op

Equals

»»»»» op

NotEquals

»»»»» op

GreaterThan

»»»»» op

GreaterThanEquals

»»»»» op

IsNull

»»»»» op

IsNotNull

»»»»» op

In

»»»»» op

NotIn

»»» dataType

Text

»»» dataType

Date

»»» dataType

List

»»» dataType

Numeric

»»» dataType

Email

»»» dataType

Url

»»» dataType

Comment

»»» dataType

DateTime

»»» type

ReferenceOptionInputForm

»»» type

ReferenceOptionTable

»» type

Text

»» type

Numeric

»» tableType

System

»» tableType

Dimension

»» tableType

Structural

»» tableType

Lookup

»» tableType

Data

»» tableType

View

»» tableType

Custom

»» tableType

StarSchema

»» tableType

ExportTable

»» tableType

CreditingRule

»» tableType

AssignTable

»» tableType

PlcmCustomTable

»» tableType

PlcmStructuralTable

»» tableType

PlcmTable

»» tableType

DataSource

»» tableType

Cached

»» tableType

MaterializedView

Responses

Status

Meaning

Description

Schema

200

OK

Create Input Form

Varicent.RESTAPI.v1.DTOs.InputFormDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/customtables/{tablename}/inputforms", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtables/{tablename}/inputforms");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "basedOnTable": "string",
  "query": {
    "selectItems": [
      {}
    ],
    "source": {
      "namespaceTable": {},
      "query": null,
      "alias": "string",
      "sourceType": "Table"
    },
    "joins": [
      {}
    ],
    "whereClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "order": [
      {}
    ],
    "group": [
      {}
    ],
    "havingClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "distinct": true,
    "unionWith": null,
    "exceptWith": null
  },
  "columns": [
    {
      "column": {},
      "defaultValue": {},
      "isReadOnly": true,
      "alias": "string",
      "referenceOptions": []
    }
  ],
  "rules": [
    {
      "name": "string",
      "table": "string",
      "column": "string",
      "comment": "string",
      "rule": "string",
      "type": "Text"
    }
  ],
  "name": "string",
  "table": {
    "version": {
      "rowVersion": 0
    },
    "name": "string",
    "tableType": "System",
    "effectiveDated": true,
    "workflowObjectID": 0,
    "hierarchyMetadata": {
      "tableName": "string",
      "idColumnName": "string",
      "parentColumnName": "string"
    },
    "lastUpdatedTracking": true
  },
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/customtables/{tablename}/inputforms',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/customtables/{tablename}/inputforms', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/customtables/{tablename}/inputforms',
  params: {
  }, headers: headers

p JSON.parse(result)

Get all input forms.

Parameters

Name

In

Type

Required

Description

filter

query

string

false

####Supported operations

Detailed descriptions

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

currentname

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.InputFormNameDTO]

false

none

none

» id

integer(int32)

false

none

none

» currentName

string¦null

false

none

none

» basedOnTable

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/customtables/inputforms", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtables/inputforms");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/customtables/inputforms',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/customtables/inputforms', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/customtables/inputforms',
  params: {
  }, headers: headers

p JSON.parse(result)

Get input form by ID.

Parameters

Name

In

Type

Required

Description

tablename

path

string

true

none

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get Input Form by Id

Varicent.RESTAPI.v1.DTOs.InputFormDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/customtables/{tablename}/inputforms/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtables/{tablename}/inputforms/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/customtables/{tablename}/inputforms/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/customtables/{tablename}/inputforms/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/customtables/{tablename}/inputforms/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "basedOnTable": "string",
  "query": {
    "selectItems": [
      {}
    ],
    "source": {
      "namespaceTable": {},
      "query": null,
      "alias": "string",
      "sourceType": "Table"
    },
    "joins": [
      {}
    ],
    "whereClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "order": [
      {}
    ],
    "group": [
      {}
    ],
    "havingClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "distinct": true,
    "unionWith": null,
    "exceptWith": null
  },
  "columns": [
    {
      "column": {},
      "defaultValue": {},
      "isReadOnly": true,
      "alias": "string",
      "referenceOptions": []
    }
  ],
  "rules": [
    {
      "name": "string",
      "table": "string",
      "column": "string",
      "comment": "string",
      "rule": "string",
      "type": "Text"
    }
  ],
  "name": "string",
  "table": {
    "version": {
      "rowVersion": 0
    },
    "name": "string",
    "tableType": "System",
    "effectiveDated": true,
    "workflowObjectID": 0,
    "hierarchyMetadata": {
      "tableName": "string",
      "idColumnName": "string",
      "parentColumnName": "string"
    },
    "lastUpdatedTracking": true
  },
  "version": {
    "rowVersion": 0
  }
}
{"id":0,"basedOnTable":"string","query":{"selectItems":[{}],"source":{"namespaceTable":{},"query":null,"alias":"string","sourceType":"Table"},"joins":[{}],"whereClause":{"constraintType":"clause","op":"string","dataFieldLeft":{},"caseSensitive":true,"constraints":[],"literalRight":{},"dataFieldRight":{},"right":{},"expressionLeft":{},"expressionRight":{},"isPreciseDecimal":true,"like":"string","escapeWildcards":true,"rowVersion":{},"table":"string","queryDefinitionRight":null},"order":[{}],"group":[{}],"havingClause":{"constraintType":"clause","op":"string","dataFieldLeft":{},"caseSensitive":true,"constraints":[],"literalRight":{},"dataFieldRight":{},"right":{},"expressionLeft":{},"expressionRight":{},"isPreciseDecimal":true,"like":"string","escapeWildcards":true,"rowVersion":{},"table":"string","queryDefinitionRight":null},"distinct":true,"unionWith":null,"exceptWith":null},"columns":[{"column":{},"defaultValue":{},"isReadOnly":true,"alias":"string","referenceOptions":[]}],"rules":[{"name":"string","table":"string","column":"string","comment":"string","rule":"string","type":"Text"}],"name":"string","table":{"version":{"rowVersion":0},"name":"string","tableType":"System","effectiveDated":true,"workflowObjectID":0,"hierarchyMetadata":{"tableName":"string","idColumnName":"string","parentColumnName":"string"},"lastUpdatedTracking":true},"version":{"rowVersion":0}}

Update an input form.

Body parameter

{
  "id": 0,
  "basedOnTable": "string",
  "query": {
    "selectItems": [
      {}
    ],
    "source": {
      "namespaceTable": {},
      "query": null,
      "alias": "string",
      "sourceType": "Table"
    },
    "joins": [
      {}
    ],
    "whereClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "order": [
      {}
    ],
    "group": [
      {}
    ],
    "havingClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "distinct": true,
    "unionWith": null,
    "exceptWith": null
  },
  "columns": [
    {
      "column": {},
      "defaultValue": {},
      "isReadOnly": true,
      "alias": "string",
      "referenceOptions": []
    }
  ],
  "rules": [
    {
      "name": "string",
      "table": "string",
      "column": "string",
      "comment": "string",
      "rule": "string",
      "type": "Text"
    }
  ],
  "name": "string",
  "table": {
    "version": {
      "rowVersion": 0
    },
    "name": "string",
    "tableType": "System",
    "effectiveDated": true,
    "workflowObjectID": 0,
    "hierarchyMetadata": {
      "tableName": "string",
      "idColumnName": "string",
      "parentColumnName": "string"
    },
    "lastUpdatedTracking": true
  },
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

tablename

path

string

true

none

id

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.InputFormDTO

false

none

» id

body

integer(int32)

false

none

» basedOnTable

body

string¦null

false

none

» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»» alias

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» table

body

string¦null

false

none

»»» customSelect

body

string¦null

false

none

»»» dataType

body

string

false

none

»»» type

body

string

false

none

»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» expressionType

body

string

false

none

»»»» cases

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» op

body

string¦null

false

none

»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»» constraintType

body

string

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» expressionType

body

string

false

none

»»»»»»» cases

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» arguments

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» condition

body

any

false

none

»»»»»»» trueValue

body

any

false

none

»»»»»»» falseValue

body

any

false

none

»»»»»»» isDate

body

boolean

false

none

»»»»»»» literalType

body

string

false

none

»»»»»»» value

body

any

false

none

»»»»»» caseSensitive

body

boolean

false

none

»»»»»» constraints

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» literalRight

body

any

false

none

»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»» right

body

any

false

none

»»»»»» expressionLeft

body

any

false

none

»»»»»» expressionRight

body

any

false

none

»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»» like

body

string¦null

false

none

»»»»»» escapeWildcards

body

boolean

false

none

»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» queryDefinitionRight

body

any

false

none

»»»»» trueValue

body

any

false

none

»»»»» falseValue

body

any

false

none

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» isDate

body

boolean

false

none

»»»» literalType

body

string

false

none

»»»» value

body

any

false

none

»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»» m_namespace

body

string¦null

false

none

»»»» name

body

string¦null

false

none

»»» query

body

any

false

none

»»» alias

body

string¦null

false

none

»»» sourceType

body

string

false

none

»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»» joinType

body

string

false

none

»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»» constraintType

body

string

false

none

»»»» op

body

string¦null

false

none

»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» caseSensitive

body

boolean

false

none

»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» isPreciseDecimal

body

boolean

false

none

»»»» like

body

string¦null

false

none

»»»» escapeWildcards

body

boolean

false

none

»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»» table

body

string¦null

false

none

»»»» queryDefinitionRight

body

any

false

none

»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» direction

body

string

false

none

»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» distinct

body

boolean

false

none

»» unionWith

body

any

false

none

»» exceptWith

body

any

false

none

» columns

body

[Varicent.RESTAPI.v1.DTOs.InputFormColumnDTO]¦null

false

none

»» column

body

Varicent.RESTAPI.v1.DTOs.ColumnDefinitionDTO

false

none

»»» column

body

Varicent.RESTAPI.v1.DTOs.CustomColumnDTO

false

none

»»»» name

body

string¦null

false

none

»»»» type

body

string

false

none

»»»» referencedTable

body

string¦null

false

none

»»»» referencedName

body

string¦null

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»»»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»»»» sourceNames

body

object¦null

false

none

»»»»»» additionalProperties

body

string¦null

false

none

»»»» pickListParams

body

[Varicent.RESTAPI.v1.DTOs.PickListParamDTO]¦null

false

none

»»»»» joinAlias

body

string¦null

false

none

»»»»» joinColumn

body

string¦null

false

none

»»»»» op

body

string

false

none

»»»» isKey

body

boolean

false

none

»»» isRemovable

body

boolean

false

none

»»» isNullable

body

boolean

false

none

»»» referencedColumn

body

string¦null

false

none

»» defaultValue

body

Varicent.RESTAPI.v1.DTOs.DefaultValueDTO

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» dataType

body

string

false

none

»»» value

body

any

false

none

»»» valid

body

boolean

false

none

»» isReadOnly

body

boolean

false

none

»» alias

body

string¦null

false

none

»» referenceOptions

body

[Varicent.RESTAPI.v1.DTOs.ReferenceOptionDTO]¦null

false

none

»»» type

body

string

false

none

»»» referencedColumn

body

string¦null

false

none

»»» isJumpTo

body

boolean

false

none

»»» tabName

body

string¦null

false

none

»»» referencedInputFormName

body

string¦null

false

none

»»» referencedInputFormId

body

integer(int32)

false

none

»»» referencedTable

body

string¦null

false

none

» rules

body

[Varicent.RESTAPI.v1.DTOs.ValidationRuleDTO]¦null

false

none

»» name

body

string¦null

false

none

»» table

body

string¦null

false

none

»» column

body

string¦null

false

none

»» comment

body

string¦null

false

none

»» rule

body

string¦null

false

none

»» type

body

string

false

none

» name

body

string¦null

false

none

» table

body

Varicent.RESTAPI.v1.DTOs.CustomTableDTO

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» name

body

string¦null

false

none

»» tableType

body

string

false

none

»» effectiveDated

body

boolean

false

none

»» workflowObjectID

body

integer(int32)

false

none

»» hierarchyMetadata

body

RESTAPI.v1.DTOs.Hierarchy.HierarchyMetadataDTO

false

none

»»» tableName

body

string¦null

false

none

»»» idColumnName

body

string¦null

false

none

»»» parentColumnName

body

string¦null

false

none

»» lastUpdatedTracking

body

boolean¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

»»» dataType

Int

»»» dataType

Decimal

»»» dataType

DateTime

»»» dataType

None

»»» dataType

String

»»» type

SelectAll

»»» type

SelectItem

»»» type

SelectLiteral

»»» type

SelectCustom

»»» type

SelectExpression

»»»» expressionType

caseExpression

»»»» expressionType

dataField

»»»» expressionType

function

»»»» expressionType

ifExpression

»»»» expressionType

literal

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» constraintType

clause

»»»»»» constraintType

constraint

»»»»»» constraintType

expressionConstraint

»»»»»» constraintType

likeConstraint

»»»»»» constraintType

rowVersionConstraint

»»»»»» constraintType

subQueryConstraint

»»»»»»» expressionType

caseExpression

»»»»»»» expressionType

dataField

»»»»»»» expressionType

function

»»»»»»» expressionType

ifExpression

»»»»»»» expressionType

literal

»»»»»»» literalType

Integer

»»»»»»» literalType

Decimal

»»»»»»» literalType

Date

»»»»»»» literalType

DateTime

»»»»»»» literalType

String

»»»»»»» literalType

Float

»»»»»»» literalType

Long

»»»»»»» literalType

Null

»»»»»»» literalType

Parameter

»»»»»»» literalType

Guid

»»»»»»» literalType

SystemUtcTime

»»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» literalType

Integer

»»»» literalType

Decimal

»»»» literalType

Date

»»»» literalType

DateTime

»»»» literalType

String

»»»» literalType

Float

»»»» literalType

Long

»»»» literalType

Null

»»»» literalType

Parameter

»»»» literalType

Guid

»»»» literalType

SystemUtcTime

»»»» literalType

Boolean

»»» sourceType

Table

»»» sourceType

Query

»»» joinType

Inner

»»» joinType

Left

»»» joinType

Right

»»» joinType

Cross

»»» joinType

CrossApply

»»» joinType

OuterApply

»»»» constraintType

clause

»»»» constraintType

constraint

»»»» constraintType

expressionConstraint

»»»» constraintType

likeConstraint

»»»» constraintType

rowVersionConstraint

»»»» constraintType

subQueryConstraint

»»» direction

Ascending

»»» direction

Descending

»»» direction

AscendingNullsFirst

»»» direction

DescendingNullsLast

»»»» type

Text

»»»» type

Date

»»»» type

List

»»»» type

Numeric

»»»» type

Email

»»»» type

Url

»»»» type

Comment

»»»» type

DateTime

»»»»» op

LessThan

»»»»» op

LessThanEquals

»»»»» op

Equals

»»»»» op

NotEquals

»»»»» op

GreaterThan

»»»»» op

GreaterThanEquals

»»»»» op

IsNull

»»»»» op

IsNotNull

»»»»» op

In

»»»»» op

NotIn

»»» dataType

Text

»»» dataType

Date

»»» dataType

List

»»» dataType

Numeric

»»» dataType

Email

»»» dataType

Url

»»» dataType

Comment

»»» dataType

DateTime

»»» type

ReferenceOptionInputForm

»»» type

ReferenceOptionTable

»» type

Text

»» type

Numeric

»» tableType

System

»» tableType

Dimension

»» tableType

Structural

»» tableType

Lookup

»» tableType

Data

»» tableType

View

»» tableType

Custom

»» tableType

StarSchema

»» tableType

ExportTable

»» tableType

CreditingRule

»» tableType

AssignTable

»» tableType

PlcmCustomTable

»» tableType

PlcmStructuralTable

»» tableType

PlcmTable

»» tableType

DataSource

»» tableType

Cached

»» tableType

MaterializedView

Responses

Status

Meaning

Description

Schema

200

OK

Update Input Form by Id.

Varicent.RESTAPI.v1.DTOs.InputFormDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/customtables/{tablename}/inputforms/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtables/{tablename}/inputforms/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "basedOnTable": "string",
  "query": {
    "selectItems": [
      {}
    ],
    "source": {
      "namespaceTable": {},
      "query": null,
      "alias": "string",
      "sourceType": "Table"
    },
    "joins": [
      {}
    ],
    "whereClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "order": [
      {}
    ],
    "group": [
      {}
    ],
    "havingClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "distinct": true,
    "unionWith": null,
    "exceptWith": null
  },
  "columns": [
    {
      "column": {},
      "defaultValue": {},
      "isReadOnly": true,
      "alias": "string",
      "referenceOptions": []
    }
  ],
  "rules": [
    {
      "name": "string",
      "table": "string",
      "column": "string",
      "comment": "string",
      "rule": "string",
      "type": "Text"
    }
  ],
  "name": "string",
  "table": {
    "version": {
      "rowVersion": 0
    },
    "name": "string",
    "tableType": "System",
    "effectiveDated": true,
    "workflowObjectID": 0,
    "hierarchyMetadata": {
      "tableName": "string",
      "idColumnName": "string",
      "parentColumnName": "string"
    },
    "lastUpdatedTracking": true
  },
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/customtables/{tablename}/inputforms/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/customtables/{tablename}/inputforms/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/customtables/{tablename}/inputforms/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

Delete an input form.

Parameters

Name

In

Type

Required

Description

tablename

path

string

true

none

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Delete Input Form

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/customtables/{tablename}/inputforms/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtables/{tablename}/inputforms/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/customtables/{tablename}/inputforms/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/customtables/{tablename}/inputforms/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/customtables/{tablename}/inputforms/{id}',
  params: {
  }

p JSON.parse(result)

Get count of input form query by ID.

Parameters

Name

In

Type

Required

Description

tablename

path

string

true

none

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get Input Form by Id

Varicent.RESTAPI.v1.DTOs.InputFormDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/customtables/{tablename}/inputforms/{id}/count", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtables/{tablename}/inputforms/{id}/count");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/customtables/{tablename}/inputforms/{id}/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/customtables/{tablename}/inputforms/{id}/count', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/customtables/{tablename}/inputforms/{id}/count',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "basedOnTable": "string",
  "query": {
    "selectItems": [
      {}
    ],
    "source": {
      "namespaceTable": {},
      "query": null,
      "alias": "string",
      "sourceType": "Table"
    },
    "joins": [
      {}
    ],
    "whereClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "order": [
      {}
    ],
    "group": [
      {}
    ],
    "havingClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "distinct": true,
    "unionWith": null,
    "exceptWith": null
  },
  "columns": [
    {
      "column": {},
      "defaultValue": {},
      "isReadOnly": true,
      "alias": "string",
      "referenceOptions": []
    }
  ],
  "rules": [
    {
      "name": "string",
      "table": "string",
      "column": "string",
      "comment": "string",
      "rule": "string",
      "type": "Text"
    }
  ],
  "name": "string",
  "table": {
    "version": {
      "rowVersion": 0
    },
    "name": "string",
    "tableType": "System",
    "effectiveDated": true,
    "workflowObjectID": 0,
    "hierarchyMetadata": {
      "tableName": "string",
      "idColumnName": "string",
      "parentColumnName": "string"
    },
    "lastUpdatedTracking": true
  },
  "version": {
    "rowVersion": 0
  }
}
{"id":0,"basedOnTable":"string","query":{"selectItems":[{}],"source":{"namespaceTable":{},"query":null,"alias":"string","sourceType":"Table"},"joins":[{}],"whereClause":{"constraintType":"clause","op":"string","dataFieldLeft":{},"caseSensitive":true,"constraints":[],"literalRight":{},"dataFieldRight":{},"right":{},"expressionLeft":{},"expressionRight":{},"isPreciseDecimal":true,"like":"string","escapeWildcards":true,"rowVersion":{},"table":"string","queryDefinitionRight":null},"order":[{}],"group":[{}],"havingClause":{"constraintType":"clause","op":"string","dataFieldLeft":{},"caseSensitive":true,"constraints":[],"literalRight":{},"dataFieldRight":{},"right":{},"expressionLeft":{},"expressionRight":{},"isPreciseDecimal":true,"like":"string","escapeWildcards":true,"rowVersion":{},"table":"string","queryDefinitionRight":null},"distinct":true,"unionWith":null,"exceptWith":null},"columns":[{"column":{},"defaultValue":{},"isReadOnly":true,"alias":"string","referenceOptions":[]}],"rules":[{"name":"string","table":"string","column":"string","comment":"string","rule":"string","type":"Text"}],"name":"string","table":{"version":{"rowVersion":0},"name":"string","tableType":"System","effectiveDated":true,"workflowObjectID":0,"hierarchyMetadata":{"tableName":"string","idColumnName":"string","parentColumnName":"string"},"lastUpdatedTracking":true},"version":{"rowVersion":0}}

Gets the jump-to destinations for the given column.

Parameters

Name

In

Type

Required

Description

tablename

path

string

true

none

id

path

integer(int32)

true

none

columnname

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get jump destinations

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.JumpDestinationDTO]

false

none

none

» name

string¦null

false

none

none

» destination

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/customtables/{tablename}/inputforms/{id}/columns/{columnname}/jumpdestinations", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtables/{tablename}/inputforms/{id}/columns/{columnname}/jumpdestinations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/customtables/{tablename}/inputforms/{id}/columns/{columnname}/jumpdestinations',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/customtables/{tablename}/inputforms/{id}/columns/{columnname}/jumpdestinations', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/customtables/{tablename}/inputforms/{id}/columns/{columnname}/jumpdestinations',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "name": "string",
    "destination": "string"
  }
]
[{"name":"string","destination":"string"}]

Model

ModelControllerV1_Optimize

Responses

Status

Meaning

Description

Schema

200

OK

Optimize the current model

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/optimize", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/optimize");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/rpc/optimize',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/v1/rpc/optimize')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/v1/rpc/optimize',
  params: {
  }

p JSON.parse(result)

ModelControllerV1_GetModelSummary

Responses

Status

Meaning

Description

Schema

200

OK

Get current model summary information

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.ModelStatsDTO]

false

none

none

» numberOfCalculations

integer(int32)

false

none

none

» numberOfDraws

integer(int32)

false

none

none

» numberOfDataStores

integer(int32)

false

none

none

» numberOfWebForms

integer(int32)

false

none

none

» numberOfPresenterReports

integer(int32)

false

none

none

» numberOfUsersWithWebAccess

integer(int32)

false

none

none

» numberOfCalculationsRanMoreThanIdealTime

integer(int32)

false

none

none

» numberOfUsersWithClientAccess

integer(int32)

false

none

none

» numberOfRapidReports

integer(int32)

false

none

none

» numberOfDiscoveryDashboards

integer(int32)

false

none

none

» numberOfPresenterFlexReports

integer(int32)

false

none

none

» numberOfSavedImports

integer(int32)

false

none

none

» lastImportDate

string¦null

false

none

none

» numberOfCalendars

integer(int32)

false

none

none

» lastLockedCalenderId

string¦null

false

none

none

» lastLockedCalenderPeriod

string¦null

false

none

none

» lastLockedCalenderEnding

string¦null

false

none

none

» numberOfTables

integer(int32)

false

none

none

» hasPendingWebDataEdits

boolean

false

none

none

» payeesTransactional

integer(int32)

false

none

none

» payeesNonTransactional

integer(int32)

false

none

none

» payeesInactive

integer(int32)

false

none

none

» payeesUnmapped

integer(int32)

false

none

none

» modelSize

number(double)

false

none

none

» lastCalculationDate

string¦null

false

none

none

» lastFullCalculationDate

string¦null

false

none

none

» lastCalculationDuration

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/modelsummary", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/modelsummary");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/modelsummary',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/modelsummary', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/modelsummary',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "numberOfCalculations": 0,
    "numberOfDraws": 0,
    "numberOfDataStores": 0,
    "numberOfWebForms": 0,
    "numberOfPresenterReports": 0,
    "numberOfUsersWithWebAccess": 0,
    "numberOfCalculationsRanMoreThanIdealTime": 0,
    "numberOfUsersWithClientAccess": 0,
    "numberOfRapidReports": 0,
    "numberOfDiscoveryDashboards": 0,
    "numberOfPresenterFlexReports": 0,
    "numberOfSavedImports": 0,
    "lastImportDate": "string",
    "numberOfCalendars": 0,
    "lastLockedCalenderId": "string",
    "lastLockedCalenderPeriod": "string",
    "lastLockedCalenderEnding": "string",
    "numberOfTables": 0,
    "hasPendingWebDataEdits": true,
    "payeesTransactional": 0,
    "payeesNonTransactional": 0,
    "payeesInactive": 0,
    "payeesUnmapped": 0,
    "modelSize": 0.1,
    "lastCalculationDate": "string",
    "lastFullCalculationDate": "string",
    "lastCalculationDuration": "string"
  }
]
[{"numberOfCalculations":0,"numberOfDraws":0,"numberOfDataStores":0,"numberOfWebForms":0,"numberOfPresenterReports":0,"numberOfUsersWithWebAccess":0,"numberOfCalculationsRanMoreThanIdealTime":0,"numberOfUsersWithClientAccess":0,"numberOfRapidReports":0,"numberOfDiscoveryDashboards":0,"numberOfPresenterFlexReports":0,"numberOfSavedImports":0,"lastImportDate":"string","numberOfCalendars":0,"lastLockedCalenderId":"string","lastLockedCalenderPeriod":"string","lastLockedCalenderEnding":"string","numberOfTables":0,"hasPendingWebDataEdits":true,"payeesTransactional":0,"payeesNonTransactional":0,"payeesInactive":0,"payeesUnmapped":0,"modelSize":0.1,"lastCalculationDate":"string","lastFullCalculationDate":"string","lastCalculationDuration":"string"}]

ModelControllerV1_GetModelLastCalcInfo

Responses

Status

Meaning

Description

Schema

200

OK

Get current model calc time information

RESTAPI.v1.DTOs.LastCalculationInfoDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/modelsummary/calcinfo", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/modelsummary/calcinfo");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/modelsummary/calcinfo',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/modelsummary/calcinfo', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/modelsummary/calcinfo',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "lastCalculationDate": "string",
  "lastFullCalculationDate": "string",
  "lastCalculationDuration": "string"
}
{"lastCalculationDate":"string","lastFullCalculationDate":"string","lastCalculationDuration":"string"}

Changes all the specified administrator options to new values.

Body parameter

[
  {
    "key": "string",
    "value": null,
    "version": {
      "rowVersion": 0
    }
  }
]

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.ConfigValueDTO

false

A list of the configuration values to be changed.

Responses

Status

Meaning

Description

Schema

200

OK

Set the model administrator options

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.ConfigValueDTO]

false

none

none

» key

string¦null

false

none

none

» value

any

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/adminoptions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/adminoptions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "key": "string",
    "value": null,
    "version": {
      "rowVersion": 0
    }
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/adminoptions',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/adminoptions', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/adminoptions',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "key": "string",
    "value": null,
    "version": {
      "rowVersion": 0
    }
  }
]
[{"key":"string","value":null,"version":{"rowVersion":0}}]

Get all the administrator options.

Responses

Status

Meaning

Description

Schema

200

OK

Get the model administrator options

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.ConfigValueDTO]

false

none

none

» key

string¦null

false

none

none

» value

any

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/adminoptions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/adminoptions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/adminoptions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/adminoptions', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/adminoptions',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "key": "string",
    "value": null,
    "version": {
      "rowVersion": 0
    }
  }
]
[{"key":"string","value":null,"version":{"rowVersion":0}}]

Gets the model theme.

Responses

Status

Meaning

Description

Schema

200

OK

Gets the model theme

RESTAPI.v1.DTOs.ConfigValueDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/modeltheme", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/modeltheme");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/modeltheme',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/modeltheme', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/modeltheme',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "key": "string",
  "value": null,
  "version": {
    "rowVersion": 0
  }
}
{"key":"string","value":null,"version":{"rowVersion":0}}

Sets the model theme, potentially for many different models.

Body parameter

{
  "property1": {
    "key": "string",
    "value": null,
    "version": {
      "rowVersion": 0
    }
  },
  "property2": {
    "key": "string",
    "value": null,
    "version": {
      "rowVersion": 0
    }
  }
}

Parameters

Name

In

Type

Required

Description

body

body

object

false

none

» additionalProperties

body

RESTAPI.v1.DTOs.ConfigValueDTO

false

none

»» key

body

string¦null

false

none

»» value

body

any

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» rowVersion

body

integer(int64)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Sets the model themes

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

RESTAPI.v1.DTOs.ConfigValueDTO

false

none

none

»» key

string¦null

false

none

none

»» value

any

false

none

none

»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»» rowVersion

integer(int64)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/modeltheme", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/modeltheme");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "property1": {
    "key": "string",
    "value": null,
    "version": {
      "rowVersion": 0
    }
  },
  "property2": {
    "key": "string",
    "value": null,
    "version": {
      "rowVersion": 0
    }
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/modeltheme',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/modeltheme', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/modeltheme',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "property1": {
    "key": "string",
    "value": null,
    "version": {
      "rowVersion": 0
    }
  },
  "property2": {
    "key": "string",
    "value": null,
    "version": {
      "rowVersion": 0
    }
  }
}
{"property1":{"key":"string","value":null,"version":{"rowVersion":0}},"property2":{"key":"string","value":null,"version":{"rowVersion":0}}}

Gets the model themes for all accessible models.

Responses

Status

Meaning

Description

Schema

200

OK

Gets the model theme

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

RESTAPI.v1.DTOs.ConfigValueDTO

false

none

none

»» key

string¦null

false

none

none

»» value

any

false

none

none

»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»» rowVersion

integer(int64)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/modelthememap", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/modelthememap");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/modelthememap',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/modelthememap', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/modelthememap',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "property1": {
    "key": "string",
    "value": null,
    "version": {
      "rowVersion": 0
    }
  },
  "property2": {
    "key": "string",
    "value": null,
    "version": {
      "rowVersion": 0
    }
  }
}
{"property1":{"key":"string","value":null,"version":{"rowVersion":0}},"property2":{"key":"string","value":null,"version":{"rowVersion":0}}}

Update watson assistant configuration.

Body parameter

{
  "assistantId": "string",
  "assistantEnabled": true
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.WatsonAssistantConfigDTO

false

assistant settings (id and enabled state)

» assistantId

body

string¦null

false

none

» assistantEnabled

body

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Patch Watson Assistant Config.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/watsonassistantconfig", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/watsonassistantconfig");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "assistantId": "string",
  "assistantEnabled": true
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/watsonassistantconfig',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/watsonassistantconfig', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/watsonassistantconfig',
  params: {
  }, headers: headers

p JSON.parse(result)

Get watson assistant configuration.

Responses

Status

Meaning

Description

Schema

200

OK

Get Watson Assistant Config.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/watsonassistantconfig", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/watsonassistantconfig");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/watsonassistantconfig',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.get('http://localhost:8080/api/v1/watsonassistantconfig')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.get 'http://localhost:8080/api/v1/watsonassistantconfig',
  params: {
  }

p JSON.parse(result)

Gets the suppress warning messages setting for the current user.

Responses

Status

Meaning

Description

Schema

200

OK

Gets the suppress warning messages setting for the current user.

boolean

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/suppresswarningmessages", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/suppresswarningmessages");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/suppresswarningmessages',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/suppresswarningmessages', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/suppresswarningmessages',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
true
true

Toggles the suppress warning messages setting for the current user.

Parameters

Name

In

Type

Required

Description

messageType

path

string

true

none

Enumerated Values

Parameter

Value

messageType

CustomizeDeleteRowsWithSingleDependentTableConfirm

messageType

CustomizeDeleteRowsWithMultipleDependentTableConfirm

messageType

CustomizeDeleteRowsWithSingleDependentTableEffectiveConfirm

Responses

Status

Meaning

Description

Schema

200

OK

Toggles the suppress warning messages setting for the current user.

boolean

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/suppresswarningmessages/{messageType}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/suppresswarningmessages/{messageType}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/suppresswarningmessages/{messageType}',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/suppresswarningmessages/{messageType}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/suppresswarningmessages/{messageType}',
  params: {
  }, headers: headers

p JSON.parse(result)

Get the user-specified model name.

Responses

Status

Meaning

Description

Schema

200

OK

User-specified model name

string

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/model/name", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/model/name");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/model/name',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/model/name', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/model/name',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
"string"
"string"

System Call

Get the value of a specified key

Parameters

Name

In

Type

Required

Description

key

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Gets the value of a specified key

string

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/config/{key}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/config/{key}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/config/{key}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/config/{key}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/config/{key}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
"string"
"string"

Gets the theme for the current user.

Parameters

Name

In

Type

Required

Description

getBackground

query

string

false

none

Enumerated Values

Parameter

Value

getBackground

None

getBackground

Selected

getBackground

All

Responses

Status

Meaning

Description

Schema

200

OK

Gets the theme for the current user.

RESTAPI.v1.DTOs.ThemeDTORESTAPI.v1.DTOs.ThemeDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/theme", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/theme");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/theme',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/theme', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/theme',
  params: {
  }, headers: headers

p JSON.parse(result)

Updates the theme for the current user.

Body parameter

{
  "isEnabled": true,
  "headerImage": "string",
  "webThemeType": "Standard",
  "version": {
    "rowVersion": 0
  },
  "headerImageName": "string",
  "backgroundImages": [
    {
      "isNew": true,
      "image": "string",
      "id": 0,
      "cosObjectName": "string",
      "expiryDate": "2019-08-24T14:15:22Z",
      "imageUrl": "string"
    }
  ],
  "selectedBackgroundImage": 0,
  "themeColor": "string",
  "navStyle": "string",
  "mobileEnabled": true,
  "qrCodeEnabled": true,
  "isMobileDemoEnabled": true,
  "isSlackEnabled": true,
  "isWebViewForMobileSSOEnabled": true,
  "isLeftSideNavigationEnabled": true,
  "isFooterEnabled": true,
  "footerTheme": "Light",
  "footerImageMode": "None",
  "footerImagePosition": "TopLeft",
  "footerImageName": "string",
  "footerImage": "string",
  "footerText": "string",
  "footerCustomSettings": {
    "backgroundColor": "string",
    "textColor": "string",
    "linkColor": "string"
  },
  "navBarCustomSettings": {
    "backgroundColor": "string",
    "highlightColor": "string",
    "textIconColor": "string"
  },
  "navLogoImageMode": "None",
  "navLogoImage": "string",
  "organizationLogoImageMode": "None",
  "isTaglineEnabled": true,
  "taglineText": "string",
  "menuItemAlignment": "Left",
  "navBarTheme": "Light"
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.ThemeDTO

false

none

» isEnabled

body

boolean

false

none

» headerImage

body

string(byte)¦null

false

none

» webThemeType

body

string

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

» headerImageName

body

string¦null

false

none

» backgroundImages

body

[Varicent.RESTAPI.v1.DTOs.BackgroundImageDTO]¦null

false

none

»» isNew

body

boolean

false

none

»» image

body

string(byte)¦null

false

none

»» id

body

integer(int32)

false

none

»» cosObjectName

body

string¦null

false

none

»» expiryDate

body

string(date-time)¦null

false

none

»» imageUrl

body

string¦null

false

none

» selectedBackgroundImage

body

integer(int32)¦null

false

none

» themeColor

body

string¦null

false

none

» navStyle

body

string¦null

false

none

» mobileEnabled

body

boolean¦null

false

none

» qrCodeEnabled

body

boolean¦null

false

none

» isMobileDemoEnabled

body

boolean¦null

false

none

» isSlackEnabled

body

boolean¦null

false

none

» isWebViewForMobileSSOEnabled

body

boolean¦null

false

none

» isLeftSideNavigationEnabled

body

boolean¦null

false

none

» isFooterEnabled

body

boolean¦null

false

none

» footerTheme

body

string

false

none

» footerImageMode

body

string

false

none

» footerImagePosition

body

string

false

none

» footerImageName

body

string¦null

false

none

» footerImage

body

string(byte)¦null

false

none

» footerText

body

string¦null

false

none

» footerCustomSettings

body

Varicent.Domain.Themes.FooterCustomColor

false

none

»» backgroundColor

body

string¦null

false

none

»» textColor

body

string¦null

false

none

»» linkColor

body

string¦null

false

none

» navBarCustomSettings

body

Varicent.Domain.Themes.NavBarCustomColor

false

none

»» backgroundColor

body

string¦null

false

none

»» highlightColor

body

string¦null

false

none

»» textIconColor

body

string¦null

false

none

» navLogoImageMode

body

string

false

none

» navLogoImage

body

string(byte)¦null

false

none

» organizationLogoImageMode

body

string

false

none

» isTaglineEnabled

body

boolean¦null

false

none

» taglineText

body

string¦null

false

none

» menuItemAlignment

body

string

false

none

» navBarTheme

body

string

false

none

Enumerated Values

Parameter

Value

» webThemeType

Standard

» webThemeType

SFDC

» webThemeType

Modern

» footerTheme

Light

» footerTheme

Dark

» footerTheme

Custom

» footerImageMode

None

» footerImageMode

UseHeader

» footerImageMode

Upload

» footerImagePosition

TopLeft

» footerImagePosition

TopRight

» navLogoImageMode

None

» navLogoImageMode

UseHeader

» navLogoImageMode

Upload

» organizationLogoImageMode

None

» organizationLogoImageMode

UseHeader

» organizationLogoImageMode

Upload

» menuItemAlignment

Left

» menuItemAlignment

Right

» navBarTheme

Light

» navBarTheme

Dark

» navBarTheme

Custom

Responses

Status

Meaning

Description

Schema

200

OK

Updates the theme for the current user.

RESTAPI.v1.DTOs.ThemeDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/theme", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/theme");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "isEnabled": true,
  "headerImage": "string",
  "webThemeType": "Standard",
  "version": {
    "rowVersion": 0
  },
  "headerImageName": "string",
  "backgroundImages": [
    {
      "isNew": true,
      "image": "string",
      "id": 0,
      "cosObjectName": "string",
      "expiryDate": "2019-08-24T14:15:22Z",
      "imageUrl": "string"
    }
  ],
  "selectedBackgroundImage": 0,
  "themeColor": "string",
  "navStyle": "string",
  "mobileEnabled": true,
  "qrCodeEnabled": true,
  "isMobileDemoEnabled": true,
  "isSlackEnabled": true,
  "isWebViewForMobileSSOEnabled": true,
  "isLeftSideNavigationEnabled": true,
  "isFooterEnabled": true,
  "footerTheme": "Light",
  "footerImageMode": "None",
  "footerImagePosition": "TopLeft",
  "footerImageName": "string",
  "footerImage": "string",
  "footerText": "string",
  "footerCustomSettings": {
    "backgroundColor": "string",
    "textColor": "string",
    "linkColor": "string"
  },
  "navBarCustomSettings": {
    "backgroundColor": "string",
    "highlightColor": "string",
    "textIconColor": "string"
  },
  "navLogoImageMode": "None",
  "navLogoImage": "string",
  "organizationLogoImageMode": "None",
  "isTaglineEnabled": true,
  "taglineText": "string",
  "menuItemAlignment": "Left",
  "navBarTheme": "Light"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/theme',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/theme', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/theme',
  params: {
  }, headers: headers

p JSON.parse(result)

FOR LOGIN PAGE ONLY - an unauthenticated tenant services call uses this

Gets the theme for the current user

Responses

Status

Meaning

Description

Schema

200

OK

Gets the theme for the current user.

RESTAPI.v1.DTOs.ThemeDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/payeemodeltheme", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payeemodeltheme");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/payeemodeltheme',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/payeemodeltheme', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/payeemodeltheme',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "isEnabled": true,
  "headerImage": "string",
  "webThemeType": "Standard",
  "version": {
    "rowVersion": 0
  },
  "headerImageName": "string",
  "backgroundImages": [
    {
      "isNew": true,
      "image": "string",
      "id": 0,
      "cosObjectName": "string",
      "expiryDate": "2019-08-24T14:15:22Z",
      "imageUrl": "string"
    }
  ],
  "selectedBackgroundImage": 0,
  "themeColor": "string",
  "navStyle": "string",
  "mobileEnabled": true,
  "qrCodeEnabled": true,
  "isMobileDemoEnabled": true,
  "isSlackEnabled": true,
  "isWebViewForMobileSSOEnabled": true,
  "isLeftSideNavigationEnabled": true,
  "isFooterEnabled": true,
  "footerTheme": "Light",
  "footerImageMode": "None",
  "footerImagePosition": "TopLeft",
  "footerImageName": "string",
  "footerImage": "string",
  "footerText": "string",
  "footerCustomSettings": {
    "backgroundColor": "string",
    "textColor": "string",
    "linkColor": "string"
  },
  "navBarCustomSettings": {
    "backgroundColor": "string",
    "highlightColor": "string",
    "textIconColor": "string"
  },
  "navLogoImageMode": "None",
  "navLogoImage": "string",
  "organizationLogoImageMode": "None",
  "isTaglineEnabled": true,
  "taglineText": "string",
  "menuItemAlignment": "Left",
  "navBarTheme": "Light"
}
{"isEnabled":true,"headerImage":"string","webThemeType":"Standard","version":{"rowVersion":0},"headerImageName":"string","backgroundImages":[{"isNew":true,"image":"string","id":0,"cosObjectName":"string","expiryDate":"2019-08-24T14:15:22Z","imageUrl":"string"}],"selectedBackgroundImage":0,"themeColor":"string","navStyle":"string","mobileEnabled":true,"qrCodeEnabled":true,"isMobileDemoEnabled":true,"isSlackEnabled":true,"isWebViewForMobileSSOEnabled":true,"isLeftSideNavigationEnabled":true,"isFooterEnabled":true,"footerTheme":"Light","footerImageMode":"None","footerImagePosition":"TopLeft","footerImageName":"string","footerImage":"string","footerText":"string","footerCustomSettings":{"backgroundColor":"string","textColor":"string","linkColor":"string"},"navBarCustomSettings":{"backgroundColor":"string","highlightColor":"string","textIconColor":"string"},"navLogoImageMode":"None","navLogoImage":"string","organizationLogoImageMode":"None","isTaglineEnabled":true,"taglineText":"string","menuItemAlignment":"Left","navBarTheme":"Light"}

Delete Specified background image

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Delete Specified background image id

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/modeltheme/backgroundimage/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/modeltheme/backgroundimage/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/modeltheme/backgroundimage/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/modeltheme/backgroundimage/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/modeltheme/backgroundimage/{id}',
  params: {
  }

p JSON.parse(result)

Updates the report for plans.

Parameters

Name

In

Type

Required

Description

reportID

query

integer(int32)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Updates the report for plans.

integer

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/selectreport", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/selectreport");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/selectreport',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/selectreport', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/selectreport',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
0
0

Get selected report ID.

Responses

Status

Meaning

Description

Schema

200

OK

Get id of selected report of plans.

integer

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/getselectedreportid", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/getselectedreportid");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/getselectedreportid',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/getselectedreportid', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/getselectedreportid',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
0
0

Models_GetSftpData

Parameters

Name

In

Type

Required

Description

modelID

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get SFTP Data by model id

Varicent.RESTAPI.Models.SftpDataDTO

404

Not Found

model does not exist

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/models/{modelID}/sftp", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/models/{modelID}/sftp");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/models/{modelID}/sftp',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/models/{modelID}/sftp', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/models/{modelID}/sftp',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "tenant_id": "string",
  "model_id": "string",
  "model_name": "string",
  "sftp_quota_gb": 0,
  "sftp_usage_mb": 0,
  "sftp_usage_last_updated": "string"
}
{"tenant_id":"string","model_id":"string","model_name":"string","sftp_quota_gb":0,"sftp_usage_mb":0,"sftp_usage_last_updated":"string"}

Models_GetFlags

Responses

Status

Meaning

Description

Schema

200

OK

Get splitIO feature flags

Inline

404

Not Found

Flags can not be found

None

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/models/flags", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/models/flags");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/models/flags',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/models/flags', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/models/flags',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "property1": "string",
  "property2": "string"
}
{"property1":"string","property2":"string"}

Get current month.

Responses

Status

Meaning

Description

Schema

200

OK

Get current month

string

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/getcurrentmonth", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/getcurrentmonth");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/getcurrentmonth',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/getcurrentmonth', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/getcurrentmonth',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
"string"
"string"

Get periods.

Responses

Status

Meaning

Description

Schema

200

OK

Get periods

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/getperiods", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/getperiods");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/getperiods',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/getperiods', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/getperiods',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  "string"
]
["string"]

People

Create team.

Body parameter

{
  "id": 0,
  "name": "string",
  "isActive": true,
  "isFavorite": true,
  "plans": [
    {
      "id": 0,
      "name": "string",
      "isFavorite": true,
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "description": "string"
    }
  ],
  "payees": [
    {
      "name": "string",
      "id": "string"
    }
  ]
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.People.TeamDTO

false

none

» id

body

integer(int32)¦null

false

none

» name

body

string¦null

false

none

» isActive

body

boolean

false

none

» isFavorite

body

boolean

false

none

» plans

body

[Varicent.RESTAPI.v1.DTOs.Plans.PlanDTO]¦null

false

none

»» id

body

integer(int32)¦null

false

none

»» name

body

string¦null

false

none

»» isFavorite

body

boolean

false

none

»» startDate

body

string(date-time)

false

none

»» endDate

body

string(date-time)

false

none

»» description

body

string¦null

false

none

» payees

body

[Varicent.RESTAPI.v1.DTOs.PayeeNameDTO]¦null

false

none

»» name

body

string¦null

false

none

»» id

body

string¦null

false

none

Responses

Status

Meaning

Description

Schema

201

Created

Team is created.

Varicent.RESTAPI.v1.DTOs.People.TeamDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/people/teams", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/people/teams");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "name": "string",
  "isActive": true,
  "isFavorite": true,
  "plans": [
    {
      "id": 0,
      "name": "string",
      "isFavorite": true,
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "description": "string"
    }
  ],
  "payees": [
    {
      "name": "string",
      "id": "string"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/people/teams',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/people/teams', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/people/teams',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "isActive": true,
  "isFavorite": true,
  "plans": [
    {
      "id": 0,
      "name": "string",
      "isFavorite": true,
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "description": "string"
    }
  ],
  "payees": [
    {
      "name": "string",
      "id": "string"
    }
  ]
}
{"id":0,"name":"string","isActive":true,"isFavorite":true,"plans":[{"id":0,"name":"string","isFavorite":true,"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","description":"string"}],"payees":[{"name":"string","id":"string"}]}

Get teams.

Parameters

Name

In

Type

Required

Description

limit

query

integer(int32)

false

none

offset

query

integer(int32)

false

none

includePayees

query

boolean

false

none

favoritesOnly

query

boolean

false

none

orderBy

query

string

false

none

filterBy

query

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Teams are returned.

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.People.TeamDTO]

false

none

none

» id

integer(int32)¦null

false

none

none

» name

string¦null

false

none

none

» isActive

boolean

false

none

none

» isFavorite

boolean

false

none

none

» plans

[Varicent.RESTAPI.v1.DTOs.Plans.PlanDTO]¦null

false

none

none

»» id

integer(int32)¦null

false

none

none

»» name

string¦null

false

none

none

»» isFavorite

boolean

false

none

none

»» startDate

string(date-time)

false

none

none

»» endDate

string(date-time)

false

none

none

»» description

string¦null

false

none

none

» payees

[Varicent.RESTAPI.v1.DTOs.PayeeNameDTO]¦null

false

none

none

»» name

string¦null

false

none

none

»» id

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/people/teams", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/people/teams");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/people/teams',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/people/teams', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/people/teams',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "name": "string",
    "isActive": true,
    "isFavorite": true,
    "plans": [
      {}
    ],
    "payees": [
      {}
    ]
  }
]
[{"id":0,"name":"string","isActive":true,"isFavorite":true,"plans":[{}],"payees":[{}]}]

Update team.

Body parameter

{
  "id": 0,
  "name": "string",
  "isActive": true,
  "isFavorite": true,
  "plans": [
    {
      "id": 0,
      "name": "string",
      "isFavorite": true,
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "description": "string"
    }
  ],
  "payees": [
    {
      "name": "string",
      "id": "string"
    }
  ]
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.People.TeamDTO

false

none

» id

body

integer(int32)¦null

false

none

» name

body

string¦null

false

none

» isActive

body

boolean

false

none

» isFavorite

body

boolean

false

none

» plans

body

[Varicent.RESTAPI.v1.DTOs.Plans.PlanDTO]¦null

false

none

»» id

body

integer(int32)¦null

false

none

»» name

body

string¦null

false

none

»» isFavorite

body

boolean

false

none

»» startDate

body

string(date-time)

false

none

»» endDate

body

string(date-time)

false

none

»» description

body

string¦null

false

none

» payees

body

[Varicent.RESTAPI.v1.DTOs.PayeeNameDTO]¦null

false

none

»» name

body

string¦null

false

none

»» id

body

string¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Team is updated.

Varicent.RESTAPI.v1.DTOs.People.TeamDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/people/teams", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/people/teams");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "name": "string",
  "isActive": true,
  "isFavorite": true,
  "plans": [
    {
      "id": 0,
      "name": "string",
      "isFavorite": true,
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "description": "string"
    }
  ],
  "payees": [
    {
      "name": "string",
      "id": "string"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/people/teams',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/people/teams', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/people/teams',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "isActive": true,
  "isFavorite": true,
  "plans": [
    {
      "id": 0,
      "name": "string",
      "isFavorite": true,
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "description": "string"
    }
  ],
  "payees": [
    {
      "name": "string",
      "id": "string"
    }
  ]
}
{"id":0,"name":"string","isActive":true,"isFavorite":true,"plans":[{"id":0,"name":"string","isFavorite":true,"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","description":"string"}],"payees":[{"name":"string","id":"string"}]}

Get team.

Parameters

Name

In

Type

Required

Description

teamID

path

integer(int32)

true

none

includePayees

query

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Team is returned.

Varicent.RESTAPI.v1.DTOs.People.TeamDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/people/teams/{teamID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/people/teams/{teamID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/people/teams/{teamID}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/people/teams/{teamID}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/people/teams/{teamID}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "isActive": true,
  "isFavorite": true,
  "plans": [
    {
      "id": 0,
      "name": "string",
      "isFavorite": true,
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "description": "string"
    }
  ],
  "payees": [
    {
      "name": "string",
      "id": "string"
    }
  ]
}
{"id":0,"name":"string","isActive":true,"isFavorite":true,"plans":[{"id":0,"name":"string","isFavorite":true,"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","description":"string"}],"payees":[{"name":"string","id":"string"}]}

Delete team.

Parameters

Name

In

Type

Required

Description

teamID

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Team is deleted.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/people/teams/{teamID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/people/teams/{teamID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/people/teams/{teamID}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/people/teams/{teamID}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/people/teams/{teamID}',
  params: {
  }

p JSON.parse(result)

Create team payee assignment.

Body parameter

{
  "id": 0,
  "teamId": 0,
  "payeeId": "string",
  "role": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "isFavorite": true
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.People.TeamPayeeAssignmentDTO

false

none

» id

body

integer(int32)¦null

false

none

» teamId

body

integer(int32)¦null

false

none

» payeeId

body

string¦null

false

none

» role

body

string¦null

false

none

» startDate

body

string(date-time)¦null

false

none

» endDate

body

string(date-time)¦null

false

none

» isFavorite

body

boolean

false

none

Responses

Status

Meaning

Description

Schema

201

Created

Team payee assignment is created.

Varicent.RESTAPI.v1.DTOs.People.TeamPayeeAssignmentDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/people/teams/teamsPayeeAssignment", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/people/teams/teamsPayeeAssignment");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "teamId": 0,
  "payeeId": "string",
  "role": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "isFavorite": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/people/teams/teamsPayeeAssignment',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/people/teams/teamsPayeeAssignment', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/people/teams/teamsPayeeAssignment',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "teamId": 0,
  "payeeId": "string",
  "role": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "isFavorite": true
}
{"id":0,"teamId":0,"payeeId":"string","role":"string","startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","isFavorite":true}

Update team payee assignment.

Body parameter

{
  "id": 0,
  "teamId": 0,
  "payeeId": "string",
  "role": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "isFavorite": true
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.People.TeamPayeeAssignmentDTO

false

none

» id

body

integer(int32)¦null

false

none

» teamId

body

integer(int32)¦null

false

none

» payeeId

body

string¦null

false

none

» role

body

string¦null

false

none

» startDate

body

string(date-time)¦null

false

none

» endDate

body

string(date-time)¦null

false

none

» isFavorite

body

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Team payee assignment is updated.

Varicent.RESTAPI.v1.DTOs.People.TeamPayeeAssignmentDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/people/teams/teamsPayeeAssignment", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/people/teams/teamsPayeeAssignment");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "teamId": 0,
  "payeeId": "string",
  "role": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "isFavorite": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/people/teams/teamsPayeeAssignment',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/people/teams/teamsPayeeAssignment', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/people/teams/teamsPayeeAssignment',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "teamId": 0,
  "payeeId": "string",
  "role": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "isFavorite": true
}
{"id":0,"teamId":0,"payeeId":"string","role":"string","startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","isFavorite":true}

Create team payee assignments.

Body parameter

[
  {
    "id": 0,
    "teamId": 0,
    "payeeId": "string",
    "role": "string",
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "isFavorite": true
  }
]

Parameters

Name

In

Type

Required

Description

teamID

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.People.TeamPayeeAssignmentDTO

false

none

Responses

Status

Meaning

Description

Schema

201

Created

Team payee assignments are created.

Inline

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.People.TeamPayeeAssignmentDTO]

false

none

none

» id

integer(int32)¦null

false

none

none

» teamId

integer(int32)¦null

false

none

none

» payeeId

string¦null

false

none

none

» role

string¦null

false

none

none

» startDate

string(date-time)¦null

false

none

none

» endDate

string(date-time)¦null

false

none

none

» isFavorite

boolean

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/people/teams/{teamID}/teamsPayeeAssignments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/people/teams/{teamID}/teamsPayeeAssignments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "id": 0,
    "teamId": 0,
    "payeeId": "string",
    "role": "string",
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "isFavorite": true
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/people/teams/{teamID}/teamsPayeeAssignments',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/people/teams/{teamID}/teamsPayeeAssignments', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/people/teams/{teamID}/teamsPayeeAssignments',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "teamId": 0,
    "payeeId": "string",
    "role": "string",
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "isFavorite": true
  }
]
[{"id":0,"teamId":0,"payeeId":"string","role":"string","startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","isFavorite":true}]

Get team payee assignments.

Parameters

Name

In

Type

Required

Description

teamID

path

integer(int32)

true

none

isFavoritesOnly

query

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Team payee assignments are returned.

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.People.TeamPayeeAssignmentDTO]

false

none

none

» id

integer(int32)¦null

false

none

none

» teamId

integer(int32)¦null

false

none

none

» payeeId

string¦null

false

none

none

» role

string¦null

false

none

none

» startDate

string(date-time)¦null

false

none

none

» endDate

string(date-time)¦null

false

none

none

» isFavorite

boolean

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/people/teams/{teamID}/teamsPayeeAssignments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/people/teams/{teamID}/teamsPayeeAssignments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/people/teams/{teamID}/teamsPayeeAssignments',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/people/teams/{teamID}/teamsPayeeAssignments', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/people/teams/{teamID}/teamsPayeeAssignments',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "teamId": 0,
    "payeeId": "string",
    "role": "string",
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "isFavorite": true
  }
]
[{"id":0,"teamId":0,"payeeId":"string","role":"string","startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","isFavorite":true}]

Delete team payee assignments.

Parameters

Name

In

Type

Required

Description

teamID

path

integer(int32)

true

none

payeeIDs

query

array[string]

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Team payee assignments are deleted.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/people/teams/{teamID}/teamsPayeeAssignments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/people/teams/{teamID}/teamsPayeeAssignments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/people/teams/{teamID}/teamsPayeeAssignments',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/people/teams/{teamID}/teamsPayeeAssignments')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/people/teams/{teamID}/teamsPayeeAssignments',
  params: {
  }

p JSON.parse(result)

Get team payee assignment.

Parameters

Name

In

Type

Required

Description

teamID

path

integer(int32)

true

none

payeeID

path

string

true

none

id

query

integer(int32)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Team payee assignment is returned.

Varicent.RESTAPI.v1.DTOs.People.TeamPayeeAssignmentDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/people/teams/teamsPayeeAssignment/{teamID}/{payeeID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/people/teams/teamsPayeeAssignment/{teamID}/{payeeID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/people/teams/teamsPayeeAssignment/{teamID}/{payeeID}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/people/teams/teamsPayeeAssignment/{teamID}/{payeeID}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/people/teams/teamsPayeeAssignment/{teamID}/{payeeID}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "teamId": 0,
  "payeeId": "string",
  "role": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "isFavorite": true
}
{"id":0,"teamId":0,"payeeId":"string","role":"string","startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","isFavorite":true}

Delete team payee assignment.

Parameters

Name

In

Type

Required

Description

teamID

path

integer(int32)

true

none

payeeID

path

string

true

none

id

query

integer(int32)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Team payee assignment is deleted.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/people/teams/teamsPayeeAssignment/{teamID}/{payeeID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/people/teams/teamsPayeeAssignment/{teamID}/{payeeID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/people/teams/teamsPayeeAssignment/{teamID}/{payeeID}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/people/teams/teamsPayeeAssignment/{teamID}/{payeeID}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/people/teams/teamsPayeeAssignment/{teamID}/{payeeID}',
  params: {
  }

p JSON.parse(result)

Get team payees.

Parameters

Name

In

Type

Required

Description

teamID

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Team payees are returned.

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.PayeeDetailsDTO]

false

none

none

» title

string¦null

false

none

none

» email

string¦null

false

none

none

» phone

string¦null

false

none

none

» reportsTo

string¦null

false

none

none

» name

string¦null

false

none

none

» id

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/people/teams/{teamID}/teamsPayee", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/people/teams/{teamID}/teamsPayee");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/people/teams/{teamID}/teamsPayee',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/people/teams/{teamID}/teamsPayee', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/people/teams/{teamID}/teamsPayee',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "title": "string",
    "email": "string",
    "phone": "string",
    "reportsTo": "string",
    "name": "string",
    "id": "string"
  }
]
[{"title":"string","email":"string","phone":"string","reportsTo":"string","name":"string","id":"string"}]

Get team payees with assignment details.

Parameters

Name

In

Type

Required

Description

teamID

path

integer(int32)

true

none

offset

query

integer(int32)

false

none

limit

query

integer(int32)

false

none

isFavoritesOnly

query

boolean

false

none

orderBy

query

string

false

none

filterBy

query

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Team payees with assignment details are returned.

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.People.TeamPayeeDetailsDTO]

false

none

none

» teamId

integer(int32)

false

none

none

» role

string¦null

false

none

none

» startDate

string(date-time)

false

none

none

» endDate

string(date-time)

false

none

none

» isFavorite

boolean

false

none

none

» payeeCurrency

string¦null

false

none

none

» dateOfHire

string(date-time)¦null

false

none

none

» terminationDate

string(date-time)¦null

false

none

none

» title

string¦null

false

none

none

» email

string¦null

false

none

none

» phone

string¦null

false

none

none

» reportsTo

string¦null

false

none

none

» name

string¦null

false

none

none

» id

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/people/teams/{teamID}/teamsPayeeWithAssignments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/people/teams/{teamID}/teamsPayeeWithAssignments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/people/teams/{teamID}/teamsPayeeWithAssignments',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/people/teams/{teamID}/teamsPayeeWithAssignments', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/people/teams/{teamID}/teamsPayeeWithAssignments',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "teamId": 0,
    "role": "string",
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "isFavorite": true,
    "payeeCurrency": "string",
    "dateOfHire": "2019-08-24T14:15:22Z",
    "terminationDate": "2019-08-24T14:15:22Z",
    "title": "string",
    "email": "string",
    "phone": "string",
    "reportsTo": "string",
    "name": "string",
    "id": "string"
  }
]
[{"teamId":0,"role":"string","startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","isFavorite":true,"payeeCurrency":"string","dateOfHire":"2019-08-24T14:15:22Z","terminationDate":"2019-08-24T14:15:22Z","title":"string","email":"string","phone":"string","reportsTo":"string","name":"string","id":"string"}]

Create team plan assignment.

Body parameter

{
  "teamId": 0,
  "planId": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z"
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.People.TeamPlanAssignmentDTO

false

none

» teamId

body

integer(int32)

false

none

» planId

body

integer(int32)

false

none

» startDate

body

string(date-time)

false

none

» endDate

body

string(date-time)¦null

false

none

Responses

Status

Meaning

Description

Schema

201

Created

Team plan assignment is created.

Varicent.RESTAPI.v1.DTOs.People.TeamPlanAssignmentDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/people/teams/teamsPlanAssignment", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/people/teams/teamsPlanAssignment");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "teamId": 0,
  "planId": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/people/teams/teamsPlanAssignment',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/people/teams/teamsPlanAssignment', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/people/teams/teamsPlanAssignment',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "teamId": 0,
  "planId": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z"
}
{"teamId":0,"planId":0,"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z"}

Update team plan assignment.

Body parameter

{
  "teamId": 0,
  "planId": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z"
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.People.TeamPlanAssignmentDTO

false

none

» teamId

body

integer(int32)

false

none

» planId

body

integer(int32)

false

none

» startDate

body

string(date-time)

false

none

» endDate

body

string(date-time)¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Team plan assignment is updated.

Varicent.RESTAPI.v1.DTOs.People.TeamPlanAssignmentDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/people/teams/teamsPlanAssignment", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/people/teams/teamsPlanAssignment");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "teamId": 0,
  "planId": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/people/teams/teamsPlanAssignment',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/people/teams/teamsPlanAssignment', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/people/teams/teamsPlanAssignment',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "teamId": 0,
  "planId": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z"
}
{"teamId":0,"planId":0,"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z"}

Delete team plan assignment.

Parameters

Name

In

Type

Required

Description

teamID

path

integer(int32)

true

none

planID

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Team plan assignment is deleted.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/people/teams/teamsPlanAssignment/{teamID}/{planID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/people/teams/teamsPlanAssignment/{teamID}/{planID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/people/teams/teamsPlanAssignment/{teamID}/{planID}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/people/teams/teamsPlanAssignment/{teamID}/{planID}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/people/teams/teamsPlanAssignment/{teamID}/{planID}',
  params: {
  }

p JSON.parse(result)

Insert payee

Body parameter

{
  "effectiveDatedInfo": {
    "id": "string",
    "payeeID": "string",
    "currencyID": "string",
    "titleID": "string",
    "statusID": "string",
    "countryID": "string",
    "salary": 0.1,
    "payeeTypeID": "string",
    "effectiveStart": "2019-08-24T14:15:22Z",
    "effectiveEnd": "2019-08-24T14:15:22Z"
  },
  "email": "string",
  "reportsTo": "string",
  "dateOfHire": "2019-08-24T14:15:22Z",
  "terminationDate": "2019-08-24T14:15:22Z",
  "name": "string",
  "id": "string"
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.PayeeDetailsEffectiveDatedDTO

false

none

» effectiveDatedInfo

body

Varicent.RESTAPI.v1.DTOs.PayeeEffectiveDatedInfoDTO

false

none

»» id

body

string¦null

false

none

»» payeeID

body

string¦null

false

none

»» currencyID

body

string¦null

false

none

»» titleID

body

string¦null

false

none

»» statusID

body

string¦null

false

none

»» countryID

body

string¦null

false

none

»» salary

body

number(double)

false

none

»» payeeTypeID

body

string¦null

false

none

»» effectiveStart

body

string(date-time)

false

none

»» effectiveEnd

body

string(date-time)¦null

false

none

» email

body

string¦null

false

none

» reportsTo

body

string¦null

false

none

» dateOfHire

body

string(date-time)¦null

false

none

» terminationDate

body

string(date-time)¦null

false

none

» name

body

string¦null

false

none

» id

body

string¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

A new payee with effective dated info is inserted

Varicent.RESTAPI.v1.DTOs.PayeeDetailsEffectiveDatedDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/people/teams/payeeEffective", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/people/teams/payeeEffective");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "effectiveDatedInfo": {
    "id": "string",
    "payeeID": "string",
    "currencyID": "string",
    "titleID": "string",
    "statusID": "string",
    "countryID": "string",
    "salary": 0.1,
    "payeeTypeID": "string",
    "effectiveStart": "2019-08-24T14:15:22Z",
    "effectiveEnd": "2019-08-24T14:15:22Z"
  },
  "email": "string",
  "reportsTo": "string",
  "dateOfHire": "2019-08-24T14:15:22Z",
  "terminationDate": "2019-08-24T14:15:22Z",
  "name": "string",
  "id": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/people/teams/payeeEffective',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/people/teams/payeeEffective', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/people/teams/payeeEffective',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "effectiveDatedInfo": {
    "id": "string",
    "payeeID": "string",
    "currencyID": "string",
    "titleID": "string",
    "statusID": "string",
    "countryID": "string",
    "salary": 0.1,
    "payeeTypeID": "string",
    "effectiveStart": "2019-08-24T14:15:22Z",
    "effectiveEnd": "2019-08-24T14:15:22Z"
  },
  "email": "string",
  "reportsTo": "string",
  "dateOfHire": "2019-08-24T14:15:22Z",
  "terminationDate": "2019-08-24T14:15:22Z",
  "name": "string",
  "id": "string"
}
{"effectiveDatedInfo":{"id":"string","payeeID":"string","currencyID":"string","titleID":"string","statusID":"string","countryID":"string","salary":0.1,"payeeTypeID":"string","effectiveStart":"2019-08-24T14:15:22Z","effectiveEnd":"2019-08-24T14:15:22Z"},"email":"string","reportsTo":"string","dateOfHire":"2019-08-24T14:15:22Z","terminationDate":"2019-08-24T14:15:22Z","name":"string","id":"string"}

Get payee with current effective dated info

Parameters

Name

In

Type

Required

Description

payeeID

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get a payee with current effective dated info

Varicent.RESTAPI.v1.DTOs.PayeeDetailsEffectiveDatedDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/people/teams/payeeEffective/{payeeID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/people/teams/payeeEffective/{payeeID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/people/teams/payeeEffective/{payeeID}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/people/teams/payeeEffective/{payeeID}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/people/teams/payeeEffective/{payeeID}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "effectiveDatedInfo": {
    "id": "string",
    "payeeID": "string",
    "currencyID": "string",
    "titleID": "string",
    "statusID": "string",
    "countryID": "string",
    "salary": 0.1,
    "payeeTypeID": "string",
    "effectiveStart": "2019-08-24T14:15:22Z",
    "effectiveEnd": "2019-08-24T14:15:22Z"
  },
  "email": "string",
  "reportsTo": "string",
  "dateOfHire": "2019-08-24T14:15:22Z",
  "terminationDate": "2019-08-24T14:15:22Z",
  "name": "string",
  "id": "string"
}
{"effectiveDatedInfo":{"id":"string","payeeID":"string","currencyID":"string","titleID":"string","statusID":"string","countryID":"string","salary":0.1,"payeeTypeID":"string","effectiveStart":"2019-08-24T14:15:22Z","effectiveEnd":"2019-08-24T14:15:22Z"},"email":"string","reportsTo":"string","dateOfHire":"2019-08-24T14:15:22Z","terminationDate":"2019-08-24T14:15:22Z","name":"string","id":"string"}

Get team payees with assignment details and effective dated info.

Parameters

Name

In

Type

Required

Description

teamID

path

integer(int32)

true

none

offset

query

integer(int32)

false

none

limit

query

integer(int32)

false

none

isFavoritesOnly

query

boolean

false

none

orderBy

query

string

false

none

filterBy

query

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Team payees with assignment details and effective dated are returned.

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.People.TeamPayeeDetailsEffectiveDatedDTO]

false

none

none

» teamPayeeAssignment

Varicent.RESTAPI.v1.DTOs.People.TeamPayeeAssignmentDTO

false

none

none

»» id

integer(int32)¦null

false

none

none

»» teamId

integer(int32)¦null

false

none

none

»» payeeId

string¦null

false

none

none

»» role

string¦null

false

none

none

»» startDate

string(date-time)¦null

false

none

none

»» endDate

string(date-time)¦null

false

none

none

»» isFavorite

boolean

false

none

none

» effectiveDatedInfo

Varicent.RESTAPI.v1.DTOs.PayeeEffectiveDatedInfoDTO

false

none

none

»» id

string¦null

false

none

none

»» payeeID

string¦null

false

none

none

»» currencyID

string¦null

false

none

none

»» titleID

string¦null

false

none

none

»» statusID

string¦null

false

none

none

»» countryID

string¦null

false

none

none

»» salary

number(double)

false

none

none

»» payeeTypeID

string¦null

false

none

none

»» effectiveStart

string(date-time)

false

none

none

»» effectiveEnd

string(date-time)¦null

false

none

none

» email

string¦null

false

none

none

» reportsTo

string¦null

false

none

none

» dateOfHire

string(date-time)¦null

false

none

none

» terminationDate

string(date-time)¦null

false

none

none

» name

string¦null

false

none

none

» id

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/people/teams/{teamID}/teamsPayeeEffectiveDatedWithAssignments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/people/teams/{teamID}/teamsPayeeEffectiveDatedWithAssignments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/people/teams/{teamID}/teamsPayeeEffectiveDatedWithAssignments',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/people/teams/{teamID}/teamsPayeeEffectiveDatedWithAssignments', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/people/teams/{teamID}/teamsPayeeEffectiveDatedWithAssignments',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "teamPayeeAssignment": {
      "id": 0,
      "teamId": 0,
      "payeeId": "string",
      "role": "string",
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "isFavorite": true
    },
    "effectiveDatedInfo": {
      "id": "string",
      "payeeID": "string",
      "currencyID": "string",
      "titleID": "string",
      "statusID": "string",
      "countryID": "string",
      "salary": 0.1,
      "payeeTypeID": "string",
      "effectiveStart": "2019-08-24T14:15:22Z",
      "effectiveEnd": "2019-08-24T14:15:22Z"
    },
    "email": "string",
    "reportsTo": "string",
    "dateOfHire": "2019-08-24T14:15:22Z",
    "terminationDate": "2019-08-24T14:15:22Z",
    "name": "string",
    "id": "string"
  }
]
[{"teamPayeeAssignment":{"id":0,"teamId":0,"payeeId":"string","role":"string","startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","isFavorite":true},"effectiveDatedInfo":{"id":"string","payeeID":"string","currencyID":"string","titleID":"string","statusID":"string","countryID":"string","salary":0.1,"payeeTypeID":"string","effectiveStart":"2019-08-24T14:15:22Z","effectiveEnd":"2019-08-24T14:15:22Z"},"email":"string","reportsTo":"string","dateOfHire":"2019-08-24T14:15:22Z","terminationDate":"2019-08-24T14:15:22Z","name":"string","id":"string"}]

Get unassigned team payees with effective dated information.

Parameters

Name

In

Type

Required

Description

offset

query

integer(int32)

false

none

limit

query

integer(int32)

false

none

orderBy

query

string

false

none

filterBy

query

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Unassigned team payees with effective dated information are returned.

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.PayeeDetailsEffectiveDatedDTO]

false

none

none

» effectiveDatedInfo

Varicent.RESTAPI.v1.DTOs.PayeeEffectiveDatedInfoDTO

false

none

none

»» id

string¦null

false

none

none

»» payeeID

string¦null

false

none

none

»» currencyID

string¦null

false

none

none

»» titleID

string¦null

false

none

none

»» statusID

string¦null

false

none

none

»» countryID

string¦null

false

none

none

»» salary

number(double)

false

none

none

»» payeeTypeID

string¦null

false

none

none

»» effectiveStart

string(date-time)

false

none

none

»» effectiveEnd

string(date-time)¦null

false

none

none

» email

string¦null

false

none

none

» reportsTo

string¦null

false

none

none

» dateOfHire

string(date-time)¦null

false

none

none

» terminationDate

string(date-time)¦null

false

none

none

» name

string¦null

false

none

none

» id

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/people/teams/unassignedTeamsPayeeEffectiveDated", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/people/teams/unassignedTeamsPayeeEffectiveDated");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/people/teams/unassignedTeamsPayeeEffectiveDated',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/people/teams/unassignedTeamsPayeeEffectiveDated', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/people/teams/unassignedTeamsPayeeEffectiveDated',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "effectiveDatedInfo": {
      "id": "string",
      "payeeID": "string",
      "currencyID": "string",
      "titleID": "string",
      "statusID": "string",
      "countryID": "string",
      "salary": 0.1,
      "payeeTypeID": "string",
      "effectiveStart": "2019-08-24T14:15:22Z",
      "effectiveEnd": "2019-08-24T14:15:22Z"
    },
    "email": "string",
    "reportsTo": "string",
    "dateOfHire": "2019-08-24T14:15:22Z",
    "terminationDate": "2019-08-24T14:15:22Z",
    "name": "string",
    "id": "string"
  }
]
[{"effectiveDatedInfo":{"id":"string","payeeID":"string","currencyID":"string","titleID":"string","statusID":"string","countryID":"string","salary":0.1,"payeeTypeID":"string","effectiveStart":"2019-08-24T14:15:22Z","effectiveEnd":"2019-08-24T14:15:22Z"},"email":"string","reportsTo":"string","dateOfHire":"2019-08-24T14:15:22Z","terminationDate":"2019-08-24T14:15:22Z","name":"string","id":"string"}]

Get all payees with effective dated info

Parameters

Name

In

Type

Required

Description

offset

query

integer(int32)

false

none

limit

query

integer(int32)

false

none

orderBy

query

string

false

none

filterBy

query

string

false

none

getAll

query

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

All payees with effective dated info are returned

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.PayeeDetailsEffectiveDatedDTO]

false

none

none

» effectiveDatedInfo

Varicent.RESTAPI.v1.DTOs.PayeeEffectiveDatedInfoDTO

false

none

none

»» id

string¦null

false

none

none

»» payeeID

string¦null

false

none

none

»» currencyID

string¦null

false

none

none

»» titleID

string¦null

false

none

none

»» statusID

string¦null

false

none

none

»» countryID

string¦null

false

none

none

»» salary

number(double)

false

none

none

»» payeeTypeID

string¦null

false

none

none

»» effectiveStart

string(date-time)

false

none

none

»» effectiveEnd

string(date-time)¦null

false

none

none

» email

string¦null

false

none

none

» reportsTo

string¦null

false

none

none

» dateOfHire

string(date-time)¦null

false

none

none

» terminationDate

string(date-time)¦null

false

none

none

» name

string¦null

false

none

none

» id

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/people/teams/allPayeesEffective", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/people/teams/allPayeesEffective");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/people/teams/allPayeesEffective',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/people/teams/allPayeesEffective', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/people/teams/allPayeesEffective',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "effectiveDatedInfo": {
      "id": "string",
      "payeeID": "string",
      "currencyID": "string",
      "titleID": "string",
      "statusID": "string",
      "countryID": "string",
      "salary": 0.1,
      "payeeTypeID": "string",
      "effectiveStart": "2019-08-24T14:15:22Z",
      "effectiveEnd": "2019-08-24T14:15:22Z"
    },
    "email": "string",
    "reportsTo": "string",
    "dateOfHire": "2019-08-24T14:15:22Z",
    "terminationDate": "2019-08-24T14:15:22Z",
    "name": "string",
    "id": "string"
  }
]
[{"effectiveDatedInfo":{"id":"string","payeeID":"string","currencyID":"string","titleID":"string","statusID":"string","countryID":"string","salary":0.1,"payeeTypeID":"string","effectiveStart":"2019-08-24T14:15:22Z","effectiveEnd":"2019-08-24T14:15:22Z"},"email":"string","reportsTo":"string","dateOfHire":"2019-08-24T14:15:22Z","terminationDate":"2019-08-24T14:15:22Z","name":"string","id":"string"}]

Update payee

Body parameter

{
  "email": "string",
  "reportsTo": "string",
  "dateOfHire": "2019-08-24T14:15:22Z",
  "terminationDate": "2019-08-24T14:15:22Z",
  "name": "string",
  "id": "string"
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.PayeePersonalDetailsDTO

false

none

» email

body

string¦null

false

none

» reportsTo

body

string¦null

false

none

» dateOfHire

body

string(date-time)¦null

false

none

» terminationDate

body

string(date-time)¦null

false

none

» name

body

string¦null

false

none

» id

body

string¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

A payee is updated

Varicent.RESTAPI.v1.DTOs.PayeePersonalDetailsDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/people/teams/payee", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/people/teams/payee");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "email": "string",
  "reportsTo": "string",
  "dateOfHire": "2019-08-24T14:15:22Z",
  "terminationDate": "2019-08-24T14:15:22Z",
  "name": "string",
  "id": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/people/teams/payee',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/people/teams/payee', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/people/teams/payee',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "email": "string",
  "reportsTo": "string",
  "dateOfHire": "2019-08-24T14:15:22Z",
  "terminationDate": "2019-08-24T14:15:22Z",
  "name": "string",
  "id": "string"
}
{"email":"string","reportsTo":"string","dateOfHire":"2019-08-24T14:15:22Z","terminationDate":"2019-08-24T14:15:22Z","name":"string","id":"string"}

Delete payee

Parameters

Name

In

Type

Required

Description

payeeID

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

A payee is deleted

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/people/teams/payee/{payeeID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/people/teams/payee/{payeeID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/people/teams/payee/{payeeID}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/people/teams/payee/{payeeID}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/people/teams/payee/{payeeID}',
  params: {
  }

p JSON.parse(result)

Insert payee effective dated info

Body parameter

{
  "id": "string",
  "payeeID": "string",
  "currencyID": "string",
  "titleID": "string",
  "statusID": "string",
  "countryID": "string",
  "salary": 0.1,
  "payeeTypeID": "string",
  "effectiveStart": "2019-08-24T14:15:22Z",
  "effectiveEnd": "2019-08-24T14:15:22Z"
}

Parameters

Name

In

Type

Required

Description

payeeId

path

string

true

none

autoAdjust

query

boolean

false

none

body

body

Varicent.RESTAPI.v1.DTOs.PayeeEffectiveDatedInfoDTO

false

none

» id

body

string¦null

false

none

» payeeID

body

string¦null

false

none

» currencyID

body

string¦null

false

none

» titleID

body

string¦null

false

none

» statusID

body

string¦null

false

none

» countryID

body

string¦null

false

none

» salary

body

number(double)

false

none

» payeeTypeID

body

string¦null

false

none

» effectiveStart

body

string(date-time)

false

none

» effectiveEnd

body

string(date-time)¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

A payee effective dated info is inserted/updated. Adjust effective ranges around. Update info list is returned

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.PayeeEffectiveDatedInfoDTO]

false

none

none

» id

string¦null

false

none

none

» payeeID

string¦null

false

none

none

» currencyID

string¦null

false

none

none

» titleID

string¦null

false

none

none

» statusID

string¦null

false

none

none

» countryID

string¦null

false

none

none

» salary

number(double)

false

none

none

» payeeTypeID

string¦null

false

none

none

» effectiveStart

string(date-time)

false

none

none

» effectiveEnd

string(date-time)¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/people/teams/payee/{payeeID}/effective", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/people/teams/payee/{payeeID}/effective");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": "string",
  "payeeID": "string",
  "currencyID": "string",
  "titleID": "string",
  "statusID": "string",
  "countryID": "string",
  "salary": 0.1,
  "payeeTypeID": "string",
  "effectiveStart": "2019-08-24T14:15:22Z",
  "effectiveEnd": "2019-08-24T14:15:22Z"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/people/teams/payee/{payeeID}/effective',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/people/teams/payee/{payeeID}/effective', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/people/teams/payee/{payeeID}/effective',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": "string",
    "payeeID": "string",
    "currencyID": "string",
    "titleID": "string",
    "statusID": "string",
    "countryID": "string",
    "salary": 0.1,
    "payeeTypeID": "string",
    "effectiveStart": "2019-08-24T14:15:22Z",
    "effectiveEnd": "2019-08-24T14:15:22Z"
  }
]
[{"id":"string","payeeID":"string","currencyID":"string","titleID":"string","statusID":"string","countryID":"string","salary":0.1,"payeeTypeID":"string","effectiveStart":"2019-08-24T14:15:22Z","effectiveEnd":"2019-08-24T14:15:22Z"}]

Get the list of effective dated info for the payee

Parameters

Name

In

Type

Required

Description

payeeID

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

A list of payee effective dated info matching the payeeID is returned

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.PayeeEffectiveDatedInfoDTO]

false

none

none

» id

string¦null

false

none

none

» payeeID

string¦null

false

none

none

» currencyID

string¦null

false

none

none

» titleID

string¦null

false

none

none

» statusID

string¦null

false

none

none

» countryID

string¦null

false

none

none

» salary

number(double)

false

none

none

» payeeTypeID

string¦null

false

none

none

» effectiveStart

string(date-time)

false

none

none

» effectiveEnd

string(date-time)¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/people/teams/payee/{payeeID}/effective", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/people/teams/payee/{payeeID}/effective");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/people/teams/payee/{payeeID}/effective',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/people/teams/payee/{payeeID}/effective', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/people/teams/payee/{payeeID}/effective',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": "string",
    "payeeID": "string",
    "currencyID": "string",
    "titleID": "string",
    "statusID": "string",
    "countryID": "string",
    "salary": 0.1,
    "payeeTypeID": "string",
    "effectiveStart": "2019-08-24T14:15:22Z",
    "effectiveEnd": "2019-08-24T14:15:22Z"
  }
]
[{"id":"string","payeeID":"string","currencyID":"string","titleID":"string","statusID":"string","countryID":"string","salary":0.1,"payeeTypeID":"string","effectiveStart":"2019-08-24T14:15:22Z","effectiveEnd":"2019-08-24T14:15:22Z"}]

Delete payee effective dated info

Parameters

Name

In

Type

Required

Description

payeeID

path

string

true

none

effStart

path

string(date-time)

true

none

adjustPrevious

query

boolean

false

none

adjustAfter

query

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

A payee effective dated info is deleted. Update info list is returned

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.PayeeEffectiveDatedInfoDTO]

false

none

none

» id

string¦null

false

none

none

» payeeID

string¦null

false

none

none

» currencyID

string¦null

false

none

none

» titleID

string¦null

false

none

none

» statusID

string¦null

false

none

none

» countryID

string¦null

false

none

none

» salary

number(double)

false

none

none

» payeeTypeID

string¦null

false

none

none

» effectiveStart

string(date-time)

false

none

none

» effectiveEnd

string(date-time)¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/people/teams/payee/{payeeID}/effective/{effStart}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/people/teams/payee/{payeeID}/effective/{effStart}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/people/teams/payee/{payeeID}/effective/{effStart}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('http://localhost:8080/api/v1/people/teams/payee/{payeeID}/effective/{effStart}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.delete 'http://localhost:8080/api/v1/people/teams/payee/{payeeID}/effective/{effStart}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": "string",
    "payeeID": "string",
    "currencyID": "string",
    "titleID": "string",
    "statusID": "string",
    "countryID": "string",
    "salary": 0.1,
    "payeeTypeID": "string",
    "effectiveStart": "2019-08-24T14:15:22Z",
    "effectiveEnd": "2019-08-24T14:15:22Z"
  }
]
[{"id":"string","payeeID":"string","currencyID":"string","titleID":"string","statusID":"string","countryID":"string","salary":0.1,"payeeTypeID":"string","effectiveStart":"2019-08-24T14:15:22Z","effectiveEnd":"2019-08-24T14:15:22Z"}]

Get a single effective dated info for the payee

Parameters

Name

In

Type

Required

Description

payeeID

path

string

true

none

effStart

path

string(date-time)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

A payee effective dated info matching the ID is returned

Varicent.RESTAPI.v1.DTOs.PayeeEffectiveDatedInfoDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/people/teams/payee/{payeeID}/effective/{effStart}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/people/teams/payee/{payeeID}/effective/{effStart}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/people/teams/payee/{payeeID}/effective/{effStart}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/people/teams/payee/{payeeID}/effective/{effStart}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/people/teams/payee/{payeeID}/effective/{effStart}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": "string",
  "payeeID": "string",
  "currencyID": "string",
  "titleID": "string",
  "statusID": "string",
  "countryID": "string",
  "salary": 0.1,
  "payeeTypeID": "string",
  "effectiveStart": "2019-08-24T14:15:22Z",
  "effectiveEnd": "2019-08-24T14:15:22Z"
}
{"id":"string","payeeID":"string","currencyID":"string","titleID":"string","statusID":"string","countryID":"string","salary":0.1,"payeeTypeID":"string","effectiveStart":"2019-08-24T14:15:22Z","effectiveEnd":"2019-08-24T14:15:22Z"}

Get the key and description for some payee fields, e.g. title, currency, country, status

Parameters

Name

In

Type

Required

Description

tableName

path

string

true

none

filter

query

string

false

none

limit

query

integer(int32)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

ID and description for different fields of payee are returned

RESTAPI.v1.DTOs.People.PayeeLookupFieldsDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/people/teams/payeeLookupFields/{tableName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/people/teams/payeeLookupFields/{tableName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/people/teams/payeeLookupFields/{tableName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/people/teams/payeeLookupFields/{tableName}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/people/teams/payeeLookupFields/{tableName}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "data": {
    "property1": "string",
    "property2": "string"
  }
}
{"data":{"property1":"string","property2":"string"}}

Get the import information of payee table, including number of records and number of saved import

Responses

Status

Meaning

Description

Schema

200

OK

Number of records and number of saved imports are returned

RESTAPI.v1.DTOs.People.ImportInfoDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/people/importInfo/payee", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/people/importInfo/payee");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/people/importInfo/payee',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/people/importInfo/payee', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/people/importInfo/payee',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "tableName": "string",
  "recordCount": 0,
  "importCount": 0
}
{"tableName":"string","recordCount":0,"importCount":0}

Get the import information of payee effective dated table, including number of records and number of saved import

Responses

Status

Meaning

Description

Schema

200

OK

Number of records and number of saved imports are returned

RESTAPI.v1.DTOs.People.ImportInfoDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/people/importInfo/payeeEffectiveDatedInfo", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/people/importInfo/payeeEffectiveDatedInfo");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/people/importInfo/payeeEffectiveDatedInfo',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/people/importInfo/payeeEffectiveDatedInfo', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/people/importInfo/payeeEffectiveDatedInfo',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "tableName": "string",
  "recordCount": 0,
  "importCount": 0
}
{"tableName":"string","recordCount":0,"importCount":0}

Create plan.

Body parameter

{
  "id": 0,
  "name": "string",
  "isFavorite": true,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "description": "string"
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Plans.PlanDTO

false

none

» id

body

integer(int32)¦null

false

none

» name

body

string¦null

false

none

» isFavorite

body

boolean

false

none

» startDate

body

string(date-time)

false

none

» endDate

body

string(date-time)

false

none

» description

body

string¦null

false

none

Responses

Status

Meaning

Description

Schema

201

Created

Plan is created.

Varicent.RESTAPI.v1.DTOs.Plans.PlanDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/plans", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "name": "string",
  "isFavorite": true,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "description": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/plans', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/plans',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "isFavorite": true,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "description": "string"
}
{"id":0,"name":"string","isFavorite":true,"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","description":"string"}

Get plans.

Parameters

Name

In

Type

Required

Description

isFavoritesOnly

query

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Plans are returned.

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Plans.PlanDTO]

false

none

none

» id

integer(int32)¦null

false

none

none

» name

string¦null

false

none

none

» isFavorite

boolean

false

none

none

» startDate

string(date-time)

false

none

none

» endDate

string(date-time)

false

none

none

» description

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/plans", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/plans', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/plans',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "name": "string",
    "isFavorite": true,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "description": "string"
  }
]
[{"id":0,"name":"string","isFavorite":true,"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","description":"string"}]

Update plan.

Body parameter

{
  "id": 0,
  "name": "string",
  "isFavorite": true,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "description": "string"
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Plans.PlanDTO

false

none

» id

body

integer(int32)¦null

false

none

» name

body

string¦null

false

none

» isFavorite

body

boolean

false

none

» startDate

body

string(date-time)

false

none

» endDate

body

string(date-time)

false

none

» description

body

string¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Plan is updated.

Varicent.RESTAPI.v1.DTOs.Plans.PlanDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/plans", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "name": "string",
  "isFavorite": true,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "description": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/plans', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/plans',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "isFavorite": true,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "description": "string"
}
{"id":0,"name":"string","isFavorite":true,"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","description":"string"}

Get plan.

Parameters

Name

In

Type

Required

Description

planID

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Plan is returned.

Varicent.RESTAPI.v1.DTOs.Plans.PlanDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/plans/{planID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/{planID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans/{planID}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/plans/{planID}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/plans/{planID}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "isFavorite": true,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "description": "string"
}
{"id":0,"name":"string","isFavorite":true,"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","description":"string"}

Delete plan.

Parameters

Name

In

Type

Required

Description

planID

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Plan is deleted.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/plans/{planID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/{planID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/plans/{planID}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/plans/{planID}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/plans/{planID}',
  params: {
  }

p JSON.parse(result)

Create plan component.

Body parameter

{
  "id": 0,
  "planId": 0,
  "name": "string",
  "description": "string",
  "type": "string",
  "json": "string",
  "weight": 0.1,
  "planDataDTO": {
    "id": 0,
    "source": "string",
    "owner": "string",
    "additionalCriteria": "string",
    "earnedDate": "string",
    "trackSplits": true,
    "isUsingCustomFormula": true,
    "customFormula": {
      "id": 0,
      "name": "string",
      "type": "Compensation",
      "planComponentType": "string",
      "calculations": []
    },
    "payeeFilter": true
  },
  "planQuotaDTO": {
    "id": 0,
    "earningMeasure": "string",
    "earningType": "string",
    "rateType": "string",
    "hasRateCard": true,
    "isUsingCustomFormula": true,
    "customFormula": {
      "id": 0,
      "name": "string",
      "type": "Compensation",
      "planComponentType": "string",
      "calculations": []
    },
    "defaultCurrency": "string",
    "defaultQuota": 0.1
  },
  "planAcceleratorDTOs": [
    {
      "id": 0,
      "minQuota": 0.1,
      "maxQuota": 0.1,
      "baseAccelerator": 0.1,
      "accelerationMethod": "string",
      "displayTierId": 0
    }
  ],
  "planPaymentDTOs": [
    {
      "id": 0,
      "percentage": 0.1,
      "payPeriodMethod": "string",
      "releaseMethod": "string",
      "dataSourceId": "string",
      "dataField": "string",
      "dateField": "string",
      "isLessThanOrEqualTo": "string",
      "numerator": "string",
      "denominator": "string",
      "startDate": "string",
      "endDate": "string",
      "frequency": "string",
      "qualifierType": "string",
      "releaseType": "string",
      "conditionValue": "string",
      "comparisonOperand": "string",
      "releaseTerm": "string",
      "planComponentID": 0
    }
  ],
  "planPayoutDTO": {
    "id": 0,
    "earningDriver": "string",
    "frequency": "string",
    "defaultPayoutRate": 0.1,
    "useDefaults": "string",
    "lookupTable": "string",
    "lookupColumn": "string",
    "useLookup": "string",
    "isUsingCustomFormula": true,
    "customFormula": {
      "id": 0,
      "name": "string",
      "type": "Compensation",
      "planComponentType": "string",
      "calculations": []
    },
    "defaultPayoutRateMode": "None"
  },
  "planQuotaAmountDTO": {
    "id": 0,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "frequency": "string"
  },
  "planPayeeEffectiveRangeDTO": [
    {
      "id": 0,
      "quotaCurrency": "string",
      "basePayoutRate": 0.1,
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "payeeId": "string",
      "quotaValue": 0.1
    }
  ],
  "rateCardConditionDTOs": [
    {
      "id": 0,
      "index": 0,
      "name": "string",
      "multiplier": 0.1,
      "rateCardOperators": []
    }
  ],
  "planComponentCreditCriteriaDTO": {
    "id": 0,
    "planComponentId": 0,
    "sourceFilterDTO": {
      "constraint": {},
      "and": {},
      "or": {},
      "not": {},
      "metadata": {}
    }
  },
  "basePayoutRateType": "string"
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentDTO

false

none

» id

body

integer(int32)¦null

false

none

» planId

body

integer(int32)

false

none

» name

body

string¦null

false

none

» description

body

string¦null

false

none

» type

body

string¦null

false

none

» json

body

string¦null

false

none

» weight

body

number(double)¦null

false

none

» planDataDTO

body

Varicent.RESTAPI.v1.DTOs.Plans.PlanDataDTO

false

none

»» id

body

integer(int32)¦null

false

none

»» source

body

string¦null

false

none

»» owner

body

string¦null

false

none

»» additionalCriteria

body

string¦null

false

none

»» earnedDate

body

string¦null

false

none

»» trackSplits

body

boolean

false

none

»» isUsingCustomFormula

body

boolean

false

none

»» customFormula

body

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentCustomFormulaDTO

false

none

»»» id

body

integer(int32)¦null

false

none

»»» name

body

string¦null

false

none

»»» type

body

string

false

none

»»» planComponentType

body

string¦null

false

none

»»» calculations

body

[Varicent.RESTAPI.v1.DTOs.NavigationCalculationElementDTO]¦null

false

none

»»»» parentBlockId

body

integer(int32)

false

none

»»»» elementId

body

integer(int32)

false

none

»»»» calculationId

body

integer(int32)

false

none

»»»» calculationType

body

string¦null

false

none

»»»» name

body

string¦null

false

none

»»»» comment

body

string¦null

false

none

»»»» isFavourite

body

boolean

false

none

»»»» sourceTables

body

[string]¦null

false

none

»» payeeFilter

body

boolean

false

none

» planQuotaDTO

body

Varicent.RESTAPI.v1.DTOs.Plans.PlanQuotaDTO

false

none

»» id

body

integer(int32)¦null

false

none

»» earningMeasure

body

string¦null

false

none

»» earningType

body

string¦null

false

none

»» rateType

body

string¦null

false

none

»» hasRateCard

body

boolean

false

none

»» isUsingCustomFormula

body

boolean

false

none

»» customFormula

body

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentCustomFormulaDTO

false

none

»» defaultCurrency

body

string¦null

false

none

»» defaultQuota

body

number(double)

false

none

» planAcceleratorDTOs

body

[Varicent.RESTAPI.v1.DTOs.Plans.PlanAcceleratorDTO]¦null

false

none

»» id

body

integer(int32)¦null

false

none

»» minQuota

body

number(double)

false

none

»» maxQuota

body

number(double)

false

none

»» baseAccelerator

body

number(double)

false

none

»» accelerationMethod

body

string¦null

false

none

»» displayTierId

body

integer(int32)

false

none

» planPaymentDTOs

body

[Varicent.RESTAPI.v1.DTOs.Plans.PlanPaymentDTO]¦null

false

none

»» id

body

integer(int32)¦null

false

none

»» percentage

body

number(double)

false

none

»» payPeriodMethod

body

string¦null

false

none

»» releaseMethod

body

string¦null

false

none

»» dataSourceId

body

string¦null

false

none

»» dataField

body

string¦null

false

none

»» dateField

body

string¦null

false

none

»» isLessThanOrEqualTo

body

string¦null

false

none

»» numerator

body

string¦null

false

none

»» denominator

body

string¦null

false

none

»» startDate

body

string¦null

false

none

»» endDate

body

string¦null

false

none

»» frequency

body

string¦null

false

none

»» qualifierType

body

string¦null

false

none

»» releaseType

body

string¦null

false

none

»» conditionValue

body

string¦null

false

none

»» comparisonOperand

body

string¦null

false

none

»» releaseTerm

body

string¦null

false

none

»» planComponentID

body

integer(int32)

false

none

» planPayoutDTO

body

Varicent.RESTAPI.v1.DTOs.Plans.PlanPayoutDTO

false

none

»» id

body

integer(int32)¦null

false

none

»» earningDriver

body

string¦null

false

none

»» frequency

body

string¦null

false

none

»» defaultPayoutRate

body

number(double)

false

none

»» useDefaults

body

string¦null

false

none

»» lookupTable

body

string¦null

false

none

»» lookupColumn

body

string¦null

false

none

»» useLookup

body

string¦null

false

none

»» isUsingCustomFormula

body

boolean

false

none

»» customFormula

body

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentCustomFormulaDTO

false

none

»» defaultPayoutRateMode

body

string

false

none

» planQuotaAmountDTO

body

Varicent.RESTAPI.v1.DTOs.Plans.PlanQuotaAmountDTO

false

none

»» id

body

integer(int32)¦null

false

none

»» startDate

body

string(date-time)

false

none

»» endDate

body

string(date-time)

false

none

»» frequency

body

string¦null

false

none

» planPayeeEffectiveRangeDTO

body

[Varicent.RESTAPI.v1.DTOs.Plans.PlanPayeeEffectiveRangeDTO]¦null

false

none

»» id

body

integer(int32)¦null

false

none

»» quotaCurrency

body

string¦null

false

none

»» basePayoutRate

body

number(double)

false

none

»» startDate

body

string(date-time)

false

none

»» endDate

body

string(date-time)

false

none

»» payeeId

body

string¦null

false

none

»» quotaValue

body

number(double)

false

none

» rateCardConditionDTOs

body

[RESTAPI.v1.DTOs.Plans.RateCard.RateCardConditionDTO]¦null

false

none

»» id

body

integer(int32)

false

none

»» index

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» multiplier

body

number(double)

false

none

»» rateCardOperators

body

[RESTAPI.v1.DTOs.Plans.RateCard.RateCardOperatorDTO]¦null

false

none

»»» id

body

integer(int32)

false

none

»»» field

body

string¦null

false

none

»»» index

body

integer(int32)

false

none

»»» operatorValuePairs

body

[RESTAPI.v1.DTOs.Plans.RateCard.RateCardOperatorValueDTO]¦null

false

none

»»»» name

body

string¦null

false

none

»»»» value

body

string¦null

false

none

»»»» index

body

integer(int32)

false

none

»»»» rateCardOperatorId

body

integer(int32)

false

none

»»»» type

body

string

false

none

»»» rateCardConditionId

body

integer(int32)

false

none

» planComponentCreditCriteriaDTO

body

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentCreditCriteriaDTO

false

none

»» id

body

integer(int32)¦null

false

none

»» planComponentId

body

integer(int32)¦null

false

none

»» sourceFilterDTO

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterDTO

false

none

»»» constraint

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterConstraintDTO

false

none

»»»» columnName

body

string¦null

false

none

»»»» operator

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterOperatorDTO

false

none

»»»»» type

body

string

false

none

»»»» value

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterValueDTO

false

none

»»»»» text

body

string¦null

false

none

»»»»» numeric

body

number(double)¦null

false

none

»»»»» date

body

string(date-time)¦null

false

none

»»»»» special

body

string¦null

false

none

»»»»» valueId

body

integer(int32)¦null

false

none

»»»»» rangeValue

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexRangeValueDTO

false

none

»»»»»» min

body

any

false

none

»»»»»» max

body

any

false

none

»»»» caseSensitive

body

boolean¦null

false

none

»»» and

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterAndDTO

false

none

»»»» filters

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»» or

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterOrDTO

false

none

»»»» filters

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»» not

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterNotDTO

false

none

»»»» filter

body

any

false

none

»»» metadata

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterMetaDataDTO

false

none

»»»» additionalProperties

body

any

false

none

» basePayoutRateType

body

string¦null

false

none

Enumerated Values

Parameter

Value

»»» type

Compensation

»»» type

Credit

»»» type

Quota

»» defaultPayoutRateMode

None

»» defaultPayoutRateMode

Default

»» defaultPayoutRateMode

Lookup

»» defaultPayoutRateMode

AutoCalculate

»»»» type

Text

»»»» type

Numeric

»»»» type

Date

»»»»» type

Equals

»»»»» type

NotEquals

»»»»» type

LessThan

»»»»» type

LessThanEquals

»»»»» type

GreaterThan

»»»»» type

GreaterThanEquals

»»»»» type

IsNull

»»»»» type

IsNotNull

»»»»» type

Contains

»»»»» type

NotContains

»»»»» type

StartWith

»»»»» type

EndWith

»»»»» type

InRange

»»»»» type

InArray

»»»»» type

NotInArray

»»»»» special

CurrentWebUser

»»»»» special

CurrentDate

»»»»» special

CurrentRowValue

»»»»» special

WorkflowFormID

Responses

Status

Meaning

Description

Schema

201

Created

Plan component is created.

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/plans/planComponents", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/planComponents");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "planId": 0,
  "name": "string",
  "description": "string",
  "type": "string",
  "json": "string",
  "weight": 0.1,
  "planDataDTO": {
    "id": 0,
    "source": "string",
    "owner": "string",
    "additionalCriteria": "string",
    "earnedDate": "string",
    "trackSplits": true,
    "isUsingCustomFormula": true,
    "customFormula": {
      "id": 0,
      "name": "string",
      "type": "Compensation",
      "planComponentType": "string",
      "calculations": []
    },
    "payeeFilter": true
  },
  "planQuotaDTO": {
    "id": 0,
    "earningMeasure": "string",
    "earningType": "string",
    "rateType": "string",
    "hasRateCard": true,
    "isUsingCustomFormula": true,
    "customFormula": {
      "id": 0,
      "name": "string",
      "type": "Compensation",
      "planComponentType": "string",
      "calculations": []
    },
    "defaultCurrency": "string",
    "defaultQuota": 0.1
  },
  "planAcceleratorDTOs": [
    {
      "id": 0,
      "minQuota": 0.1,
      "maxQuota": 0.1,
      "baseAccelerator": 0.1,
      "accelerationMethod": "string",
      "displayTierId": 0
    }
  ],
  "planPaymentDTOs": [
    {
      "id": 0,
      "percentage": 0.1,
      "payPeriodMethod": "string",
      "releaseMethod": "string",
      "dataSourceId": "string",
      "dataField": "string",
      "dateField": "string",
      "isLessThanOrEqualTo": "string",
      "numerator": "string",
      "denominator": "string",
      "startDate": "string",
      "endDate": "string",
      "frequency": "string",
      "qualifierType": "string",
      "releaseType": "string",
      "conditionValue": "string",
      "comparisonOperand": "string",
      "releaseTerm": "string",
      "planComponentID": 0
    }
  ],
  "planPayoutDTO": {
    "id": 0,
    "earningDriver": "string",
    "frequency": "string",
    "defaultPayoutRate": 0.1,
    "useDefaults": "string",
    "lookupTable": "string",
    "lookupColumn": "string",
    "useLookup": "string",
    "isUsingCustomFormula": true,
    "customFormula": {
      "id": 0,
      "name": "string",
      "type": "Compensation",
      "planComponentType": "string",
      "calculations": []
    },
    "defaultPayoutRateMode": "None"
  },
  "planQuotaAmountDTO": {
    "id": 0,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "frequency": "string"
  },
  "planPayeeEffectiveRangeDTO": [
    {
      "id": 0,
      "quotaCurrency": "string",
      "basePayoutRate": 0.1,
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "payeeId": "string",
      "quotaValue": 0.1
    }
  ],
  "rateCardConditionDTOs": [
    {
      "id": 0,
      "index": 0,
      "name": "string",
      "multiplier": 0.1,
      "rateCardOperators": []
    }
  ],
  "planComponentCreditCriteriaDTO": {
    "id": 0,
    "planComponentId": 0,
    "sourceFilterDTO": {
      "constraint": {},
      "and": {},
      "or": {},
      "not": {},
      "metadata": {}
    }
  },
  "basePayoutRateType": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans/planComponents',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/plans/planComponents', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/plans/planComponents',
  params: {
  }, headers: headers

p JSON.parse(result)

Update plan component.

Body parameter

{
  "id": 0,
  "planId": 0,
  "name": "string",
  "description": "string",
  "type": "string",
  "json": "string",
  "weight": 0.1,
  "planDataDTO": {
    "id": 0,
    "source": "string",
    "owner": "string",
    "additionalCriteria": "string",
    "earnedDate": "string",
    "trackSplits": true,
    "isUsingCustomFormula": true,
    "customFormula": {
      "id": 0,
      "name": "string",
      "type": "Compensation",
      "planComponentType": "string",
      "calculations": []
    },
    "payeeFilter": true
  },
  "planQuotaDTO": {
    "id": 0,
    "earningMeasure": "string",
    "earningType": "string",
    "rateType": "string",
    "hasRateCard": true,
    "isUsingCustomFormula": true,
    "customFormula": {
      "id": 0,
      "name": "string",
      "type": "Compensation",
      "planComponentType": "string",
      "calculations": []
    },
    "defaultCurrency": "string",
    "defaultQuota": 0.1
  },
  "planAcceleratorDTOs": [
    {
      "id": 0,
      "minQuota": 0.1,
      "maxQuota": 0.1,
      "baseAccelerator": 0.1,
      "accelerationMethod": "string",
      "displayTierId": 0
    }
  ],
  "planPaymentDTOs": [
    {
      "id": 0,
      "percentage": 0.1,
      "payPeriodMethod": "string",
      "releaseMethod": "string",
      "dataSourceId": "string",
      "dataField": "string",
      "dateField": "string",
      "isLessThanOrEqualTo": "string",
      "numerator": "string",
      "denominator": "string",
      "startDate": "string",
      "endDate": "string",
      "frequency": "string",
      "qualifierType": "string",
      "releaseType": "string",
      "conditionValue": "string",
      "comparisonOperand": "string",
      "releaseTerm": "string",
      "planComponentID": 0
    }
  ],
  "planPayoutDTO": {
    "id": 0,
    "earningDriver": "string",
    "frequency": "string",
    "defaultPayoutRate": 0.1,
    "useDefaults": "string",
    "lookupTable": "string",
    "lookupColumn": "string",
    "useLookup": "string",
    "isUsingCustomFormula": true,
    "customFormula": {
      "id": 0,
      "name": "string",
      "type": "Compensation",
      "planComponentType": "string",
      "calculations": []
    },
    "defaultPayoutRateMode": "None"
  },
  "planQuotaAmountDTO": {
    "id": 0,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "frequency": "string"
  },
  "planPayeeEffectiveRangeDTO": [
    {
      "id": 0,
      "quotaCurrency": "string",
      "basePayoutRate": 0.1,
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "payeeId": "string",
      "quotaValue": 0.1
    }
  ],
  "rateCardConditionDTOs": [
    {
      "id": 0,
      "index": 0,
      "name": "string",
      "multiplier": 0.1,
      "rateCardOperators": []
    }
  ],
  "planComponentCreditCriteriaDTO": {
    "id": 0,
    "planComponentId": 0,
    "sourceFilterDTO": {
      "constraint": {},
      "and": {},
      "or": {},
      "not": {},
      "metadata": {}
    }
  },
  "basePayoutRateType": "string"
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentDTO

false

none

» id

body

integer(int32)¦null

false

none

» planId

body

integer(int32)

false

none

» name

body

string¦null

false

none

» description

body

string¦null

false

none

» type

body

string¦null

false

none

» json

body

string¦null

false

none

» weight

body

number(double)¦null

false

none

» planDataDTO

body

Varicent.RESTAPI.v1.DTOs.Plans.PlanDataDTO

false

none

»» id

body

integer(int32)¦null

false

none

»» source

body

string¦null

false

none

»» owner

body

string¦null

false

none

»» additionalCriteria

body

string¦null

false

none

»» earnedDate

body

string¦null

false

none

»» trackSplits

body

boolean

false

none

»» isUsingCustomFormula

body

boolean

false

none

»» customFormula

body

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentCustomFormulaDTO

false

none

»»» id

body

integer(int32)¦null

false

none

»»» name

body

string¦null

false

none

»»» type

body

string

false

none

»»» planComponentType

body

string¦null

false

none

»»» calculations

body

[Varicent.RESTAPI.v1.DTOs.NavigationCalculationElementDTO]¦null

false

none

»»»» parentBlockId

body

integer(int32)

false

none

»»»» elementId

body

integer(int32)

false

none

»»»» calculationId

body

integer(int32)

false

none

»»»» calculationType

body

string¦null

false

none

»»»» name

body

string¦null

false

none

»»»» comment

body

string¦null

false

none

»»»» isFavourite

body

boolean

false

none

»»»» sourceTables

body

[string]¦null

false

none

»» payeeFilter

body

boolean

false

none

» planQuotaDTO

body

Varicent.RESTAPI.v1.DTOs.Plans.PlanQuotaDTO

false

none

»» id

body

integer(int32)¦null

false

none

»» earningMeasure

body

string¦null

false

none

»» earningType

body

string¦null

false

none

»» rateType

body

string¦null

false

none

»» hasRateCard

body

boolean

false

none

»» isUsingCustomFormula

body

boolean

false

none

»» customFormula

body

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentCustomFormulaDTO

false

none

»» defaultCurrency

body

string¦null

false

none

»» defaultQuota

body

number(double)

false

none

» planAcceleratorDTOs

body

[Varicent.RESTAPI.v1.DTOs.Plans.PlanAcceleratorDTO]¦null

false

none

»» id

body

integer(int32)¦null

false

none

»» minQuota

body

number(double)

false

none

»» maxQuota

body

number(double)

false

none

»» baseAccelerator

body

number(double)

false

none

»» accelerationMethod

body

string¦null

false

none

»» displayTierId

body

integer(int32)

false

none

» planPaymentDTOs

body

[Varicent.RESTAPI.v1.DTOs.Plans.PlanPaymentDTO]¦null

false

none

»» id

body

integer(int32)¦null

false

none

»» percentage

body

number(double)

false

none

»» payPeriodMethod

body

string¦null

false

none

»» releaseMethod

body

string¦null

false

none

»» dataSourceId

body

string¦null

false

none

»» dataField

body

string¦null

false

none

»» dateField

body

string¦null

false

none

»» isLessThanOrEqualTo

body

string¦null

false

none

»» numerator

body

string¦null

false

none

»» denominator

body

string¦null

false

none

»» startDate

body

string¦null

false

none

»» endDate

body

string¦null

false

none

»» frequency

body

string¦null

false

none

»» qualifierType

body

string¦null

false

none

»» releaseType

body

string¦null

false

none

»» conditionValue

body

string¦null

false

none

»» comparisonOperand

body

string¦null

false

none

»» releaseTerm

body

string¦null

false

none

»» planComponentID

body

integer(int32)

false

none

» planPayoutDTO

body

Varicent.RESTAPI.v1.DTOs.Plans.PlanPayoutDTO

false

none

»» id

body

integer(int32)¦null

false

none

»» earningDriver

body

string¦null

false

none

»» frequency

body

string¦null

false

none

»» defaultPayoutRate

body

number(double)

false

none

»» useDefaults

body

string¦null

false

none

»» lookupTable

body

string¦null

false

none

»» lookupColumn

body

string¦null

false

none

»» useLookup

body

string¦null

false

none

»» isUsingCustomFormula

body

boolean

false

none

»» customFormula

body

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentCustomFormulaDTO

false

none

»» defaultPayoutRateMode

body

string

false

none

» planQuotaAmountDTO

body

Varicent.RESTAPI.v1.DTOs.Plans.PlanQuotaAmountDTO

false

none

»» id

body

integer(int32)¦null

false

none

»» startDate

body

string(date-time)

false

none

»» endDate

body

string(date-time)

false

none

»» frequency

body

string¦null

false

none

» planPayeeEffectiveRangeDTO

body

[Varicent.RESTAPI.v1.DTOs.Plans.PlanPayeeEffectiveRangeDTO]¦null

false

none

»» id

body

integer(int32)¦null

false

none

»» quotaCurrency

body

string¦null

false

none

»» basePayoutRate

body

number(double)

false

none

»» startDate

body

string(date-time)

false

none

»» endDate

body

string(date-time)

false

none

»» payeeId

body

string¦null

false

none

»» quotaValue

body

number(double)

false

none

» rateCardConditionDTOs

body

[RESTAPI.v1.DTOs.Plans.RateCard.RateCardConditionDTO]¦null

false

none

»» id

body

integer(int32)

false

none

»» index

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» multiplier

body

number(double)

false

none

»» rateCardOperators

body

[RESTAPI.v1.DTOs.Plans.RateCard.RateCardOperatorDTO]¦null

false

none

»»» id

body

integer(int32)

false

none

»»» field

body

string¦null

false

none

»»» index

body

integer(int32)

false

none

»»» operatorValuePairs

body

[RESTAPI.v1.DTOs.Plans.RateCard.RateCardOperatorValueDTO]¦null

false

none

»»»» name

body

string¦null

false

none

»»»» value

body

string¦null

false

none

»»»» index

body

integer(int32)

false

none

»»»» rateCardOperatorId

body

integer(int32)

false

none

»»»» type

body

string

false

none

»»» rateCardConditionId

body

integer(int32)

false

none

» planComponentCreditCriteriaDTO

body

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentCreditCriteriaDTO

false

none

»» id

body

integer(int32)¦null

false

none

»» planComponentId

body

integer(int32)¦null

false

none

»» sourceFilterDTO

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterDTO

false

none

»»» constraint

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterConstraintDTO

false

none

»»»» columnName

body

string¦null

false

none

»»»» operator

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterOperatorDTO

false

none

»»»»» type

body

string

false

none

»»»» value

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterValueDTO

false

none

»»»»» text

body

string¦null

false

none

»»»»» numeric

body

number(double)¦null

false

none

»»»»» date

body

string(date-time)¦null

false

none

»»»»» special

body

string¦null

false

none

»»»»» valueId

body

integer(int32)¦null

false

none

»»»»» rangeValue

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexRangeValueDTO

false

none

»»»»»» min

body

any

false

none

»»»»»» max

body

any

false

none

»»»» caseSensitive

body

boolean¦null

false

none

»»» and

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterAndDTO

false

none

»»»» filters

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»» or

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterOrDTO

false

none

»»»» filters

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»» not

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterNotDTO

false

none

»»»» filter

body

any

false

none

»»» metadata

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterMetaDataDTO

false

none

»»»» additionalProperties

body

any

false

none

» basePayoutRateType

body

string¦null

false

none

Enumerated Values

Parameter

Value

»»» type

Compensation

»»» type

Credit

»»» type

Quota

»» defaultPayoutRateMode

None

»» defaultPayoutRateMode

Default

»» defaultPayoutRateMode

Lookup

»» defaultPayoutRateMode

AutoCalculate

»»»» type

Text

»»»» type

Numeric

»»»» type

Date

»»»»» type

Equals

»»»»» type

NotEquals

»»»»» type

LessThan

»»»»» type

LessThanEquals

»»»»» type

GreaterThan

»»»»» type

GreaterThanEquals

»»»»» type

IsNull

»»»»» type

IsNotNull

»»»»» type

Contains

»»»»» type

NotContains

»»»»» type

StartWith

»»»»» type

EndWith

»»»»» type

InRange

»»»»» type

InArray

»»»»» type

NotInArray

»»»»» special

CurrentWebUser

»»»»» special

CurrentDate

»»»»» special

CurrentRowValue

»»»»» special

WorkflowFormID

Responses

Status

Meaning

Description

Schema

200

OK

Plan component is updated.

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/plans/planComponents", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/planComponents");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "planId": 0,
  "name": "string",
  "description": "string",
  "type": "string",
  "json": "string",
  "weight": 0.1,
  "planDataDTO": {
    "id": 0,
    "source": "string",
    "owner": "string",
    "additionalCriteria": "string",
    "earnedDate": "string",
    "trackSplits": true,
    "isUsingCustomFormula": true,
    "customFormula": {
      "id": 0,
      "name": "string",
      "type": "Compensation",
      "planComponentType": "string",
      "calculations": []
    },
    "payeeFilter": true
  },
  "planQuotaDTO": {
    "id": 0,
    "earningMeasure": "string",
    "earningType": "string",
    "rateType": "string",
    "hasRateCard": true,
    "isUsingCustomFormula": true,
    "customFormula": {
      "id": 0,
      "name": "string",
      "type": "Compensation",
      "planComponentType": "string",
      "calculations": []
    },
    "defaultCurrency": "string",
    "defaultQuota": 0.1
  },
  "planAcceleratorDTOs": [
    {
      "id": 0,
      "minQuota": 0.1,
      "maxQuota": 0.1,
      "baseAccelerator": 0.1,
      "accelerationMethod": "string",
      "displayTierId": 0
    }
  ],
  "planPaymentDTOs": [
    {
      "id": 0,
      "percentage": 0.1,
      "payPeriodMethod": "string",
      "releaseMethod": "string",
      "dataSourceId": "string",
      "dataField": "string",
      "dateField": "string",
      "isLessThanOrEqualTo": "string",
      "numerator": "string",
      "denominator": "string",
      "startDate": "string",
      "endDate": "string",
      "frequency": "string",
      "qualifierType": "string",
      "releaseType": "string",
      "conditionValue": "string",
      "comparisonOperand": "string",
      "releaseTerm": "string",
      "planComponentID": 0
    }
  ],
  "planPayoutDTO": {
    "id": 0,
    "earningDriver": "string",
    "frequency": "string",
    "defaultPayoutRate": 0.1,
    "useDefaults": "string",
    "lookupTable": "string",
    "lookupColumn": "string",
    "useLookup": "string",
    "isUsingCustomFormula": true,
    "customFormula": {
      "id": 0,
      "name": "string",
      "type": "Compensation",
      "planComponentType": "string",
      "calculations": []
    },
    "defaultPayoutRateMode": "None"
  },
  "planQuotaAmountDTO": {
    "id": 0,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "frequency": "string"
  },
  "planPayeeEffectiveRangeDTO": [
    {
      "id": 0,
      "quotaCurrency": "string",
      "basePayoutRate": 0.1,
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "payeeId": "string",
      "quotaValue": 0.1
    }
  ],
  "rateCardConditionDTOs": [
    {
      "id": 0,
      "index": 0,
      "name": "string",
      "multiplier": 0.1,
      "rateCardOperators": []
    }
  ],
  "planComponentCreditCriteriaDTO": {
    "id": 0,
    "planComponentId": 0,
    "sourceFilterDTO": {
      "constraint": {},
      "and": {},
      "or": {},
      "not": {},
      "metadata": {}
    }
  },
  "basePayoutRateType": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans/planComponents',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/plans/planComponents', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/plans/planComponents',
  params: {
  }, headers: headers

p JSON.parse(result)

Get plan component.

Parameters

Name

In

Type

Required

Description

planComponentID

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Plan component is returned.

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/plans/planComponents/{planComponentID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/planComponents/{planComponentID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans/planComponents/{planComponentID}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/plans/planComponents/{planComponentID}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/plans/planComponents/{planComponentID}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "planId": 0,
  "name": "string",
  "description": "string",
  "type": "string",
  "json": "string",
  "weight": 0.1,
  "planDataDTO": {
    "id": 0,
    "source": "string",
    "owner": "string",
    "additionalCriteria": "string",
    "earnedDate": "string",
    "trackSplits": true,
    "isUsingCustomFormula": true,
    "customFormula": {
      "id": 0,
      "name": "string",
      "type": "Compensation",
      "planComponentType": "string",
      "calculations": []
    },
    "payeeFilter": true
  },
  "planQuotaDTO": {
    "id": 0,
    "earningMeasure": "string",
    "earningType": "string",
    "rateType": "string",
    "hasRateCard": true,
    "isUsingCustomFormula": true,
    "customFormula": {
      "id": 0,
      "name": "string",
      "type": "Compensation",
      "planComponentType": "string",
      "calculations": []
    },
    "defaultCurrency": "string",
    "defaultQuota": 0.1
  },
  "planAcceleratorDTOs": [
    {
      "id": 0,
      "minQuota": 0.1,
      "maxQuota": 0.1,
      "baseAccelerator": 0.1,
      "accelerationMethod": "string",
      "displayTierId": 0
    }
  ],
  "planPaymentDTOs": [
    {
      "id": 0,
      "percentage": 0.1,
      "payPeriodMethod": "string",
      "releaseMethod": "string",
      "dataSourceId": "string",
      "dataField": "string",
      "dateField": "string",
      "isLessThanOrEqualTo": "string",
      "numerator": "string",
      "denominator": "string",
      "startDate": "string",
      "endDate": "string",
      "frequency": "string",
      "qualifierType": "string",
      "releaseType": "string",
      "conditionValue": "string",
      "comparisonOperand": "string",
      "releaseTerm": "string",
      "planComponentID": 0
    }
  ],
  "planPayoutDTO": {
    "id": 0,
    "earningDriver": "string",
    "frequency": "string",
    "defaultPayoutRate": 0.1,
    "useDefaults": "string",
    "lookupTable": "string",
    "lookupColumn": "string",
    "useLookup": "string",
    "isUsingCustomFormula": true,
    "customFormula": {
      "id": 0,
      "name": "string",
      "type": "Compensation",
      "planComponentType": "string",
      "calculations": []
    },
    "defaultPayoutRateMode": "None"
  },
  "planQuotaAmountDTO": {
    "id": 0,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "frequency": "string"
  },
  "planPayeeEffectiveRangeDTO": [
    {
      "id": 0,
      "quotaCurrency": "string",
      "basePayoutRate": 0.1,
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "payeeId": "string",
      "quotaValue": 0.1
    }
  ],
  "rateCardConditionDTOs": [
    {
      "id": 0,
      "index": 0,
      "name": "string",
      "multiplier": 0.1,
      "rateCardOperators": []
    }
  ],
  "planComponentCreditCriteriaDTO": {
    "id": 0,
    "planComponentId": 0,
    "sourceFilterDTO": {
      "constraint": {},
      "and": {},
      "or": {},
      "not": {},
      "metadata": {}
    }
  },
  "basePayoutRateType": "string"
}
{"id":0,"planId":0,"name":"string","description":"string","type":"string","json":"string","weight":0.1,"planDataDTO":{"id":0,"source":"string","owner":"string","additionalCriteria":"string","earnedDate":"string","trackSplits":true,"isUsingCustomFormula":true,"customFormula":{"id":0,"name":"string","type":"Compensation","planComponentType":"string","calculations":[]},"payeeFilter":true},"planQuotaDTO":{"id":0,"earningMeasure":"string","earningType":"string","rateType":"string","hasRateCard":true,"isUsingCustomFormula":true,"customFormula":{"id":0,"name":"string","type":"Compensation","planComponentType":"string","calculations":[]},"defaultCurrency":"string","defaultQuota":0.1},"planAcceleratorDTOs":[{"id":0,"minQuota":0.1,"maxQuota":0.1,"baseAccelerator":0.1,"accelerationMethod":"string","displayTierId":0}],"planPaymentDTOs":[{"id":0,"percentage":0.1,"payPeriodMethod":"string","releaseMethod":"string","dataSourceId":"string","dataField":"string","dateField":"string","isLessThanOrEqualTo":"string","numerator":"string","denominator":"string","startDate":"string","endDate":"string","frequency":"string","qualifierType":"string","releaseType":"string","conditionValue":"string","comparisonOperand":"string","releaseTerm":"string","planComponentID":0}],"planPayoutDTO":{"id":0,"earningDriver":"string","frequency":"string","defaultPayoutRate":0.1,"useDefaults":"string","lookupTable":"string","lookupColumn":"string","useLookup":"string","isUsingCustomFormula":true,"customFormula":{"id":0,"name":"string","type":"Compensation","planComponentType":"string","calculations":[]},"defaultPayoutRateMode":"None"},"planQuotaAmountDTO":{"id":0,"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","frequency":"string"},"planPayeeEffectiveRangeDTO":[{"id":0,"quotaCurrency":"string","basePayoutRate":0.1,"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","payeeId":"string","quotaValue":0.1}],"rateCardConditionDTOs":[{"id":0,"index":0,"name":"string","multiplier":0.1,"rateCardOperators":[]}],"planComponentCreditCriteriaDTO":{"id":0,"planComponentId":0,"sourceFilterDTO":{"constraint":{},"and":{},"or":{},"not":{},"metadata":{}}},"basePayoutRateType":"string"}

Delete plan component.

Parameters

Name

In

Type

Required

Description

planComponentID

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Plan component is deleted.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/plans/planComponents/{planComponentID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/planComponents/{planComponentID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/plans/planComponents/{planComponentID}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/plans/planComponents/{planComponentID}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/plans/planComponents/{planComponentID}',
  params: {
  }

p JSON.parse(result)

Get plan components for plan.

Parameters

Name

In

Type

Required

Description

type

query

string

false

none

Enumerated Values

Parameter

Value

type

Compensation

type

Credit

type

Quota

Responses

Status

Meaning

Description

Schema

200

OK

Plan components are returned for plan.

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentCustomFormulaDTO]

false

none

none

» id

integer(int32)¦null

false

none

none

» name

string¦null

false

none

none

» type

string

false

none

none

» planComponentType

string¦null

false

none

none

» calculations

[Varicent.RESTAPI.v1.DTOs.NavigationCalculationElementDTO]¦null

false

none

none

»» parentBlockId

integer(int32)

false

none

none

»» elementId

integer(int32)

false

none

none

»» calculationId

integer(int32)

false

none

none

»» calculationType

string¦null

false

none

none

»» name

string¦null

false

none

none

»» comment

string¦null

false

none

none

»» isFavourite

boolean

false

none

none

»» sourceTables

[string]¦null

false

none

none

Enumerated Values

Property

Value

type

Compensation

type

Credit

type

Quota

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/plans/planComponentCustomFormula", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/planComponentCustomFormula");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans/planComponentCustomFormula',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/plans/planComponentCustomFormula', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/plans/planComponentCustomFormula',
  params: {
  }, headers: headers

p JSON.parse(result)

Get plan payees.

Parameters

Name

In

Type

Required

Description

planID

path

integer(int32)

true

none

componentID

query

string

false

none

period

query

string

false

none

Responses

Status

Meaning

Description

Schema

201

Created

plan payees with payout are returned.

Inline

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Plans.PlanPayeePayoutDetailsDTO]

false

none

none

» startDate

string(date-time)

false

none

none

» endDate

string(date-time)¦null

false

none

none

» planId

integer(int32)

false

none

none

» attainment

number(double)¦null

false

none

none

» quota

number(double)

false

none

none

» percent

number(double)¦null

false

none

none

» credit

number(double)¦null

false

none

none

» currency

string¦null

false

none

none

» estimatedPayout

number(double)

false

none

none

» totalPaid

number(double)

false

none

none

» totalScheduled

number(double)

false

none

none

» totalHeld

number(double)

false

none

none

» payroll

number(double)

false

none

none

» name

string¦null

false

none

none

» id

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/plans/{planID}/plansPayeeWithPayout", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/{planID}/plansPayeeWithPayout");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans/{planID}/plansPayeeWithPayout',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/plans/{planID}/plansPayeeWithPayout', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/plans/{planID}/plansPayeeWithPayout',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "planId": 0,
    "attainment": 0.1,
    "quota": 0.1,
    "percent": 0.1,
    "credit": 0.1,
    "currency": "string",
    "estimatedPayout": 0.1,
    "totalPaid": 0.1,
    "totalScheduled": 0.1,
    "totalHeld": 0.1,
    "payroll": 0.1,
    "name": "string",
    "id": "string"
  }
]
[{"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","planId":0,"attainment":0.1,"quota":0.1,"percent":0.1,"credit":0.1,"currency":"string","estimatedPayout":0.1,"totalPaid":0.1,"totalScheduled":0.1,"totalHeld":0.1,"payroll":0.1,"name":"string","id":"string"}]

Create payee plan assignment, override if already exist.

Body parameter

[
  {
    "payeeId": "string",
    "planId": 0,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z"
  }
]

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Plans.PayeePlanAssignmentDTO

false

none

Responses

Status

Meaning

Description

Schema

201

Created

Payee plan assignment is created.

Inline

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Plans.PayeePlanAssignmentDTO]

false

none

none

» payeeId

string¦null

false

none

none

» planId

integer(int32)

false

none

none

» startDate

string(date-time)

false

none

none

» endDate

string(date-time)¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/plans/payeesPlanAssignment", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/payeesPlanAssignment");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "payeeId": "string",
    "planId": 0,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans/payeesPlanAssignment',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/plans/payeesPlanAssignment', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/plans/payeesPlanAssignment',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "payeeId": "string",
    "planId": 0,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z"
  }
]
[{"payeeId":"string","planId":0,"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z"}]

Create payee plan assignment.

Body parameter

[
  {
    "payeeId": "string",
    "planId": 0,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z"
  }
]

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Plans.PayeePlanAssignmentDTO

false

none

Responses

Status

Meaning

Description

Schema

201

Created

Payee plan assignment is created.

Inline

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Plans.PayeePlanAssignmentDTO]

false

none

none

» payeeId

string¦null

false

none

none

» planId

integer(int32)

false

none

none

» startDate

string(date-time)

false

none

none

» endDate

string(date-time)¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/plans/payeesPlanAssignment", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/payeesPlanAssignment");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "payeeId": "string",
    "planId": 0,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans/payeesPlanAssignment',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/plans/payeesPlanAssignment', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/plans/payeesPlanAssignment',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "payeeId": "string",
    "planId": 0,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z"
  }
]
[{"payeeId":"string","planId":0,"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z"}]

Update payee plan assignment.

Body parameter

[
  {
    "payeeId": "string",
    "planId": 0,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z"
  }
]

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Plans.PayeePlanAssignmentDTO

false

none

Responses

Status

Meaning

Description

Schema

201

Created

Payee plan assignment is updated.

Inline

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Plans.PayeePlanAssignmentDTO]

false

none

none

» payeeId

string¦null

false

none

none

» planId

integer(int32)

false

none

none

» startDate

string(date-time)

false

none

none

» endDate

string(date-time)¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/plans/payeesPlanAssignment", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/payeesPlanAssignment");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "payeeId": "string",
    "planId": 0,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans/payeesPlanAssignment',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/plans/payeesPlanAssignment', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/plans/payeesPlanAssignment',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "payeeId": "string",
    "planId": 0,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z"
  }
]
[{"payeeId":"string","planId":0,"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z"}]

Delete payee plan assignment.

Body parameter

[
  {
    "payeeId": "string",
    "planId": 0,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z"
  }
]

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Plans.PayeePlanAssignmentDTO

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Payee plan assignments are deleted.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/plans/delete/payeesPlanAssignments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/delete/payeesPlanAssignments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "payeeId": "string",
    "planId": 0,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z"
  }
]';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/plans/delete/payeesPlanAssignments',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.delete('http://localhost:8080/api/v1/plans/delete/payeesPlanAssignments', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.delete 'http://localhost:8080/api/v1/plans/delete/payeesPlanAssignments',
  params: {
  }, headers: headers

p JSON.parse(result)

Get plan payees target incentives.

Parameters

Name

In

Type

Required

Description

planID

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

201

Created

plan payees with payout are returned.

Inline

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.Plans.PayeePlanTargetIncentiveDTO]

false

none

none

» payeeId

string¦null

false

none

none

» planId

integer(int32)

false

none

none

» targetIncentiveAmount

number(double)

false

none

none

» startDate

string(date-time)

false

none

none

» endDate

string(date-time)¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/plans/{planID}/payeePlanTargetIncentive", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/{planID}/payeePlanTargetIncentive");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans/{planID}/payeePlanTargetIncentive',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/plans/{planID}/payeePlanTargetIncentive', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/plans/{planID}/payeePlanTargetIncentive',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "payeeId": "string",
    "planId": 0,
    "targetIncentiveAmount": 0.1,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z"
  }
]
[{"payeeId":"string","planId":0,"targetIncentiveAmount":0.1,"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z"}]

Create payee plan target incentive, override if already exist.

Body parameter

[
  {
    "payeeId": "string",
    "planId": 0,
    "targetIncentiveAmount": 0.1,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z"
  }
]

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Plans.PayeePlanTargetIncentiveDTO

false

none

Responses

Status

Meaning

Description

Schema

201

Created

Payee plan target incentive is created.

Inline

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.Plans.PayeePlanTargetIncentiveDTO]

false

none

none

» payeeId

string¦null

false

none

none

» planId

integer(int32)

false

none

none

» targetIncentiveAmount

number(double)

false

none

none

» startDate

string(date-time)

false

none

none

» endDate

string(date-time)¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/plans/payeePlanTargetIncentive", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/payeePlanTargetIncentive");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "payeeId": "string",
    "planId": 0,
    "targetIncentiveAmount": 0.1,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans/payeePlanTargetIncentive',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/plans/payeePlanTargetIncentive', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/plans/payeePlanTargetIncentive',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "payeeId": "string",
    "planId": 0,
    "targetIncentiveAmount": 0.1,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z"
  }
]
[{"payeeId":"string","planId":0,"targetIncentiveAmount":0.1,"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z"}]

Create payee plan target incentive.

Body parameter

[
  {
    "payeeId": "string",
    "planId": 0,
    "targetIncentiveAmount": 0.1,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z"
  }
]

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Plans.PayeePlanTargetIncentiveDTO

false

none

Responses

Status

Meaning

Description

Schema

201

Created

Payee plan target incentive is created.

Inline

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.Plans.PayeePlanTargetIncentiveDTO]

false

none

none

» payeeId

string¦null

false

none

none

» planId

integer(int32)

false

none

none

» targetIncentiveAmount

number(double)

false

none

none

» startDate

string(date-time)

false

none

none

» endDate

string(date-time)¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/plans/payeePlanTargetIncentive", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/payeePlanTargetIncentive");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "payeeId": "string",
    "planId": 0,
    "targetIncentiveAmount": 0.1,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans/payeePlanTargetIncentive',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/plans/payeePlanTargetIncentive', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/plans/payeePlanTargetIncentive',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "payeeId": "string",
    "planId": 0,
    "targetIncentiveAmount": 0.1,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z"
  }
]
[{"payeeId":"string","planId":0,"targetIncentiveAmount":0.1,"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z"}]

Update payee plan target incentive.

Body parameter

[
  {
    "payeeId": "string",
    "planId": 0,
    "targetIncentiveAmount": 0.1,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z"
  }
]

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Plans.PayeePlanTargetIncentiveDTO

false

none

Responses

Status

Meaning

Description

Schema

201

Created

Payee plan target incentive is updated.

Inline

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.Plans.PayeePlanTargetIncentiveDTO]

false

none

none

» payeeId

string¦null

false

none

none

» planId

integer(int32)

false

none

none

» targetIncentiveAmount

number(double)

false

none

none

» startDate

string(date-time)

false

none

none

» endDate

string(date-time)¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/plans/payeePlanTargetIncentive", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/payeePlanTargetIncentive");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "payeeId": "string",
    "planId": 0,
    "targetIncentiveAmount": 0.1,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans/payeePlanTargetIncentive',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/plans/payeePlanTargetIncentive', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/plans/payeePlanTargetIncentive',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "payeeId": "string",
    "planId": 0,
    "targetIncentiveAmount": 0.1,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z"
  }
]
[{"payeeId":"string","planId":0,"targetIncentiveAmount":0.1,"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z"}]

Delete payee plan target incentives.

Parameters

Name

In

Type

Required

Description

targetIncentiveIDs

query

array[string]

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Payee plan target incentive are deleted.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/plans/delete/payeePlanTargetIncentive", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/delete/payeePlanTargetIncentive");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/plans/delete/payeePlanTargetIncentive',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/plans/delete/payeePlanTargetIncentive')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/plans/delete/payeePlanTargetIncentive',
  params: {
  }

p JSON.parse(result)

Create or update plan component custom formula and hook to downstream calc.

Body parameter

{
  "id": 0,
  "name": "string",
  "type": "Compensation",
  "planComponentType": "string",
  "calculations": [
    {
      "parentBlockId": 0,
      "elementId": 0,
      "calculationId": 0,
      "calculationType": "string",
      "name": "string",
      "comment": "string",
      "isFavourite": true,
      "sourceTables": []
    }
  ]
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentCustomFormulaDTO

false

none

» id

body

integer(int32)¦null

false

none

» name

body

string¦null

false

none

» type

body

string

false

none

» planComponentType

body

string¦null

false

none

» calculations

body

[Varicent.RESTAPI.v1.DTOs.NavigationCalculationElementDTO]¦null

false

none

»» parentBlockId

body

integer(int32)

false

none

»» elementId

body

integer(int32)

false

none

»» calculationId

body

integer(int32)

false

none

»» calculationType

body

string¦null

false

none

»» name

body

string¦null

false

none

»» comment

body

string¦null

false

none

»» isFavourite

body

boolean

false

none

»» sourceTables

body

[string]¦null

false

none

Enumerated Values

Parameter

Value

» type

Compensation

» type

Credit

» type

Quota

Responses

Status

Meaning

Description

Schema

200

OK

Plan component custom formula is saved.

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentCustomFormulaDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/plans/planComponentCustomFormula", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/planComponentCustomFormula");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "name": "string",
  "type": "Compensation",
  "planComponentType": "string",
  "calculations": [
    {
      "parentBlockId": 0,
      "elementId": 0,
      "calculationId": 0,
      "calculationType": "string",
      "name": "string",
      "comment": "string",
      "isFavourite": true,
      "sourceTables": []
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans/planComponentCustomFormula',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/plans/planComponentCustomFormula', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/plans/planComponentCustomFormula',
  params: {
  }, headers: headers

p JSON.parse(result)

Unhook plan component custom formula from downstream calc.

Body parameter

{
  "customFormulaDTO": {
    "id": 0,
    "name": "string",
    "type": "Compensation",
    "planComponentType": "string",
    "calculations": [
      {}
    ]
  },
  "isToBeLinked": true,
  "unionColumns": [
    "string"
  ]
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentCustomFormulaPatchDTO

false

none

» customFormulaDTO

body

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentCustomFormulaDTO

false

none

»» id

body

integer(int32)¦null

false

none

»» name

body

string¦null

false

none

»» type

body

string

false

none

»» planComponentType

body

string¦null

false

none

»» calculations

body

[Varicent.RESTAPI.v1.DTOs.NavigationCalculationElementDTO]¦null

false

none

»»» parentBlockId

body

integer(int32)

false

none

»»» elementId

body

integer(int32)

false

none

»»» calculationId

body

integer(int32)

false

none

»»» calculationType

body

string¦null

false

none

»»» name

body

string¦null

false

none

»»» comment

body

string¦null

false

none

»»» isFavourite

body

boolean

false

none

»»» sourceTables

body

[string]¦null

false

none

» isToBeLinked

body

boolean

false

none

» unionColumns

body

[string]¦null

false

none

Enumerated Values

Parameter

Value

»» type

Compensation

»» type

Credit

»» type

Quota

Responses

Status

Meaning

Description

Schema

200

OK

Plan component custom formula is unhooked.

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentCustomFormulaDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/plans/planComponentCustomFormula", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/planComponentCustomFormula");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "customFormulaDTO": {
    "id": 0,
    "name": "string",
    "type": "Compensation",
    "planComponentType": "string",
    "calculations": [
      {}
    ]
  },
  "isToBeLinked": true,
  "unionColumns": [
    "string"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans/planComponentCustomFormula',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/plans/planComponentCustomFormula', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/plans/planComponentCustomFormula',
  params: {
  }, headers: headers

p JSON.parse(result)

Get a dictionary of customFormulaIds and planComponent, plan counts using the formula.

Parameters

Name

In

Type

Required

Description

planComponentId

query

integer(int32)

false

none

type

query

string

false

none

Enumerated Values

Parameter

Value

type

Compensation

type

Credit

type

Quota

Responses

Status

Meaning

Description

Schema

200

OK

Plan components are returned for plan.

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

[integer]

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/plans/planComponentCustomFormulaUsage", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/planComponentCustomFormulaUsage");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans/planComponentCustomFormulaUsage',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/plans/planComponentCustomFormulaUsage', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/plans/planComponentCustomFormulaUsage',
  params: {
  }, headers: headers

p JSON.parse(result)

Get names for all plan component custom formulas.

Responses

Status

Meaning

Description

Schema

200

OK

Plan components names are returned for plan.

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/plans/planComponentCustomFormula/allNames", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/planComponentCustomFormula/allNames");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans/planComponentCustomFormula/allNames',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/plans/planComponentCustomFormula/allNames', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/plans/planComponentCustomFormula/allNames',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  "string"
]
["string"]

Create duplicate of plan component custom formula and hook to downstream calc.

Body parameter

{
  "sourceFormulaId": 0,
  "type": "Compensation",
  "name": "string",
  "suffix": "string"
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentCustomFormulaDuplicateDTO

false

none

» sourceFormulaId

body

integer(int32)

false

none

» type

body

string

false

none

» name

body

string¦null

false

none

» suffix

body

string¦null

false

none

Enumerated Values

Parameter

Value

» type

Compensation

» type

Credit

» type

Quota

Responses

Status

Meaning

Description

Schema

200

OK

Plan component custom formula is duplicated.

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentCustomFormulaDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/plans/duplicatePlanComponentCustomFormula", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/duplicatePlanComponentCustomFormula");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "sourceFormulaId": 0,
  "type": "Compensation",
  "name": "string",
  "suffix": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans/duplicatePlanComponentCustomFormula',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/plans/duplicatePlanComponentCustomFormula', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/plans/duplicatePlanComponentCustomFormula',
  params: {
  }, headers: headers

p JSON.parse(result)

Get downstream union calculation name and template source.

Parameters

Name

In

Type

Required

Description

planComponentType

query

string

false

none

type

query

string

false

none

Enumerated Values

Parameter

Value

type

Compensation

type

Credit

type

Quota

Responses

Status

Meaning

Description

Schema

200

OK

Get downstream union calculation name and template source.

Varicent.RESTAPI.v1.DTOs.Plans.PlanCustomFormulaDownstreamDetailsDTOVaricent.RESTAPI.v1.DTOs.Plans.PlanCustomFormulaDownstreamDetailsDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/plans/downstreamCalcDetails", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/downstreamCalcDetails");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans/downstreamCalcDetails',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/plans/downstreamCalcDetails', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/plans/downstreamCalcDetails',
  params: {
  }, headers: headers

p JSON.parse(result)

Delete plan component custom formula.

Parameters

Name

In

Type

Required

Description

customFormulaID

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Plan component custom formula is deleted.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/plans/planComponentCustomFormula/{customFormulaID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/planComponentCustomFormula/{customFormulaID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/plans/planComponentCustomFormula/{customFormulaID}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/plans/planComponentCustomFormula/{customFormulaID}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/plans/planComponentCustomFormula/{customFormulaID}',
  params: {
  }

p JSON.parse(result)

Get plan component data source.

Responses

Status

Meaning

Description

Schema

200

OK

Plan component is returned.

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/plans/planComponents/planDataSource", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/planComponents/planDataSource");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans/planComponents/planDataSource',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/plans/planComponents/planDataSource', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/plans/planComponents/planDataSource',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  "string"
]
["string"]

Get plan component event data source. The data source should exclude the tableName given.

Parameters

Name

In

Type

Required

Description

tableName

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Event data source and its related field names are returned.

RESTAPI.v1.DTOs.Plans.PlanReleaseEventFieldOptionsDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/plans/planComponents/eventDataSourceInfo/{tableName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/planComponents/eventDataSourceInfo/{tableName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans/planComponents/eventDataSourceInfo/{tableName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/plans/planComponents/eventDataSourceInfo/{tableName}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/plans/planComponents/eventDataSourceInfo/{tableName}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "primaryTableName": "string",
  "primaryNumericFields": [
    {
      "value": "string",
      "label": "string"
    }
  ],
  "planEventDataTableInfos": [
    {
      "tableName": "string",
      "keyField": "string",
      "numericFields": [],
      "dateFields": [],
      "textFields": []
    }
  ]
}
{"primaryTableName":"string","primaryNumericFields":[{"value":"string","label":"string"}],"planEventDataTableInfos":[{"tableName":"string","keyField":"string","numericFields":[],"dateFields":[],"textFields":[]}]}

Get date fields

Parameters

Name

In

Type

Required

Description

tableName

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Date fields are returned.

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/plans/planComponents/dateFields/{tableName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/planComponents/dateFields/{tableName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans/planComponents/dateFields/{tableName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/plans/planComponents/dateFields/{tableName}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/plans/planComponents/dateFields/{tableName}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  "string"
]
["string"]

Get numeric fields

Parameters

Name

In

Type

Required

Description

tableName

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Text fields are returned.

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentCreditQualifierOptionDTO]

false

none

none

» columnName

string¦null

false

none

none

» columnDataType

string¦null

false

none

none

» comparisonOperands

[string]¦null

false

none

none

» logicOperands

[string]¦null

false

none

none

» isKey

boolean

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/plans/planComponents/textFields/{tableName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/planComponents/textFields/{tableName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans/planComponents/textFields/{tableName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/plans/planComponents/textFields/{tableName}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/plans/planComponents/textFields/{tableName}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "columnName": "string",
    "columnDataType": "string",
    "comparisonOperands": [
      "string"
    ],
    "logicOperands": [
      "string"
    ],
    "isKey": true
  }
]
[{"columnName":"string","columnDataType":"string","comparisonOperands":["string"],"logicOperands":["string"],"isKey":true}]

Get periodic frequencies

Responses

Status

Meaning

Description

Schema

200

OK

Periodic Frequencies are returned.

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/plans/planComponents/periodicFrequencies", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/planComponents/periodicFrequencies");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans/planComponents/periodicFrequencies',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/plans/planComponents/periodicFrequencies', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/plans/planComponents/periodicFrequencies',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  "string"
]
["string"]

Get release terms

Responses

Status

Meaning

Description

Schema

200

OK

Release Terms are returned

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Plans.ReleaseTermDTO]

false

none

none

» releaseTermId

string¦null

false

none

none

» releaseTermName

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/plans/planComponents/releaseTerms", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/planComponents/releaseTerms");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans/planComponents/releaseTerms',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/plans/planComponents/releaseTerms', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/plans/planComponents/releaseTerms',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "releaseTermId": "string",
    "releaseTermName": "string"
  }
]
[{"releaseTermId":"string","releaseTermName":"string"}]

Get creditQualifiers for plan component.

Parameters

Name

In

Type

Required

Description

tableName

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Plan component credit qualifiers field is returned.

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentCreditQualifierOptionDTO]

false

none

none

» columnName

string¦null

false

none

none

» columnDataType

string¦null

false

none

none

» comparisonOperands

[string]¦null

false

none

none

» logicOperands

[string]¦null

false

none

none

» isKey

boolean

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/plans/planComponents/creditQualifiers/{tableName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/planComponents/creditQualifiers/{tableName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans/planComponents/creditQualifiers/{tableName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/plans/planComponents/creditQualifiers/{tableName}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/plans/planComponents/creditQualifiers/{tableName}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "columnName": "string",
    "columnDataType": "string",
    "comparisonOperands": [
      "string"
    ],
    "logicOperands": [
      "string"
    ],
    "isKey": true
  }
]
[{"columnName":"string","columnDataType":"string","comparisonOperands":["string"],"logicOperands":["string"],"isKey":true}]

Get creditCriterias columns for plan component.

Parameters

Name

In

Type

Required

Description

tableName

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Plan component credit criterias field is returned.

Varicent.RESTAPI.v1.DTOs.FullTableSchemaDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/plans/planComponents/creditCriterias/{tableName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/planComponents/creditCriterias/{tableName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans/planComponents/creditCriterias/{tableName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/plans/planComponents/creditCriterias/{tableName}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/plans/planComponents/creditCriterias/{tableName}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "columns": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "table": "string",
  "name": "string",
  "referencedSources": [
    "string"
  ],
  "referencedTimes": [
    {
      "levelId": "string",
      "timeId": "string"
    }
  ],
  "referencedSourcesDictionary": {
    "property1": "string",
    "property2": "string"
  },
  "referencedTimesDictionary": {
    "property1": {
      "levelId": "string",
      "timeId": "string"
    },
    "property2": {
      "levelId": "string",
      "timeId": "string"
    }
  }
}
{"columns":[{"name":"string","type":"String","isKey":true,"nullable":true,"values":"string","lockedPeriod":{},"referencedCol":"string","picklistFilter":"string","displayName":"string","isELTPeriod":true}],"table":"string","name":"string","referencedSources":["string"],"referencedTimes":[{"levelId":"string","timeId":"string"}],"referencedSourcesDictionary":{"property1":"string","property2":"string"},"referencedTimesDictionary":{"property1":{"levelId":"string","timeId":"string"},"property2":{"levelId":"string","timeId":"string"}}}

Get the table definition with extended columns of a custom table.

Parameters

Name

In

Type

Required

Description

tableName

path

string

true

Name of an existing custom table.

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.TableDefinitionDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/plans/planComponents/tableDefinition/{tableName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/planComponents/tableDefinition/{tableName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans/planComponents/tableDefinition/{tableName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/plans/planComponents/tableDefinition/{tableName}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/plans/planComponents/tableDefinition/{tableName}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "table": {
    "version": {
      "rowVersion": 0
    },
    "name": "string",
    "tableType": "System",
    "effectiveDated": true,
    "workflowObjectID": 0,
    "hierarchyMetadata": {
      "tableName": "string",
      "idColumnName": "string",
      "parentColumnName": "string"
    },
    "lastUpdatedTracking": true
  },
  "columns": [
    {
      "column": {},
      "isRemovable": true,
      "isNullable": true,
      "referencedColumn": "string"
    }
  ],
  "time": {
    "timeId": "string",
    "dateColumn": "string",
    "lockedOn": {},
    "min": {},
    "max": {}
  }
}
{"table":{"version":{"rowVersion":0},"name":"string","tableType":"System","effectiveDated":true,"workflowObjectID":0,"hierarchyMetadata":{"tableName":"string","idColumnName":"string","parentColumnName":"string"},"lastUpdatedTracking":true},"columns":[{"column":{},"isRemovable":true,"isNullable":true,"referencedColumn":"string"}],"time":{"timeId":"string","dateColumn":"string","lockedOn":{},"min":{},"max":{}}}

Returns all condition names in a given plan.

Parameters

Name

In

Type

Required

Description

planId

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Returns all condition names in a given plan.

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

integer(int32)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/plans/rateCardConditionNames/{planId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/rateCardConditionNames/{planId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans/rateCardConditionNames/{planId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/plans/rateCardConditionNames/{planId}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/plans/rateCardConditionNames/{planId}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "property1": 0,
  "property2": 0
}
{"property1":0,"property2":0}

Returns available sources for calculated base payout rate.

Parameters

Name

In

Type

Required

Description

tableName

path

string

true

none

columnName

path

string

true

none

planId

query

integer(int32)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Returns result for calculated base payout rate.

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

number(double)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/payoutRateLookupData/{tableName}/{columnName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payoutRateLookupData/{tableName}/{columnName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/payoutRateLookupData/{tableName}/{columnName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/payoutRateLookupData/{tableName}/{columnName}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/payoutRateLookupData/{tableName}/{columnName}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "property1": 0.1,
  "property2": 0.1
}
{"property1":0.1,"property2":0.1}

Get parentBlockId for custom formula calcs.

Parameters

Name

In

Type

Required

Description

type

query

string

false

none

Enumerated Values

Parameter

Value

type

Compensation

type

Credit

type

Quota

Responses

Status

Meaning

Description

Schema

200

OK

Returns the id of the block in which the custom formula calcs will be created.

integer

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/plans/planComponents/customFormulaParentBlockId", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/planComponents/customFormulaParentBlockId");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans/planComponents/customFormulaParentBlockId',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/plans/planComponents/customFormulaParentBlockId', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/plans/planComponents/customFormulaParentBlockId',
  params: {
  }, headers: headers

p JSON.parse(result)

Get a string representation of the start date of the T001 calendar.

Parameters

Name

In

Type

Required

Description

startDate

query

string(date-time)

false

none

endDate

query

string(date-time)

false

none

frequency

query

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Effective date ranges that align with T001 calendar.

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[[System.Tuple2[System.DateTime,System.DateTime]](#schemasystem.tuple2[system.datetime,system.datetime])]

false

none

none

» item1

string(date-time)

false

none

none

» item2

string(date-time)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/plans/planEffectiveDateRanges", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/planEffectiveDateRanges");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans/planEffectiveDateRanges',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/plans/planEffectiveDateRanges', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/plans/planEffectiveDateRanges',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "item1": "2019-08-24T14:15:22Z",
    "item2": "2019-08-24T14:15:22Z"
  }
]
[{"item1":"2019-08-24T14:15:22Z","item2":"2019-08-24T14:15:22Z"}]

Update plan component weights.

Body parameter

[
  {
    "id": 0,
    "planId": 0,
    "name": "string",
    "description": "string",
    "type": "string",
    "json": "string",
    "weight": 0.1,
    "planDataDTO": {
      "id": 0,
      "source": "string",
      "owner": "string",
      "additionalCriteria": "string",
      "earnedDate": "string",
      "trackSplits": true,
      "isUsingCustomFormula": true,
      "customFormula": {},
      "payeeFilter": true
    },
    "planQuotaDTO": {
      "id": 0,
      "earningMeasure": "string",
      "earningType": "string",
      "rateType": "string",
      "hasRateCard": true,
      "isUsingCustomFormula": true,
      "customFormula": {},
      "defaultCurrency": "string",
      "defaultQuota": 0.1
    },
    "planAcceleratorDTOs": [
      {}
    ],
    "planPaymentDTOs": [
      {}
    ],
    "planPayoutDTO": {
      "id": 0,
      "earningDriver": "string",
      "frequency": "string",
      "defaultPayoutRate": 0.1,
      "useDefaults": "string",
      "lookupTable": "string",
      "lookupColumn": "string",
      "useLookup": "string",
      "isUsingCustomFormula": true,
      "customFormula": {},
      "defaultPayoutRateMode": "None"
    },
    "planQuotaAmountDTO": {
      "id": 0,
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "frequency": "string"
    },
    "planPayeeEffectiveRangeDTO": [
      {}
    ],
    "rateCardConditionDTOs": [
      {}
    ],
    "planComponentCreditCriteriaDTO": {
      "id": 0,
      "planComponentId": 0,
      "sourceFilterDTO": {}
    },
    "basePayoutRateType": "string"
  }
]

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentDTO

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Plan component weight is updated.

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentDTO]

false

none

none

» id

integer(int32)¦null

false

none

none

» planId

integer(int32)

false

none

none

» name

string¦null

false

none

none

» description

string¦null

false

none

none

» type

string¦null

false

none

none

» json

string¦null

false

none

none

» weight

number(double)¦null

false

none

none

» planDataDTO

Varicent.RESTAPI.v1.DTOs.Plans.PlanDataDTO

false

none

none

»» id

integer(int32)¦null

false

none

none

»» source

string¦null

false

none

none

»» owner

string¦null

false

none

none

»» additionalCriteria

string¦null

false

none

none

»» earnedDate

string¦null

false

none

none

»» trackSplits

boolean

false

none

none

»» isUsingCustomFormula

boolean

false

none

none

»» customFormula

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentCustomFormulaDTO

false

none

none

»»» id

integer(int32)¦null

false

none

none

»»» name

string¦null

false

none

none

»»» type

string

false

none

none

»»» planComponentType

string¦null

false

none

none

»»» calculations

[Varicent.RESTAPI.v1.DTOs.NavigationCalculationElementDTO]¦null

false

none

none

»»»» parentBlockId

integer(int32)

false

none

none

»»»» elementId

integer(int32)

false

none

none

»»»» calculationId

integer(int32)

false

none

none

»»»» calculationType

string¦null

false

none

none

»»»» name

string¦null

false

none

none

»»»» comment

string¦null

false

none

none

»»»» isFavourite

boolean

false

none

none

»»»» sourceTables

[string]¦null

false

none

none

»» payeeFilter

boolean

false

none

none

» planQuotaDTO

Varicent.RESTAPI.v1.DTOs.Plans.PlanQuotaDTO

false

none

none

»» id

integer(int32)¦null

false

none

none

»» earningMeasure

string¦null

false

none

none

»» earningType

string¦null

false

none

none

»» rateType

string¦null

false

none

none

»» hasRateCard

boolean

false

none

none

»» isUsingCustomFormula

boolean

false

none

none

»» customFormula

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentCustomFormulaDTO

false

none

none

»» defaultCurrency

string¦null

false

none

none

»» defaultQuota

number(double)

false

none

none

» planAcceleratorDTOs

[Varicent.RESTAPI.v1.DTOs.Plans.PlanAcceleratorDTO]¦null

false

none

none

»» id

integer(int32)¦null

false

none

none

»» minQuota

number(double)

false

none

none

»» maxQuota

number(double)

false

none

none

»» baseAccelerator

number(double)

false

none

none

»» accelerationMethod

string¦null

false

none

none

»» displayTierId

integer(int32)

false

none

none

» planPaymentDTOs

[Varicent.RESTAPI.v1.DTOs.Plans.PlanPaymentDTO]¦null

false

none

none

»» id

integer(int32)¦null

false

none

none

»» percentage

number(double)

false

none

none

»» payPeriodMethod

string¦null

false

none

none

»» releaseMethod

string¦null

false

none

none

»» dataSourceId

string¦null

false

none

none

»» dataField

string¦null

false

none

none

»» dateField

string¦null

false

none

none

»» isLessThanOrEqualTo

string¦null

false

none

none

»» numerator

string¦null

false

none

none

»» denominator

string¦null

false

none

none

»» startDate

string¦null

false

none

none

»» endDate

string¦null

false

none

none

»» frequency

string¦null

false

none

none

»» qualifierType

string¦null

false

none

none

»» releaseType

string¦null

false

none

none

»» conditionValue

string¦null

false

none

none

»» comparisonOperand

string¦null

false

none

none

»» releaseTerm

string¦null

false

none

none

»» planComponentID

integer(int32)

false

none

none

» planPayoutDTO

Varicent.RESTAPI.v1.DTOs.Plans.PlanPayoutDTO

false

none

none

»» id

integer(int32)¦null

false

none

none

»» earningDriver

string¦null

false

none

none

»» frequency

string¦null

false

none

none

»» defaultPayoutRate

number(double)

false

none

none

»» useDefaults

string¦null

false

none

none

»» lookupTable

string¦null

false

none

none

»» lookupColumn

string¦null

false

none

none

»» useLookup

string¦null

false

none

none

»» isUsingCustomFormula

boolean

false

none

none

»» customFormula

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentCustomFormulaDTO

false

none

none

»» defaultPayoutRateMode

string

false

none

none

» planQuotaAmountDTO

Varicent.RESTAPI.v1.DTOs.Plans.PlanQuotaAmountDTO

false

none

none

»» id

integer(int32)¦null

false

none

none

»» startDate

string(date-time)

false

none

none

»» endDate

string(date-time)

false

none

none

»» frequency

string¦null

false

none

none

» planPayeeEffectiveRangeDTO

[Varicent.RESTAPI.v1.DTOs.Plans.PlanPayeeEffectiveRangeDTO]¦null

false

none

none

»» id

integer(int32)¦null

false

none

none

»» quotaCurrency

string¦null

false

none

none

»» basePayoutRate

number(double)

false

none

none

»» startDate

string(date-time)

false

none

none

»» endDate

string(date-time)

false

none

none

»» payeeId

string¦null

false

none

none

»» quotaValue

number(double)

false

none

none

» rateCardConditionDTOs

[RESTAPI.v1.DTOs.Plans.RateCard.RateCardConditionDTO]¦null

false

none

none

»» id

integer(int32)

false

none

none

»» index

integer(int32)

false

none

none

»» name

string¦null

false

none

none

»» multiplier

number(double)

false

none

none

»» rateCardOperators

[RESTAPI.v1.DTOs.Plans.RateCard.RateCardOperatorDTO]¦null

false

none

none

»»» id

integer(int32)

false

none

none

»»» field

string¦null

false

none

none

»»» index

integer(int32)

false

none

none

»»» operatorValuePairs

[RESTAPI.v1.DTOs.Plans.RateCard.RateCardOperatorValueDTO]¦null

false

none

none

»»»» name

string¦null

false

none

none

»»»» value

string¦null

false

none

none

»»»» index

integer(int32)

false

none

none

»»»» rateCardOperatorId

integer(int32)

false

none

none

»»»» type

string

false

none

none

»»» rateCardConditionId

integer(int32)

false

none

none

» planComponentCreditCriteriaDTO

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentCreditCriteriaDTO

false

none

none

»» id

integer(int32)¦null

false

none

none

»» planComponentId

integer(int32)¦null

false

none

none

»» sourceFilterDTO

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterDTO

false

none

none

»»» constraint

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterConstraintDTO

false

none

none

»»»» columnName

string¦null

false

none

none

»»»» operator

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterOperatorDTO

false

none

none

»»»»» type

string

false

none

none

»»»» value

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterValueDTO

false

none

none

»»»»» text

string¦null

false

none

none

»»»»» numeric

number(double)¦null

false

none

none

»»»»» date

string(date-time)¦null

false

none

none

»»»»» special

string¦null

false

none

none

»»»»» valueId

integer(int32)¦null

false

none

none

»»»»» rangeValue

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexRangeValueDTO

false

none

none

»»»»»» min

any

false

none

none

»»»»»» max

any

false

none

none

»»»» caseSensitive

boolean¦null

false

none

none

»»» and

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterAndDTO

false

none

none

»»»» filters

array¦null

false

none

none

»»»»» anonymous

any

false

none

none

»»» or

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterOrDTO

false

none

none

»»»» filters

array¦null

false

none

none

»»»»» anonymous

any

false

none

none

»»» not

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterNotDTO

false

none

none

»»»» filter

any

false

none

none

»»» metadata

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterMetaDataDTO

false

none

none

»»»» additionalProperties

any

false

none

none

» basePayoutRateType

string¦null

false

none

none

Enumerated Values

Property

Value

type

Compensation

type

Credit

type

Quota

defaultPayoutRateMode

None

defaultPayoutRateMode

Default

defaultPayoutRateMode

Lookup

defaultPayoutRateMode

AutoCalculate

type

Text

type

Numeric

type

Date

type

Equals

type

NotEquals

type

LessThan

type

LessThanEquals

type

GreaterThan

type

GreaterThanEquals

type

IsNull

type

IsNotNull

type

Contains

type

NotContains

type

StartWith

type

EndWith

type

InRange

type

InArray

type

NotInArray

special

CurrentWebUser

special

CurrentDate

special

CurrentRowValue

special

WorkflowFormID

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/plans/planComponents/weights", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/planComponents/weights");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "id": 0,
    "planId": 0,
    "name": "string",
    "description": "string",
    "type": "string",
    "json": "string",
    "weight": 0.1,
    "planDataDTO": {
      "id": 0,
      "source": "string",
      "owner": "string",
      "additionalCriteria": "string",
      "earnedDate": "string",
      "trackSplits": true,
      "isUsingCustomFormula": true,
      "customFormula": {},
      "payeeFilter": true
    },
    "planQuotaDTO": {
      "id": 0,
      "earningMeasure": "string",
      "earningType": "string",
      "rateType": "string",
      "hasRateCard": true,
      "isUsingCustomFormula": true,
      "customFormula": {},
      "defaultCurrency": "string",
      "defaultQuota": 0.1
    },
    "planAcceleratorDTOs": [
      {}
    ],
    "planPaymentDTOs": [
      {}
    ],
    "planPayoutDTO": {
      "id": 0,
      "earningDriver": "string",
      "frequency": "string",
      "defaultPayoutRate": 0.1,
      "useDefaults": "string",
      "lookupTable": "string",
      "lookupColumn": "string",
      "useLookup": "string",
      "isUsingCustomFormula": true,
      "customFormula": {},
      "defaultPayoutRateMode": "None"
    },
    "planQuotaAmountDTO": {
      "id": 0,
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "frequency": "string"
    },
    "planPayeeEffectiveRangeDTO": [
      {}
    ],
    "rateCardConditionDTOs": [
      {}
    ],
    "planComponentCreditCriteriaDTO": {
      "id": 0,
      "planComponentId": 0,
      "sourceFilterDTO": {}
    },
    "basePayoutRateType": "string"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plans/planComponents/weights',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/plans/planComponents/weights', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/plans/planComponents/weights',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "planId": 0,
    "name": "string",
    "description": "string",
    "type": "string",
    "json": "string",
    "weight": 0.1,
    "planDataDTO": {
      "id": 0,
      "source": "string",
      "owner": "string",
      "additionalCriteria": "string",
      "earnedDate": "string",
      "trackSplits": true,
      "isUsingCustomFormula": true,
      "customFormula": {},
      "payeeFilter": true
    },
    "planQuotaDTO": {
      "id": 0,
      "earningMeasure": "string",
      "earningType": "string",
      "rateType": "string",
      "hasRateCard": true,
      "isUsingCustomFormula": true,
      "customFormula": {},
      "defaultCurrency": "string",
      "defaultQuota": 0.1
    },
    "planAcceleratorDTOs": [
      {}
    ],
    "planPaymentDTOs": [
      {}
    ],
    "planPayoutDTO": {
      "id": 0,
      "earningDriver": "string",
      "frequency": "string",
      "defaultPayoutRate": 0.1,
      "useDefaults": "string",
      "lookupTable": "string",
      "lookupColumn": "string",
      "useLookup": "string",
      "isUsingCustomFormula": true,
      "customFormula": {},
      "defaultPayoutRateMode": "None"
    },
    "planQuotaAmountDTO": {
      "id": 0,
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "frequency": "string"
    },
    "planPayeeEffectiveRangeDTO": [
      {}
    ],
    "rateCardConditionDTOs": [
      {}
    ],
    "planComponentCreditCriteriaDTO": {
      "id": 0,
      "planComponentId": 0,
      "sourceFilterDTO": {}
    },
    "basePayoutRateType": "string"
  }
]
[{"id":0,"planId":0,"name":"string","description":"string","type":"string","json":"string","weight":0.1,"planDataDTO":{"id":0,"source":"string","owner":"string","additionalCriteria":"string","earnedDate":"string","trackSplits":true,"isUsingCustomFormula":true,"customFormula":{},"payeeFilter":true},"planQuotaDTO":{"id":0,"earningMeasure":"string","earningType":"string","rateType":"string","hasRateCard":true,"isUsingCustomFormula":true,"customFormula":{},"defaultCurrency":"string","defaultQuota":0.1},"planAcceleratorDTOs":[{}],"planPaymentDTOs":[{}],"planPayoutDTO":{"id":0,"earningDriver":"string","frequency":"string","defaultPayoutRate":0.1,"useDefaults":"string","lookupTable":"string","lookupColumn":"string","useLookup":"string","isUsingCustomFormula":true,"customFormula":{},"defaultPayoutRateMode":"None"},"planQuotaAmountDTO":{"id":0,"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","frequency":"string"},"planPayeeEffectiveRangeDTO":[{}],"rateCardConditionDTOs":[{}],"planComponentCreditCriteriaDTO":{"id":0,"planComponentId":0,"sourceFilterDTO":{}},"basePayoutRateType":"string"}]

Performance

Get batches.

Parameters

Name

In

Type

Required

Description

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

orderBy

query

string

false

####Description

filter

query

string

false

####Supported operations

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

start, batchid, status, duration, type, incremental, calcscount

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

start, batchid, type, incremental

Responses

Status

Meaning

Description

Schema

200

OK

Get all Batches (limit, offset, date order, filter supported)

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.BatchItemDTO]

false

none

none

» batchId

integer(int32)

false

none

none

» status

string

false

none

none

» start

string(date-time)

false

none

none

» end

string(date-time)

false

none

none

» duration

string(date-span)

false

none

none

» computationEvents

[Varicent.RESTAPI.v1.DTOs.ComputationLogEventDTO]¦null

false

none

none

»» batchId

integer(int32)

false

none

none

»» computationEventId

integer(int32)

false

none

none

»» name

string¦null

false

none

none

»» runningTime

integer(int32)

false

none

none

»» finished

boolean

false

none

none

»» calcId

integer(int32)

false

none

none

»» calcMethod

string¦null

false

none

none

»» status

string¦null

false

none

none

»» syncRunningTime

integer(int32)

false

none

none

»» skipped

boolean

false

none

none

»» details

[Varicent.RESTAPI.v1.DTOs.ComputationLogEventDetailDTO]¦null

false

none

none

»»» computationEventId

integer(int32)

false

none

none

»»» value

integer(int32)

false

none

none

»»» start

string(date-time)

false

none

none

»»» end

string(date-time)

false

none

none

»»» processId

integer(int32)

false

none

none

»»» taskType

integer(int32)

false

none

none

»»» period

string¦null

false

none

none

»» start

string(date-time)¦null

false

read-only

none

»» end

string(date-time)¦null

false

read-only

none

»» duration

string(date-span)

false

read-only

none

»» syncDuration

string(date-span)

false

read-only

none

» type

string

false

none

none

» clientVersion

string¦null

false

none

none

» databaseVersion

integer(int32)

false

none

none

» incremental

string

false

none

none

» calculationsCount

integer(int32)

false

none

none

Enumerated Values

Property

Value

status

Started

status

Success

status

Error

status

Cancelled

status

None

type

All

type

PlanIncludingReports

type

PlanEarnings

type

TailoredReports

type

Payee

type

WebForms

type

PresenterReports

type

Workspace

type

IndividualCalculation

type

SelectedCalculations

type

EltFull

type

EltIndividualCalculationWithDep

type

EltIndividualCalculationWithoutDep

type

None

incremental

No

incremental

Yes

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/performancebatches", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/performancebatches");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/performancebatches',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/performancebatches', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/performancebatches',
  params: {
  }, headers: headers

p JSON.parse(result)

Get calculations by Calc Performance ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Identifier of the calculation performance item for which calculations are retrieved.

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

orderBy

query

string

false

####Description

filter

query

string

false

####Supported operations

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

calcid, status, start, end, duration, method, calcname

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

computationid, calcid, status, start, end, duration, method, calcname

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.ListViewRowDTO]

false

none

none

» compId

integer(int32)

false

none

none

» start

string(date-time)¦null

false

none

none

» end

string(date-time)¦null

false

none

none

» duration

string¦null

false

none

none

» inc

string¦null

false

none

none

» calcType

string¦null

false

none

none

» status

string¦null

false

none

none

» numOfCalcs

integer(int32)¦null

false

none

none

» calcId

integer(int32)

false

none

none

» method

string¦null

false

none

none

» calcName

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/performancebatches/{id}/calculations", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/performancebatches/{id}/calculations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/performancebatches/{id}/calculations',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/performancebatches/{id}/calculations', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/performancebatches/{id}/calculations',
  params: {
  }, headers: headers

p JSON.parse(result)

Get batches with calculation by Calculation ID.

Parameters

Name

In

Type

Required

Description

calcid

path

integer(int32)

true

Calculation Id

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

orderBy

query

string

false

####Description

filter

query

string

false

####Supported operations

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

start, batchid, status, duration, type, incremental, calcscount

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

start, batchid, status, type, incremental

Responses

Status

Meaning

Description

Schema

200

OK

Get all Batches that have Calculation with given Calculation ID (limit, offset, date order, filter supported)

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.ComputationLogEventDTO]

false

none

none

» batchId

integer(int32)

false

none

none

» computationEventId

integer(int32)

false

none

none

» name

string¦null

false

none

none

» runningTime

integer(int32)

false

none

none

» finished

boolean

false

none

none

» calcId

integer(int32)

false

none

none

» calcMethod

string¦null

false

none

none

» status

string¦null

false

none

none

» syncRunningTime

integer(int32)

false

none

none

» skipped

boolean

false

none

none

» details

[Varicent.RESTAPI.v1.DTOs.ComputationLogEventDetailDTO]¦null

false

none

none

»» computationEventId

integer(int32)

false

none

none

»» value

integer(int32)

false

none

none

»» start

string(date-time)

false

none

none

»» end

string(date-time)

false

none

none

»» processId

integer(int32)

false

none

none

»» taskType

integer(int32)

false

none

none

»» period

string¦null

false

none

none

» start

string(date-time)¦null

false

read-only

none

» end

string(date-time)¦null

false

read-only

none

» duration

string(date-span)

false

read-only

none

» syncDuration

string(date-span)

false

read-only

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/calculations/{calcid}/batches", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/calculations/{calcid}/batches");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/calculations/{calcid}/batches',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/calculations/{calcid}/batches', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/calculations/{calcid}/batches',
  params: {
  }, headers: headers

p JSON.parse(result)

Process List

Get process lists.

Parameters

Name

In

Type

Required

Description

filter

query

string

false

####Supported operations

orderBy

query

string

false

####Description

Detailed descriptions

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

name

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

name

Responses

Status

Meaning

Description

Schema

200

OK

Get all process lists

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.ProcessListDTO]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» description

string¦null

false

none

none

» type

string

false

none

none

» order

integer(int32)

false

none

none

» processMapTasks

[Varicent.RESTAPI.v1.DTOs.ProcessListTaskDTO]¦null

false

none

none

»» id

integer(int32)

false

none

none

»» processMapId

integer(int32)

false

none

none

»» parent

integer(int32)¦null

false

none

none

»» order

integer(int32)

false

none

none

»» name

string¦null

false

none

none

»» description

string¦null

false

none

none

»» linkName

string¦null

false

none

none

»» user

string¦null

false

none

none

»» status

string

false

none

none

»» completionDate

string(date-time)¦null

false

none

none

»» children

array¦null

false

none

none

»»» anonymous

any

false

none

none

»» varicentUrl

Varicent.RESTAPI.v1.DTOs.VaricentUrlDTO

false

none

none

»»» moduleType

string

false

none

none

»»» actionType

string

false

none

none

»»» elementType

string

false

none

none

»»» moduleTab

string¦null

false

none

none

»»» args

object¦null

false

none

none

»»»» additionalProperties

string¦null

false

none

none

»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»» rowVersion

integer(int64)

false

none

none

»» isValid

boolean¦null

false

none

none

»» showDetails

boolean

false

none

none

»» editTask

boolean

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

type

Ordered

type

Perpetual

status

NotStarted

status

Completed

moduleType

home

moduleType

composer

moduleType

workflow

moduleType

scheduler

moduleType

taskmanager

moduleType

audit

moduleType

payeeledger

moduleType

webforms

moduleType

presenter

moduleType

rowviewer

moduleType

hierarchy

moduleType

calcviewer

moduleType

calculate

moduleType

payeegroups

moduleType

migration

moduleType

localsavedimport

moduleType

remotesavedimport

moduleType

savedpublication

moduleType

portviewer

moduleType

scenarios

moduleType

viewPR

moduleType

progress

moduleType

runSchedulerProcess

moduleType

BPM

moduleType

NonInteractive

moduleType

compPlanManager

moduleType

rapidreports

moduleType

adaptive

moduleType

adaptiveforms

moduleType

plans

moduleType

data

moduleType

people

moduleType

processList

moduleType

manageFile

actionType

None

actionType

Cut

actionType

Copy

actionType

Delete

actionType

Select

actionType

Edit

actionType

Wrap

actionType

ViewUsedByTree

actionType

ViewUsesTree

actionType

UsedBy

actionType

TableEditDescription

actionType

TableAddInputForm

actionType

TableEditInputForm

actionType

TableEditValidationRules

actionType

TableDeleteInputForm

actionType

TableMakeEffectiveDated

actionType

TableImport

actionType

TableDeleteRows

actionType

TableClear

actionType

TableTransform

actionType

TablePurgeHistory

actionType

TableToggleTrackHistory

actionType

TableToggleGlobal

actionType

TableEditWebDataEditPermissions

actionType

TableEditWebDataRestrictions

actionType

TableEditWebDataApproveReject

actionType

TableToggleDirectEdit

actionType

Publish

actionType

CalculationPreview

actionType

CalculationCurrentValue

actionType

CalculationHistory

actionType

CalculationMethod

actionType

PresenterView

actionType

ComponentView

actionType

ComponentUnwrap

actionType

ComponentEditConnections

actionType

ComponentAddInboundConnection

actionType

ComponentAddOutboundConnection

actionType

ComponentManageLinks

actionType

ComponentManageDocuments

actionType

AdaptivePresenterView

actionType

AdaptiveFormView

elementType

none

elementType

table

elementType

presenter

elementType

webform

elementType

calculation

elementType

datastore

elementType

component

elementType

adaptive

elementType

adaptiveform

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/processlists", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/processlists");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/processlists',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/processlists', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/processlists',
  params: {
  }, headers: headers

p JSON.parse(result)

ProcessListsControllerV1_Post

Body parameter

{
  "id": 0,
  "name": "string",
  "description": "string",
  "type": "Ordered",
  "order": 0,
  "processMapTasks": [
    {
      "id": 0,
      "processMapId": 0,
      "parent": 0,
      "order": 0,
      "name": "string",
      "description": "string",
      "linkName": "string",
      "user": "string",
      "status": "NotStarted",
      "completionDate": "2019-08-24T14:15:22Z",
      "children": [],
      "varicentUrl": {},
      "rowVersion": {},
      "isValid": true,
      "showDetails": true,
      "editTask": true
    }
  ],
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.ProcessListDTO

false

none

» id

body

integer(int32)

false

none

» name

body

string¦null

false

none

» description

body

string¦null

false

none

» type

body

string

false

none

» order

body

integer(int32)

false

none

» processMapTasks

body

[Varicent.RESTAPI.v1.DTOs.ProcessListTaskDTO]¦null

false

none

»» id

body

integer(int32)

false

none

»» processMapId

body

integer(int32)

false

none

»» parent

body

integer(int32)¦null

false

none

»» order

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» description

body

string¦null

false

none

»» linkName

body

string¦null

false

none

»» user

body

string¦null

false

none

»» status

body

string

false

none

»» completionDate

body

string(date-time)¦null

false

none

»» children

body

array¦null

false

none

»»» anonymous

body

any

false

none

»» varicentUrl

body

Varicent.RESTAPI.v1.DTOs.VaricentUrlDTO

false

none

»»» moduleType

body

string

false

none

»»» actionType

body

string

false

none

»»» elementType

body

string

false

none

»»» moduleTab

body

string¦null

false

none

»»» args

body

object¦null

false

none

»»»» additionalProperties

body

string¦null

false

none

»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» rowVersion

body

integer(int64)

false

none

»» isValid

body

boolean¦null

false

none

»» showDetails

body

boolean

false

none

»» editTask

body

boolean

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

» type

Ordered

» type

Perpetual

»» status

NotStarted

»» status

Completed

»»» moduleType

home

»»» moduleType

composer

»»» moduleType

workflow

»»» moduleType

scheduler

»»» moduleType

taskmanager

»»» moduleType

audit

»»» moduleType

payeeledger

»»» moduleType

webforms

»»» moduleType

presenter

»»» moduleType

rowviewer

»»» moduleType

hierarchy

»»» moduleType

calcviewer

»»» moduleType

calculate

»»» moduleType

payeegroups

»»» moduleType

migration

»»» moduleType

localsavedimport

»»» moduleType

remotesavedimport

»»» moduleType

savedpublication

»»» moduleType

portviewer

»»» moduleType

scenarios

»»» moduleType

viewPR

»»» moduleType

progress

»»» moduleType

runSchedulerProcess

»»» moduleType

BPM

»»» moduleType

NonInteractive

»»» moduleType

compPlanManager

»»» moduleType

rapidreports

»»» moduleType

adaptive

»»» moduleType

adaptiveforms

»»» moduleType

plans

»»» moduleType

data

»»» moduleType

people

»»» moduleType

processList

»»» moduleType

manageFile

»»» actionType

None

»»» actionType

Cut

»»» actionType

Copy

»»» actionType

Delete

»»» actionType

Select

»»» actionType

Edit

»»» actionType

Wrap

»»» actionType

ViewUsedByTree

»»» actionType

ViewUsesTree

»»» actionType

UsedBy

»»» actionType

TableEditDescription

»»» actionType

TableAddInputForm

»»» actionType

TableEditInputForm

»»» actionType

TableEditValidationRules

»»» actionType

TableDeleteInputForm

»»» actionType

TableMakeEffectiveDated

»»» actionType

TableImport

»»» actionType

TableDeleteRows

»»» actionType

TableClear

»»» actionType

TableTransform

»»» actionType

TablePurgeHistory

»»» actionType

TableToggleTrackHistory

»»» actionType

TableToggleGlobal

»»» actionType

TableEditWebDataEditPermissions

»»» actionType

TableEditWebDataRestrictions

»»» actionType

TableEditWebDataApproveReject

»»» actionType

TableToggleDirectEdit

»»» actionType

Publish

»»» actionType

CalculationPreview

»»» actionType

CalculationCurrentValue

»»» actionType

CalculationHistory

»»» actionType

CalculationMethod

»»» actionType

PresenterView

»»» actionType

ComponentView

»»» actionType

ComponentUnwrap

»»» actionType

ComponentEditConnections

»»» actionType

ComponentAddInboundConnection

»»» actionType

ComponentAddOutboundConnection

»»» actionType

ComponentManageLinks

»»» actionType

ComponentManageDocuments

»»» actionType

AdaptivePresenterView

»»» actionType

AdaptiveFormView

»»» elementType

none

»»» elementType

table

»»» elementType

presenter

»»» elementType

webform

»»» elementType

calculation

»»» elementType

datastore

»»» elementType

component

»»» elementType

adaptive

»»» elementType

adaptiveform

Responses

Status

Meaning

Description

Schema

200

OK

Create a new process list

Varicent.RESTAPI.v1.DTOs.ProcessListDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/processlists", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/processlists");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "name": "string",
  "description": "string",
  "type": "Ordered",
  "order": 0,
  "processMapTasks": [
    {
      "id": 0,
      "processMapId": 0,
      "parent": 0,
      "order": 0,
      "name": "string",
      "description": "string",
      "linkName": "string",
      "user": "string",
      "status": "NotStarted",
      "completionDate": "2019-08-24T14:15:22Z",
      "children": [],
      "varicentUrl": {},
      "rowVersion": {},
      "isValid": true,
      "showDetails": true,
      "editTask": true
    }
  ],
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/processlists',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/processlists', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/processlists',
  params: {
  }, headers: headers

p JSON.parse(result)

ProcessListsControllerV1_PutAll

Body parameter

[
  {
    "id": 0,
    "name": "string",
    "description": "string",
    "type": "Ordered",
    "order": 0,
    "processMapTasks": [
      {}
    ],
    "version": {
      "rowVersion": 0
    }
  }
]

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.ProcessListDTO

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Update all process lists

Inline

400

Bad Request

Bad Request

None

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.ProcessListDTO]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» description

string¦null

false

none

none

» type

string

false

none

none

» order

integer(int32)

false

none

none

» processMapTasks

[Varicent.RESTAPI.v1.DTOs.ProcessListTaskDTO]¦null

false

none

none

»» id

integer(int32)

false

none

none

»» processMapId

integer(int32)

false

none

none

»» parent

integer(int32)¦null

false

none

none

»» order

integer(int32)

false

none

none

»» name

string¦null

false

none

none

»» description

string¦null

false

none

none

»» linkName

string¦null

false

none

none

»» user

string¦null

false

none

none

»» status

string

false

none

none

»» completionDate

string(date-time)¦null

false

none

none

»» children

array¦null

false

none

none

»»» anonymous

any

false

none

none

»» varicentUrl

Varicent.RESTAPI.v1.DTOs.VaricentUrlDTO

false

none

none

»»» moduleType

string

false

none

none

»»» actionType

string

false

none

none

»»» elementType

string

false

none

none

»»» moduleTab

string¦null

false

none

none

»»» args

object¦null

false

none

none

»»»» additionalProperties

string¦null

false

none

none

»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»» rowVersion

integer(int64)

false

none

none

»» isValid

boolean¦null

false

none

none

»» showDetails

boolean

false

none

none

»» editTask

boolean

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

type

Ordered

type

Perpetual

status

NotStarted

status

Completed

moduleType

home

moduleType

composer

moduleType

workflow

moduleType

scheduler

moduleType

taskmanager

moduleType

audit

moduleType

payeeledger

moduleType

webforms

moduleType

presenter

moduleType

rowviewer

moduleType

hierarchy

moduleType

calcviewer

moduleType

calculate

moduleType

payeegroups

moduleType

migration

moduleType

localsavedimport

moduleType

remotesavedimport

moduleType

savedpublication

moduleType

portviewer

moduleType

scenarios

moduleType

viewPR

moduleType

progress

moduleType

runSchedulerProcess

moduleType

BPM

moduleType

NonInteractive

moduleType

compPlanManager

moduleType

rapidreports

moduleType

adaptive

moduleType

adaptiveforms

moduleType

plans

moduleType

data

moduleType

people

moduleType

processList

moduleType

manageFile

actionType

None

actionType

Cut

actionType

Copy

actionType

Delete

actionType

Select

actionType

Edit

actionType

Wrap

actionType

ViewUsedByTree

actionType

ViewUsesTree

actionType

UsedBy

actionType

TableEditDescription

actionType

TableAddInputForm

actionType

TableEditInputForm

actionType

TableEditValidationRules

actionType

TableDeleteInputForm

actionType

TableMakeEffectiveDated

actionType

TableImport

actionType

TableDeleteRows

actionType

TableClear

actionType

TableTransform

actionType

TablePurgeHistory

actionType

TableToggleTrackHistory

actionType

TableToggleGlobal

actionType

TableEditWebDataEditPermissions

actionType

TableEditWebDataRestrictions

actionType

TableEditWebDataApproveReject

actionType

TableToggleDirectEdit

actionType

Publish

actionType

CalculationPreview

actionType

CalculationCurrentValue

actionType

CalculationHistory

actionType

CalculationMethod

actionType

PresenterView

actionType

ComponentView

actionType

ComponentUnwrap

actionType

ComponentEditConnections

actionType

ComponentAddInboundConnection

actionType

ComponentAddOutboundConnection

actionType

ComponentManageLinks

actionType

ComponentManageDocuments

actionType

AdaptivePresenterView

actionType

AdaptiveFormView

elementType

none

elementType

table

elementType

presenter

elementType

webform

elementType

calculation

elementType

datastore

elementType

component

elementType

adaptive

elementType

adaptiveform

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/processlists", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/processlists");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "id": 0,
    "name": "string",
    "description": "string",
    "type": "Ordered",
    "order": 0,
    "processMapTasks": [
      {}
    ],
    "version": {
      "rowVersion": 0
    }
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/processlists',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/processlists', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/processlists',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "name": "string",
    "description": "string",
    "type": "Ordered",
    "order": 0,
    "processMapTasks": [
      {}
    ],
    "version": {
      "rowVersion": 0
    }
  }
]
[{"id":0,"name":"string","description":"string","type":"Ordered","order":0,"processMapTasks":[{}],"version":{"rowVersion":0}}]

ProcessListsControllerV1_Get

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get process list by id

Varicent.RESTAPI.v1.DTOs.ProcessListDTO

404

Not Found

Not Found

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/processlists/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/processlists/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/processlists/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/processlists/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/processlists/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "description": "string",
  "type": "Ordered",
  "order": 0,
  "processMapTasks": [
    {
      "id": 0,
      "processMapId": 0,
      "parent": 0,
      "order": 0,
      "name": "string",
      "description": "string",
      "linkName": "string",
      "user": "string",
      "status": "NotStarted",
      "completionDate": "2019-08-24T14:15:22Z",
      "children": [],
      "varicentUrl": {},
      "rowVersion": {},
      "isValid": true,
      "showDetails": true,
      "editTask": true
    }
  ],
  "version": {
    "rowVersion": 0
  }
}
{"id":0,"name":"string","description":"string","type":"Ordered","order":0,"processMapTasks":[{"id":0,"processMapId":0,"parent":0,"order":0,"name":"string","description":"string","linkName":"string","user":"string","status":"NotStarted","completionDate":"2019-08-24T14:15:22Z","children":[],"varicentUrl":{},"rowVersion":{},"isValid":true,"showDetails":true,"editTask":true}],"version":{"rowVersion":0}}

ProcessListsControllerV1_Put

Body parameter

{
  "id": 0,
  "name": "string",
  "description": "string",
  "type": "Ordered",
  "order": 0,
  "processMapTasks": [
    {
      "id": 0,
      "processMapId": 0,
      "parent": 0,
      "order": 0,
      "name": "string",
      "description": "string",
      "linkName": "string",
      "user": "string",
      "status": "NotStarted",
      "completionDate": "2019-08-24T14:15:22Z",
      "children": [],
      "varicentUrl": {},
      "rowVersion": {},
      "isValid": true,
      "showDetails": true,
      "editTask": true
    }
  ],
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.ProcessListDTO

false

none

» id

body

integer(int32)

false

none

» name

body

string¦null

false

none

» description

body

string¦null

false

none

» type

body

string

false

none

» order

body

integer(int32)

false

none

» processMapTasks

body

[Varicent.RESTAPI.v1.DTOs.ProcessListTaskDTO]¦null

false

none

»» id

body

integer(int32)

false

none

»» processMapId

body

integer(int32)

false

none

»» parent

body

integer(int32)¦null

false

none

»» order

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» description

body

string¦null

false

none

»» linkName

body

string¦null

false

none

»» user

body

string¦null

false

none

»» status

body

string

false

none

»» completionDate

body

string(date-time)¦null

false

none

»» children

body

array¦null

false

none

»»» anonymous

body

any

false

none

»» varicentUrl

body

Varicent.RESTAPI.v1.DTOs.VaricentUrlDTO

false

none

»»» moduleType

body

string

false

none

»»» actionType

body

string

false

none

»»» elementType

body

string

false

none

»»» moduleTab

body

string¦null

false

none

»»» args

body

object¦null

false

none

»»»» additionalProperties

body

string¦null

false

none

»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» rowVersion

body

integer(int64)

false

none

»» isValid

body

boolean¦null

false

none

»» showDetails

body

boolean

false

none

»» editTask

body

boolean

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

» type

Ordered

» type

Perpetual

»» status

NotStarted

»» status

Completed

»»» moduleType

home

»»» moduleType

composer

»»» moduleType

workflow

»»» moduleType

scheduler

»»» moduleType

taskmanager

»»» moduleType

audit

»»» moduleType

payeeledger

»»» moduleType

webforms

»»» moduleType

presenter

»»» moduleType

rowviewer

»»» moduleType

hierarchy

»»» moduleType

calcviewer

»»» moduleType

calculate

»»» moduleType

payeegroups

»»» moduleType

migration

»»» moduleType

localsavedimport

»»» moduleType

remotesavedimport

»»» moduleType

savedpublication

»»» moduleType

portviewer

»»» moduleType

scenarios

»»» moduleType

viewPR

»»» moduleType

progress

»»» moduleType

runSchedulerProcess

»»» moduleType

BPM

»»» moduleType

NonInteractive

»»» moduleType

compPlanManager

»»» moduleType

rapidreports

»»» moduleType

adaptive

»»» moduleType

adaptiveforms

»»» moduleType

plans

»»» moduleType

data

»»» moduleType

people

»»» moduleType

processList

»»» moduleType

manageFile

»»» actionType

None

»»» actionType

Cut

»»» actionType

Copy

»»» actionType

Delete

»»» actionType

Select

»»» actionType

Edit

»»» actionType

Wrap

»»» actionType

ViewUsedByTree

»»» actionType

ViewUsesTree

»»» actionType

UsedBy

»»» actionType

TableEditDescription

»»» actionType

TableAddInputForm

»»» actionType

TableEditInputForm

»»» actionType

TableEditValidationRules

»»» actionType

TableDeleteInputForm

»»» actionType

TableMakeEffectiveDated

»»» actionType

TableImport

»»» actionType

TableDeleteRows

»»» actionType

TableClear

»»» actionType

TableTransform

»»» actionType

TablePurgeHistory

»»» actionType

TableToggleTrackHistory

»»» actionType

TableToggleGlobal

»»» actionType

TableEditWebDataEditPermissions

»»» actionType

TableEditWebDataRestrictions

»»» actionType

TableEditWebDataApproveReject

»»» actionType

TableToggleDirectEdit

»»» actionType

Publish

»»» actionType

CalculationPreview

»»» actionType

CalculationCurrentValue

»»» actionType

CalculationHistory

»»» actionType

CalculationMethod

»»» actionType

PresenterView

»»» actionType

ComponentView

»»» actionType

ComponentUnwrap

»»» actionType

ComponentEditConnections

»»» actionType

ComponentAddInboundConnection

»»» actionType

ComponentAddOutboundConnection

»»» actionType

ComponentManageLinks

»»» actionType

ComponentManageDocuments

»»» actionType

AdaptivePresenterView

»»» actionType

AdaptiveFormView

»»» elementType

none

»»» elementType

table

»»» elementType

presenter

»»» elementType

webform

»»» elementType

calculation

»»» elementType

datastore

»»» elementType

component

»»» elementType

adaptive

»»» elementType

adaptiveform

Responses

Status

Meaning

Description

Schema

200

OK

Update an existing process list by ID. ID must match ID of body

Varicent.RESTAPI.v1.DTOs.ProcessListDTO

400

Bad Request

Bad Request

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/processlists/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/processlists/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "name": "string",
  "description": "string",
  "type": "Ordered",
  "order": 0,
  "processMapTasks": [
    {
      "id": 0,
      "processMapId": 0,
      "parent": 0,
      "order": 0,
      "name": "string",
      "description": "string",
      "linkName": "string",
      "user": "string",
      "status": "NotStarted",
      "completionDate": "2019-08-24T14:15:22Z",
      "children": [],
      "varicentUrl": {},
      "rowVersion": {},
      "isValid": true,
      "showDetails": true,
      "editTask": true
    }
  ],
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/processlists/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/processlists/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/processlists/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

ProcessListsControllerV1_Delete

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Delete process list by ID

string

404

Not Found

Not Found

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/processlists/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/processlists/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/processlists/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('http://localhost:8080/api/v1/processlists/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.delete 'http://localhost:8080/api/v1/processlists/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
"string"
"string"

ProcessListsControllerV2_PostProcessListsTask

Body parameter

{
  "id": 0,
  "processMapId": 0,
  "parent": 0,
  "order": 0,
  "name": "string",
  "description": "string",
  "linkName": "string",
  "user": "string",
  "status": "NotStarted",
  "completionDate": "2019-08-24T14:15:22Z",
  "children": [],
  "varicentUrl": {
    "moduleType": "home",
    "actionType": "None",
    "elementType": "none",
    "moduleTab": "string",
    "args": {
      "property1": "string",
      "property2": "string"
    }
  },
  "rowVersion": {
    "rowVersion": 0
  },
  "isValid": true,
  "showDetails": true,
  "editTask": true
}

Parameters

Name

In

Type

Required

Description

processListId

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.ProcessListTaskDTO

false

none

» id

body

integer(int32)

false

none

» processMapId

body

integer(int32)

false

none

» parent

body

integer(int32)¦null

false

none

» order

body

integer(int32)

false

none

» name

body

string¦null

false

none

» description

body

string¦null

false

none

» linkName

body

string¦null

false

none

» user

body

string¦null

false

none

» status

body

string

false

none

» completionDate

body

string(date-time)¦null

false

none

» children

body

array¦null

false

none

»» anonymous

body

any

false

none

» varicentUrl

body

Varicent.RESTAPI.v1.DTOs.VaricentUrlDTO

false

none

»» moduleType

body

string

false

none

»» actionType

body

string

false

none

»» elementType

body

string

false

none

»» moduleTab

body

string¦null

false

none

»» args

body

object¦null

false

none

»»» additionalProperties

body

string¦null

false

none

» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

» isValid

body

boolean¦null

false

none

» showDetails

body

boolean

false

none

» editTask

body

boolean

false

none

Enumerated Values

Parameter

Value

» status

NotStarted

» status

Completed

»» moduleType

home

»» moduleType

composer

»» moduleType

workflow

»» moduleType

scheduler

»» moduleType

taskmanager

»» moduleType

audit

»» moduleType

payeeledger

»» moduleType

webforms

»» moduleType

presenter

»» moduleType

rowviewer

»» moduleType

hierarchy

»» moduleType

calcviewer

»» moduleType

calculate

»» moduleType

payeegroups

»» moduleType

migration

»» moduleType

localsavedimport

»» moduleType

remotesavedimport

»» moduleType

savedpublication

»» moduleType

portviewer

»» moduleType

scenarios

»» moduleType

viewPR

»» moduleType

progress

»» moduleType

runSchedulerProcess

»» moduleType

BPM

»» moduleType

NonInteractive

»» moduleType

compPlanManager

»» moduleType

rapidreports

»» moduleType

adaptive

»» moduleType

adaptiveforms

»» moduleType

plans

»» moduleType

data

»» moduleType

people

»» moduleType

processList

»» moduleType

manageFile

»» actionType

None

»» actionType

Cut

»» actionType

Copy

»» actionType

Delete

»» actionType

Select

»» actionType

Edit

»» actionType

Wrap

»» actionType

ViewUsedByTree

»» actionType

ViewUsesTree

»» actionType

UsedBy

»» actionType

TableEditDescription

»» actionType

TableAddInputForm

»» actionType

TableEditInputForm

»» actionType

TableEditValidationRules

»» actionType

TableDeleteInputForm

»» actionType

TableMakeEffectiveDated

»» actionType

TableImport

»» actionType

TableDeleteRows

»» actionType

TableClear

»» actionType

TableTransform

»» actionType

TablePurgeHistory

»» actionType

TableToggleTrackHistory

»» actionType

TableToggleGlobal

»» actionType

TableEditWebDataEditPermissions

»» actionType

TableEditWebDataRestrictions

»» actionType

TableEditWebDataApproveReject

»» actionType

TableToggleDirectEdit

»» actionType

Publish

»» actionType

CalculationPreview

»» actionType

CalculationCurrentValue

»» actionType

CalculationHistory

»» actionType

CalculationMethod

»» actionType

PresenterView

»» actionType

ComponentView

»» actionType

ComponentUnwrap

»» actionType

ComponentEditConnections

»» actionType

ComponentAddInboundConnection

»» actionType

ComponentAddOutboundConnection

»» actionType

ComponentManageLinks

»» actionType

ComponentManageDocuments

»» actionType

AdaptivePresenterView

»» actionType

AdaptiveFormView

»» elementType

none

»» elementType

table

»» elementType

presenter

»» elementType

webform

»» elementType

calculation

»» elementType

datastore

»» elementType

component

»» elementType

adaptive

»» elementType

adaptiveform

Responses

Status

Meaning

Description

Schema

200

OK

Create a new process list task.

Varicent.RESTAPI.v1.DTOs.ProcessListDTO

400

Bad Request

Bad Request

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v2/processlists/{processListId}/tasks", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v2/processlists/{processListId}/tasks");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "processMapId": 0,
  "parent": 0,
  "order": 0,
  "name": "string",
  "description": "string",
  "linkName": "string",
  "user": "string",
  "status": "NotStarted",
  "completionDate": "2019-08-24T14:15:22Z",
  "children": [],
  "varicentUrl": {
    "moduleType": "home",
    "actionType": "None",
    "elementType": "none",
    "moduleTab": "string",
    "args": {
      "property1": "string",
      "property2": "string"
    }
  },
  "rowVersion": {
    "rowVersion": 0
  },
  "isValid": true,
  "showDetails": true,
  "editTask": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v2/processlists/{processListId}/tasks',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v2/processlists/{processListId}/tasks', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v2/processlists/{processListId}/tasks',
  params: {
  }, headers: headers

p JSON.parse(result)

ProcessListsControllerV2_PatchProcessListsTasks

Body parameter

[
  {
    "id": 0,
    "processMapId": 0,
    "parent": 0,
    "order": 0,
    "name": "string",
    "description": "string",
    "linkName": "string",
    "user": "string",
    "status": "NotStarted",
    "completionDate": "2019-08-24T14:15:22Z",
    "children": [],
    "varicentUrl": {
      "moduleType": "home",
      "actionType": "None",
      "elementType": "none",
      "moduleTab": "string",
      "args": {}
    },
    "rowVersion": {
      "rowVersion": 0
    },
    "isValid": true,
    "showDetails": true,
    "editTask": true
  }
]

Parameters

Name

In

Type

Required

Description

processListId

path

integer(int32)

true

none

isReset

query

boolean

false

none

isDrag

query

boolean

false

none

body

body

Varicent.RESTAPI.v1.DTOs.ProcessListTaskDTO

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Update an existing process list tasks.

Varicent.RESTAPI.v1.DTOs.ProcessListDTO

400

Bad Request

Bad Request

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v2/processlists/{processListId}/tasks", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v2/processlists/{processListId}/tasks");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "id": 0,
    "processMapId": 0,
    "parent": 0,
    "order": 0,
    "name": "string",
    "description": "string",
    "linkName": "string",
    "user": "string",
    "status": "NotStarted",
    "completionDate": "2019-08-24T14:15:22Z",
    "children": [],
    "varicentUrl": {
      "moduleType": "home",
      "actionType": "None",
      "elementType": "none",
      "moduleTab": "string",
      "args": {}
    },
    "rowVersion": {
      "rowVersion": 0
    },
    "isValid": true,
    "showDetails": true,
    "editTask": true
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v2/processlists/{processListId}/tasks',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v2/processlists/{processListId}/tasks', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v2/processlists/{processListId}/tasks',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "description": "string",
  "type": "Ordered",
  "order": 0,
  "processMapTasks": [
    {
      "id": 0,
      "processMapId": 0,
      "parent": 0,
      "order": 0,
      "name": "string",
      "description": "string",
      "linkName": "string",
      "user": "string",
      "status": "NotStarted",
      "completionDate": "2019-08-24T14:15:22Z",
      "children": [],
      "varicentUrl": {},
      "rowVersion": {},
      "isValid": true,
      "showDetails": true,
      "editTask": true
    }
  ],
  "version": {
    "rowVersion": 0
  }
}
{"id":0,"name":"string","description":"string","type":"Ordered","order":0,"processMapTasks":[{"id":0,"processMapId":0,"parent":0,"order":0,"name":"string","description":"string","linkName":"string","user":"string","status":"NotStarted","completionDate":"2019-08-24T14:15:22Z","children":[],"varicentUrl":{},"rowVersion":{},"isValid":true,"showDetails":true,"editTask":true}],"version":{"rowVersion":0}}

ProcessListsControllerV2_DeleteProcessListsTask

Parameters

Name

In

Type

Required

Description

processListId

path

integer(int32)

true

none

taskId

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Delete an existing process list task.

Varicent.RESTAPI.v1.DTOs.ProcessListDTO

400

Bad Request

Bad Request

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v2/processlists/{processListId}/tasks/{taskId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v2/processlists/{processListId}/tasks/{taskId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v2/processlists/{processListId}/tasks/{taskId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('http://localhost:8080/api/v2/processlists/{processListId}/tasks/{taskId}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.delete 'http://localhost:8080/api/v2/processlists/{processListId}/tasks/{taskId}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "description": "string",
  "type": "Ordered",
  "order": 0,
  "processMapTasks": [
    {
      "id": 0,
      "processMapId": 0,
      "parent": 0,
      "order": 0,
      "name": "string",
      "description": "string",
      "linkName": "string",
      "user": "string",
      "status": "NotStarted",
      "completionDate": "2019-08-24T14:15:22Z",
      "children": [],
      "varicentUrl": {},
      "rowVersion": {},
      "isValid": true,
      "showDetails": true,
      "editTask": true
    }
  ],
  "version": {
    "rowVersion": 0
  }
}
{"id":0,"name":"string","description":"string","type":"Ordered","order":0,"processMapTasks":[{"id":0,"processMapId":0,"parent":0,"order":0,"name":"string","description":"string","linkName":"string","user":"string","status":"NotStarted","completionDate":"2019-08-24T14:15:22Z","children":[],"varicentUrl":{},"rowVersion":{},"isValid":true,"showDetails":true,"editTask":true}],"version":{"rowVersion":0}}

Publisher

Get all publication images.

Responses

Status

Meaning

Description

Schema

200

OK

Get all Publication Images

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/publicationsimages", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/publicationsimages");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/publicationsimages',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/publicationsimages', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/publicationsimages',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  "string"
]
["string"]

Get publication names.

Parameters

Name

In

Type

Required

Description

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

filter

query

string

false

####Supported operations

orderBy

query

string

false

####Description

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

name, type, location

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

id, name, type, location

Responses

Status

Meaning

Description

Schema

200

OK

Get all Publication Names (filter supported)

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Publisher.PublisherNameDTO]

false

none

none

» id

string¦null

false

none

none

» name

string¦null

false

none

none

» parameterValues

object¦null

false

none

none

»» additionalProperties

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»» expressionType

string

false

none

none

»»» cases

array¦null

false

none

none

»»»» anonymous

any

false

none

none

»»» table

string¦null

false

none

none

»»» column

string¦null

false

none

none

»»» op

string¦null

false

none

none

»»» arguments

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

none

[DTO version of IExpression]

»»»» expressionType

string

false

none

none

»»»» cases

array¦null

false

none

none

»»»»» anonymous

any

false

none

none

»»»» table

string¦null

false

none

none

»»»» column

string¦null

false

none

none

»»»» op

string¦null

false

none

none

»»»» arguments

array¦null

false

none

none

»»»»» anonymous

any

false

none

none

»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»» constraintType

string

false

none

none

»»»»» op

string¦null

false

none

none

»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»» expressionType

string

false

none

none

»»»»»» cases

array¦null

false

none

none

»»»»»»» anonymous

any

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» column

string¦null

false

none

none

»»»»»» op

string¦null

false

none

none

»»»»»» arguments

array¦null

false

none

none

»»»»»»» anonymous

any

false

none

none

»»»»»» condition

any

false

none

none

»»»»»» trueValue

any

false

none

none

»»»»»» falseValue

any

false

none

none

»»»»»» isDate

boolean

false

none

none

»»»»»» literalType

string

false

none

none

»»»»»» value

any

false

none

none

»»»»» caseSensitive

boolean

false

none

none

»»»»» constraints

array¦null

false

none

none

»»»»»» anonymous

any

false

none

none

»»»»» literalRight

any

false

none

none

»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»» right

any

false

none

none

»»»»» expressionLeft

any

false

none

none

»»»»» expressionRight

any

false

none

none

»»»»» isPreciseDecimal

boolean

false

none

none

»»»»» like

string¦null

false

none

none

»»»»» escapeWildcards

boolean

false

none

none

»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»» rowVersion

integer(int64)

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» queryDefinitionRight

any

false

none

none

»»»» trueValue

any

false

none

none

»»»» falseValue

any

false

none

none

»»»» isDate

boolean

false

none

none

»»»» literalType

string

false

none

none

»»»» value

any

false

none

none

»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»» trueValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»» falseValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»» isDate

boolean

false

none

none

»»» literalType

string

false

none

none

»»» value

any

false

none

none

Enumerated Values

Property

Value

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/publications", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/publications");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/publications',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/publications', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/publications',
  params: {
  }, headers: headers

p JSON.parse(result)

Create a new publication.

Body parameter

{
  "publisherId": 0,
  "name": "string",
  "publishType": "CalculationExcel",
  "location": "string",
  "publisherParams": [
    {
      "type": "Calculation",
      "calculationId": 0,
      "calculationName": "string",
      "portId": 0,
      "columnMap": {},
      "customTableName": "string",
      "filter": "string",
      "inputFormID": 0,
      "columns": "string",
      "headerRow": "string",
      "compress": true,
      "customOrderBy": [],
      "columnFormat": [],
      "columnWithDescription": [],
      "dataStoreName": "string",
      "delimiter": "string",
      "compPlanId": "string",
      "payeeId": "string",
      "period": "string",
      "periodLevel": "string",
      "payeeMajorDim": true,
      "mailWebUsers": true,
      "recipients": [],
      "emailSubject": "string",
      "emailBody": "string",
      "singleWorkbook": true,
      "fileName": "string",
      "headerImage": "string",
      "numberPages": true,
      "showTotalPageNumber": true,
      "portraitOrientation": true,
      "autoScale": true,
      "customScaleValue": 0.1,
      "tableViewportWidth": 0.1,
      "footerText": "string",
      "mergePdfFiles": true,
      "expandAllTableGroups": true,
      "user": "string",
      "password": "string",
      "token": "string",
      "table": "string",
      "sandbox": true,
      "dateFormat": "Default",
      "header": {},
      "row": {},
      "altRow": {},
      "webFormId": 0,
      "workflowGroupId": 0,
      "filterValues": {},
      "webReportId": 0,
      "parameterValues": {},
      "currentUserId": "string",
      "isBatchExport": true,
      "batchExportPayeeList": [],
      "hiddenColumnMap": {},
      "batchPicklistRefParam": "string",
      "bpmPublishType": "History",
      "workflowId": 0,
      "tokenId": 0,
      "timezoneOffset": "string",
      "offset": 0,
      "limit": 0,
      "orderBy": "string",
      "queryToolId": 0,
      "name": "string",
      "fromDataServer": "QUERY_SQL",
      "queryString": "string",
      "description": "string",
      "timeout": 0,
      "presenterFlexReportId": 0,
      "webTabId": 0,
      "currentPayeeId": "string",
      "batchExportPayeeIds": [],
      "bpmTokenId": 0,
      "planApprovalTemplateId": 0,
      "planApprovalStatus": "Selected",
      "planDocumentId": 0,
      "payeeWorkflowStatus": "InProgress",
      "planBuilderCalculationId": "string",
      "planBuilderCalculationName": "string",
      "requirementIds": [],
      "requirementExportAll": true,
      "requirementExportTitle": "string",
      "requirementfilter": "string",
      "requirementOrderBy": "string"
    }
  ],
  "isTemporary": true,
  "enableScreenshot": true,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Publisher.PublisherDefinitionDTO

false

Publication Definition

» publisherId

body

integer(int32)

false

none

» name

body

string¦null

false

none

» publishType

body

string

false

none

» location

body

string¦null

false

none

» publisherParams

body

[Varicent.RESTAPI.v1.DTOs.Publisher.PublisherParamsDTO]¦null

false

none

»» type

body

string

false

none

»» calculationId

body

integer(int32)¦null

false

none

»» calculationName

body

string¦null

false

none

»» portId

body

integer(int32)¦null

false

none

»» columnMap

body

object¦null

false

none

»»» additionalProperties

body

string¦null

false

none

»» customTableName

body

string¦null

false

none

»» filter

body

string¦null

false

none

»» inputFormID

body

integer(int32)

false

none

»» columns

body

string¦null

false

none

»» headerRow

body

string¦null

false

none

»» compress

body

boolean¦null

false

none

»» customOrderBy

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» direction

body

string

false

none

»» columnFormat

body

[Varicent.RESTAPI.v1.DTOs.Publisher.PublisherColumnFormatDTO]¦null

false

none

»»» column

body

string¦null

false

none

»»» scale

body

integer(int32)

false

none

»» columnWithDescription

body

[string]¦null

false

none

»» dataStoreName

body

string¦null

false

none

»» delimiter

body

string¦null

false

none

»» compPlanId

body

string¦null

false

none

»» payeeId

body

string¦null

false

none

»» period

body

string¦null

false

none

»» periodLevel

body

string¦null

false

none

»» payeeMajorDim

body

boolean¦null

false

none

»» mailWebUsers

body

boolean¦null

false

none

»» recipients

body

[string]¦null

false

none

»» emailSubject

body

string¦null

false

none

»» emailBody

body

string¦null

false

none

»» singleWorkbook

body

boolean¦null

false

none

»» fileName

body

string¦null

false

none

»» headerImage

body

string¦null

false

none

»» numberPages

body

boolean¦null

false

none

»» showTotalPageNumber

body

boolean¦null

false

none

»» portraitOrientation

body

boolean¦null

false

none

»» autoScale

body

boolean¦null

false

none

»» customScaleValue

body

number(double)¦null

false

none

»» tableViewportWidth

body

number(double)¦null

false

none

»» footerText

body

string¦null

false

none

»» mergePdfFiles

body

boolean¦null

false

none

»» expandAllTableGroups

body

boolean¦null

false

none

»» user

body

string¦null

false

none

»» password

body

string¦null

false

none

»» token

body

string¦null

false

none

»» table

body

string¦null

false

none

»» sandbox

body

boolean¦null

false

none

»» dateFormat

body

string¦null

false

none

»» header

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»» alignment

body

string

false

none

»»» backColor

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»»» a

body

integer(int32)

false

none

»»»» b

body

integer(int32)

false

none

»»»» g

body

integer(int32)

false

none

»»»» r

body

integer(int32)

false

none

»»» font

body

Varicent.RESTAPI.v1.DTOs.FontDefinitionDTO

false

none

»»»» family

body

string¦null

false

none

»»»» size

body

number(float)

false

none

»»»» unit

body

string¦null

false

none

»»»» bold

body

boolean

false

none

»»»» italic

body

boolean

false

none

»»»» underline

body

boolean

false

none

»»»» strikeout

body

boolean

false

none

»»» foreColor

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»» row

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»» altRow

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»» webFormId

body

integer(int32)

false

none

»» workflowGroupId

body

integer(int32)

false

none

»» filterValues

body

object¦null

false

none

»»» additionalProperties

body

string¦null

false

none

»» webReportId

body

integer(int32)¦null

false

none

»» parameterValues

body

object¦null

false

none

»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» expressionType

body

string

false

none

»»»» cases

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» op

body

string¦null

false

none

»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»» constraintType

body

string

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» expressionType

body

string

false

none

»»»»»»» cases

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» arguments

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» condition

body

any

false

none

»»»»»»» trueValue

body

any

false

none

»»»»»»» falseValue

body

any

false

none

»»»»»»» isDate

body

boolean

false

none

»»»»»»» literalType

body

string

false

none

»»»»»»» value

body

any

false

none

»»»»»» caseSensitive

body

boolean

false

none

»»»»»» constraints

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» literalRight

body

any

false

none

»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»» right

body

any

false

none

»»»»»» expressionLeft

body

any

false

none

»»»»»» expressionRight

body

any

false

none

»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»» like

body

string¦null

false

none

»»»»»» escapeWildcards

body

boolean

false

none

»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» queryDefinitionRight

body

any

false

none

»»»»» trueValue

body

any

false

none

»»»»» falseValue

body

any

false

none

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» isDate

body

boolean

false

none

»»»» literalType

body

string

false

none

»»»» value

body

any

false

none

»» currentUserId

body

string¦null

false

none

»» isBatchExport

body

boolean

false

none

»» batchExportPayeeList

body

[string]¦null

false

none

»» hiddenColumnMap

body

object¦null

false

none

»»» additionalProperties

body

[string]¦null

false

none

»» batchPicklistRefParam

body

string¦null

false

none

»» bpmPublishType

body

string

false

none

»» workflowId

body

integer(int32)

false

none

»» tokenId

body

integer(int32)

false

none

»» timezoneOffset

body

string¦null

false

none

»» offset

body

integer(int32)

false

none

»» limit

body

integer(int32)

false

none

»» orderBy

body

string¦null

false

none

»» queryToolId

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» fromDataServer

body

string

false

none

»» queryString

body

string¦null

false

none

»» description

body

string¦null

false

none

»» timeout

body

integer(int32)

false

none

»» presenterFlexReportId

body

integer(int32)¦null

false

none

»» webTabId

body

integer(int32)¦null

false

none

»» currentPayeeId

body

string¦null

false

none

»» batchExportPayeeIds

body

[string]¦null

false

none

»» bpmTokenId

body

integer(int32)¦null

false

none

»» planApprovalTemplateId

body

integer(int32)

false

none

»» planApprovalStatus

body

string

false

none

»» planDocumentId

body

integer(int32)

false

none

»» payeeWorkflowStatus

body

string

false

none

»» planBuilderCalculationId

body

string¦null

false

none

»» planBuilderCalculationName

body

string¦null

false

none

»» requirementIds

body

[string]¦null

false

none

»» requirementExportAll

body

boolean

false

none

»» requirementExportTitle

body

string¦null

false

none

»» requirementfilter

body

string¦null

false

none

»» requirementOrderBy

body

string¦null

false

none

» isTemporary

body

boolean

false

none

» enableScreenshot

body

boolean

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

» publishType

CalculationExcel

» publishType

CalculationMSCRM

» publishType

CalculationPdf

» publishType

CalculationSalesforce

» publishType

CalculationText

» publishType

CustomTableExcel

» publishType

CustomTableMSCRM

» publishType

CustomTablePdf

» publishType

CustomTableSalesforce

» publishType

CustomTableText

» publishType

WebFormPdf

» publishType

WebReportPdf

» publishType

BPMExcel

» publishType

PortExcel

» publishType

PortPdf

» publishType

PortSalesforce

» publishType

PortText

» publishType

PerformanceExcel

» publishType

PerformancePdf

» publishType

PerformanceSalesforce

» publishType

PerformanceText

» publishType

PayeeWebWebReportPdf

» publishType

DataStoreText

» publishType

DataStoreExcel

» publishType

QueryToolText

» publishType

QueryToolExcel

» publishType

CalculationCOS

» publishType

CustomTableCOS

» publishType

PortCOS

» publishType

PerformanceCOS

» publishType

PresenterFlexPdf

» publishType

PayeeWebPresenterFlexPdf

» publishType

HealthDashboardExcel

» publishType

PlanDocumentPdf

» publishType

StandardReportPdf

» publishType

BulkPlanDocumentsZip

» publishType

MassPlanDocumentDownloadZip

» publishType

AdminPresenterFlexPdf

» publishType

PlanDocument2Pdf

» publishType

PlanBuilderCalculationExcel

» publishType

PlanBuilderCalculationMSCRM

» publishType

PlanBuilderCalculationPdf

» publishType

PlanBuilderCalculationSalesforce

» publishType

PlanBuilderCalculationText

» publishType

PlanBuilderCalculationCOS

» publishType

RequirementPdf

»» type

Calculation

»» type

ColumnMap

»» type

CustomTable

»» type

Delimited

»» type

Email

»» type

Excel

»» type

File

»» type

MSCRM

»» type

Pdf

»» type

Performance

»» type

Salesforce

»» type

TableStyle

»» type

WebForm

»» type

WebReport

»» type

WebReportView

»» type

BPM

»» type

Port

»» type

DataStore

»» type

QueryTool

»» type

PresenterFlex

»» type

PresenterFlexView

»» type

PlanDocument

»» type

StandardReport

»» type

BulkPlanDocuments

»» type

PlanDocumentDownload

»» type

PlanDocument2

»» type

PlanBuilderCalculation

»» type

Requirement

»»» direction

Ascending

»»» direction

Descending

»»» direction

AscendingNullsFirst

»»» direction

DescendingNullsLast

»» dateFormat

Default

»» dateFormat

DayFirst

»» dateFormat

MonthFirst

»»» alignment

Justify

»»» alignment

Left

»»» alignment

Center

»»» alignment

Right

»»»» expressionType

caseExpression

»»»» expressionType

dataField

»»»» expressionType

function

»»»» expressionType

ifExpression

»»»» expressionType

literal

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» constraintType

clause

»»»»»» constraintType

constraint

»»»»»» constraintType

expressionConstraint

»»»»»» constraintType

likeConstraint

»»»»»» constraintType

rowVersionConstraint

»»»»»» constraintType

subQueryConstraint

»»»»»»» expressionType

caseExpression

»»»»»»» expressionType

dataField

»»»»»»» expressionType

function

»»»»»»» expressionType

ifExpression

»»»»»»» expressionType

literal

»»»»»»» literalType

Integer

»»»»»»» literalType

Decimal

»»»»»»» literalType

Date

»»»»»»» literalType

DateTime

»»»»»»» literalType

String

»»»»»»» literalType

Float

»»»»»»» literalType

Long

»»»»»»» literalType

Null

»»»»»»» literalType

Parameter

»»»»»»» literalType

Guid

»»»»»»» literalType

SystemUtcTime

»»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» literalType

Integer

»»»» literalType

Decimal

»»»» literalType

Date

»»»» literalType

DateTime

»»»» literalType

String

»»»» literalType

Float

»»»» literalType

Long

»»»» literalType

Null

»»»» literalType

Parameter

»»»» literalType

Guid

»»»» literalType

SystemUtcTime

»»»» literalType

Boolean

»» bpmPublishType

History

»» bpmPublishType

PendingActions

»» bpmPublishType

ActionNodeErrors

»» bpmPublishType

AlertNodeErrors

»» bpmPublishType

ServiceNodeErrors

»» bpmPublishType

SignNodeErrors

»» bpmPublishType

StatusReport

»» fromDataServer

QUERY_SQL

»» fromDataServer

QUERY_SPARK

»» fromDataServer

QUERY_PRESTO

»» planApprovalStatus

Selected

»» planApprovalStatus

PreManagerApproval

»» planApprovalStatus

PayeeSign

»» planApprovalStatus

Complete

»» payeeWorkflowStatus

InProgress

»» payeeWorkflowStatus

Complete

»» payeeWorkflowStatus

Cancelled

Responses

Status

Meaning

Description

Schema

201

Created

Create new publication

Varicent.RESTAPI.v1.DTOs.Publisher.PublisherDefinitionDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/publications", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/publications");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "publisherId": 0,
  "name": "string",
  "publishType": "CalculationExcel",
  "location": "string",
  "publisherParams": [
    {
      "type": "Calculation",
      "calculationId": 0,
      "calculationName": "string",
      "portId": 0,
      "columnMap": {},
      "customTableName": "string",
      "filter": "string",
      "inputFormID": 0,
      "columns": "string",
      "headerRow": "string",
      "compress": true,
      "customOrderBy": [],
      "columnFormat": [],
      "columnWithDescription": [],
      "dataStoreName": "string",
      "delimiter": "string",
      "compPlanId": "string",
      "payeeId": "string",
      "period": "string",
      "periodLevel": "string",
      "payeeMajorDim": true,
      "mailWebUsers": true,
      "recipients": [],
      "emailSubject": "string",
      "emailBody": "string",
      "singleWorkbook": true,
      "fileName": "string",
      "headerImage": "string",
      "numberPages": true,
      "showTotalPageNumber": true,
      "portraitOrientation": true,
      "autoScale": true,
      "customScaleValue": 0.1,
      "tableViewportWidth": 0.1,
      "footerText": "string",
      "mergePdfFiles": true,
      "expandAllTableGroups": true,
      "user": "string",
      "password": "string",
      "token": "string",
      "table": "string",
      "sandbox": true,
      "dateFormat": "Default",
      "header": {},
      "row": {},
      "altRow": {},
      "webFormId": 0,
      "workflowGroupId": 0,
      "filterValues": {},
      "webReportId": 0,
      "parameterValues": {},
      "currentUserId": "string",
      "isBatchExport": true,
      "batchExportPayeeList": [],
      "hiddenColumnMap": {},
      "batchPicklistRefParam": "string",
      "bpmPublishType": "History",
      "workflowId": 0,
      "tokenId": 0,
      "timezoneOffset": "string",
      "offset": 0,
      "limit": 0,
      "orderBy": "string",
      "queryToolId": 0,
      "name": "string",
      "fromDataServer": "QUERY_SQL",
      "queryString": "string",
      "description": "string",
      "timeout": 0,
      "presenterFlexReportId": 0,
      "webTabId": 0,
      "currentPayeeId": "string",
      "batchExportPayeeIds": [],
      "bpmTokenId": 0,
      "planApprovalTemplateId": 0,
      "planApprovalStatus": "Selected",
      "planDocumentId": 0,
      "payeeWorkflowStatus": "InProgress",
      "planBuilderCalculationId": "string",
      "planBuilderCalculationName": "string",
      "requirementIds": [],
      "requirementExportAll": true,
      "requirementExportTitle": "string",
      "requirementfilter": "string",
      "requirementOrderBy": "string"
    }
  ],
  "isTemporary": true,
  "enableScreenshot": true,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/publications',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/publications', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/publications',
  params: {
  }, headers: headers

p JSON.parse(result)

Get a publication by ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get Publication by Id

Varicent.RESTAPI.v1.DTOs.Publisher.PublisherDefinitionDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/publications/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/publications/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/publications/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/publications/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/publications/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "publisherId": 0,
  "name": "string",
  "publishType": "CalculationExcel",
  "location": "string",
  "publisherParams": [
    {
      "type": "Calculation",
      "calculationId": 0,
      "calculationName": "string",
      "portId": 0,
      "columnMap": {},
      "customTableName": "string",
      "filter": "string",
      "inputFormID": 0,
      "columns": "string",
      "headerRow": "string",
      "compress": true,
      "customOrderBy": [],
      "columnFormat": [],
      "columnWithDescription": [],
      "dataStoreName": "string",
      "delimiter": "string",
      "compPlanId": "string",
      "payeeId": "string",
      "period": "string",
      "periodLevel": "string",
      "payeeMajorDim": true,
      "mailWebUsers": true,
      "recipients": [],
      "emailSubject": "string",
      "emailBody": "string",
      "singleWorkbook": true,
      "fileName": "string",
      "headerImage": "string",
      "numberPages": true,
      "showTotalPageNumber": true,
      "portraitOrientation": true,
      "autoScale": true,
      "customScaleValue": 0.1,
      "tableViewportWidth": 0.1,
      "footerText": "string",
      "mergePdfFiles": true,
      "expandAllTableGroups": true,
      "user": "string",
      "password": "string",
      "token": "string",
      "table": "string",
      "sandbox": true,
      "dateFormat": "Default",
      "header": {},
      "row": {},
      "altRow": {},
      "webFormId": 0,
      "workflowGroupId": 0,
      "filterValues": {},
      "webReportId": 0,
      "parameterValues": {},
      "currentUserId": "string",
      "isBatchExport": true,
      "batchExportPayeeList": [],
      "hiddenColumnMap": {},
      "batchPicklistRefParam": "string",
      "bpmPublishType": "History",
      "workflowId": 0,
      "tokenId": 0,
      "timezoneOffset": "string",
      "offset": 0,
      "limit": 0,
      "orderBy": "string",
      "queryToolId": 0,
      "name": "string",
      "fromDataServer": "QUERY_SQL",
      "queryString": "string",
      "description": "string",
      "timeout": 0,
      "presenterFlexReportId": 0,
      "webTabId": 0,
      "currentPayeeId": "string",
      "batchExportPayeeIds": [],
      "bpmTokenId": 0,
      "planApprovalTemplateId": 0,
      "planApprovalStatus": "Selected",
      "planDocumentId": 0,
      "payeeWorkflowStatus": "InProgress",
      "planBuilderCalculationId": "string",
      "planBuilderCalculationName": "string",
      "requirementIds": [],
      "requirementExportAll": true,
      "requirementExportTitle": "string",
      "requirementfilter": "string",
      "requirementOrderBy": "string"
    }
  ],
  "isTemporary": true,
  "enableScreenshot": true,
  "version": {
    "rowVersion": 0
  }
}
{"publisherId":0,"name":"string","publishType":"CalculationExcel","location":"string","publisherParams":[{"type":"Calculation","calculationId":0,"calculationName":"string","portId":0,"columnMap":{},"customTableName":"string","filter":"string","inputFormID":0,"columns":"string","headerRow":"string","compress":true,"customOrderBy":[],"columnFormat":[],"columnWithDescription":[],"dataStoreName":"string","delimiter":"string","compPlanId":"string","payeeId":"string","period":"string","periodLevel":"string","payeeMajorDim":true,"mailWebUsers":true,"recipients":[],"emailSubject":"string","emailBody":"string","singleWorkbook":true,"fileName":"string","headerImage":"string","numberPages":true,"showTotalPageNumber":true,"portraitOrientation":true,"autoScale":true,"customScaleValue":0.1,"tableViewportWidth":0.1,"footerText":"string","mergePdfFiles":true,"expandAllTableGroups":true,"user":"string","password":"string","token":"string","table":"string","sandbox":true,"dateFormat":"Default","header":{},"row":{},"altRow":{},"webFormId":0,"workflowGroupId":0,"filterValues":{},"webReportId":0,"parameterValues":{},"currentUserId":"string","isBatchExport":true,"batchExportPayeeList":[],"hiddenColumnMap":{},"batchPicklistRefParam":"string","bpmPublishType":"History","workflowId":0,"tokenId":0,"timezoneOffset":"string","offset":0,"limit":0,"orderBy":"string","queryToolId":0,"name":"string","fromDataServer":"QUERY_SQL","queryString":"string","description":"string","timeout":0,"presenterFlexReportId":0,"webTabId":0,"currentPayeeId":"string","batchExportPayeeIds":[],"bpmTokenId":0,"planApprovalTemplateId":0,"planApprovalStatus":"Selected","planDocumentId":0,"payeeWorkflowStatus":"InProgress","planBuilderCalculationId":"string","planBuilderCalculationName":"string","requirementIds":[],"requirementExportAll":true,"requirementExportTitle":"string","requirementfilter":"string","requirementOrderBy":"string"}],"isTemporary":true,"enableScreenshot":true,"version":{"rowVersion":0}}

Delete a publication by ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

204

No Content

Delete Publication by Id

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/publications/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/publications/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/publications/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/publications/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/publications/{id}',
  params: {
  }

p JSON.parse(result)

Update an existing publication.

Body parameter

{
  "publisherId": 0,
  "name": "string",
  "publishType": "CalculationExcel",
  "location": "string",
  "publisherParams": [
    {
      "type": "Calculation",
      "calculationId": 0,
      "calculationName": "string",
      "portId": 0,
      "columnMap": {},
      "customTableName": "string",
      "filter": "string",
      "inputFormID": 0,
      "columns": "string",
      "headerRow": "string",
      "compress": true,
      "customOrderBy": [],
      "columnFormat": [],
      "columnWithDescription": [],
      "dataStoreName": "string",
      "delimiter": "string",
      "compPlanId": "string",
      "payeeId": "string",
      "period": "string",
      "periodLevel": "string",
      "payeeMajorDim": true,
      "mailWebUsers": true,
      "recipients": [],
      "emailSubject": "string",
      "emailBody": "string",
      "singleWorkbook": true,
      "fileName": "string",
      "headerImage": "string",
      "numberPages": true,
      "showTotalPageNumber": true,
      "portraitOrientation": true,
      "autoScale": true,
      "customScaleValue": 0.1,
      "tableViewportWidth": 0.1,
      "footerText": "string",
      "mergePdfFiles": true,
      "expandAllTableGroups": true,
      "user": "string",
      "password": "string",
      "token": "string",
      "table": "string",
      "sandbox": true,
      "dateFormat": "Default",
      "header": {},
      "row": {},
      "altRow": {},
      "webFormId": 0,
      "workflowGroupId": 0,
      "filterValues": {},
      "webReportId": 0,
      "parameterValues": {},
      "currentUserId": "string",
      "isBatchExport": true,
      "batchExportPayeeList": [],
      "hiddenColumnMap": {},
      "batchPicklistRefParam": "string",
      "bpmPublishType": "History",
      "workflowId": 0,
      "tokenId": 0,
      "timezoneOffset": "string",
      "offset": 0,
      "limit": 0,
      "orderBy": "string",
      "queryToolId": 0,
      "name": "string",
      "fromDataServer": "QUERY_SQL",
      "queryString": "string",
      "description": "string",
      "timeout": 0,
      "presenterFlexReportId": 0,
      "webTabId": 0,
      "currentPayeeId": "string",
      "batchExportPayeeIds": [],
      "bpmTokenId": 0,
      "planApprovalTemplateId": 0,
      "planApprovalStatus": "Selected",
      "planDocumentId": 0,
      "payeeWorkflowStatus": "InProgress",
      "planBuilderCalculationId": "string",
      "planBuilderCalculationName": "string",
      "requirementIds": [],
      "requirementExportAll": true,
      "requirementExportTitle": "string",
      "requirementfilter": "string",
      "requirementOrderBy": "string"
    }
  ],
  "isTemporary": true,
  "enableScreenshot": true,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Publication Id

body

body

Varicent.RESTAPI.v1.DTOs.Publisher.PublisherDefinitionDTO

false

Publication Definition

» publisherId

body

integer(int32)

false

none

» name

body

string¦null

false

none

» publishType

body

string

false

none

» location

body

string¦null

false

none

» publisherParams

body

[Varicent.RESTAPI.v1.DTOs.Publisher.PublisherParamsDTO]¦null

false

none

»» type

body

string

false

none

»» calculationId

body

integer(int32)¦null

false

none

»» calculationName

body

string¦null

false

none

»» portId

body

integer(int32)¦null

false

none

»» columnMap

body

object¦null

false

none

»»» additionalProperties

body

string¦null

false

none

»» customTableName

body

string¦null

false

none

»» filter

body

string¦null

false

none

»» inputFormID

body

integer(int32)

false

none

»» columns

body

string¦null

false

none

»» headerRow

body

string¦null

false

none

»» compress

body

boolean¦null

false

none

»» customOrderBy

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» direction

body

string

false

none

»» columnFormat

body

[Varicent.RESTAPI.v1.DTOs.Publisher.PublisherColumnFormatDTO]¦null

false

none

»»» column

body

string¦null

false

none

»»» scale

body

integer(int32)

false

none

»» columnWithDescription

body

[string]¦null

false

none

»» dataStoreName

body

string¦null

false

none

»» delimiter

body

string¦null

false

none

»» compPlanId

body

string¦null

false

none

»» payeeId

body

string¦null

false

none

»» period

body

string¦null

false

none

»» periodLevel

body

string¦null

false

none

»» payeeMajorDim

body

boolean¦null

false

none

»» mailWebUsers

body

boolean¦null

false

none

»» recipients

body

[string]¦null

false

none

»» emailSubject

body

string¦null

false

none

»» emailBody

body

string¦null

false

none

»» singleWorkbook

body

boolean¦null

false

none

»» fileName

body

string¦null

false

none

»» headerImage

body

string¦null

false

none

»» numberPages

body

boolean¦null

false

none

»» showTotalPageNumber

body

boolean¦null

false

none

»» portraitOrientation

body

boolean¦null

false

none

»» autoScale

body

boolean¦null

false

none

»» customScaleValue

body

number(double)¦null

false

none

»» tableViewportWidth

body

number(double)¦null

false

none

»» footerText

body

string¦null

false

none

»» mergePdfFiles

body

boolean¦null

false

none

»» expandAllTableGroups

body

boolean¦null

false

none

»» user

body

string¦null

false

none

»» password

body

string¦null

false

none

»» token

body

string¦null

false

none

»» table

body

string¦null

false

none

»» sandbox

body

boolean¦null

false

none

»» dateFormat

body

string¦null

false

none

»» header

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»» alignment

body

string

false

none

»»» backColor

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»»» a

body

integer(int32)

false

none

»»»» b

body

integer(int32)

false

none

»»»» g

body

integer(int32)

false

none

»»»» r

body

integer(int32)

false

none

»»» font

body

Varicent.RESTAPI.v1.DTOs.FontDefinitionDTO

false

none

»»»» family

body

string¦null

false

none

»»»» size

body

number(float)

false

none

»»»» unit

body

string¦null

false

none

»»»» bold

body

boolean

false

none

»»»» italic

body

boolean

false

none

»»»» underline

body

boolean

false

none

»»»» strikeout

body

boolean

false

none

»»» foreColor

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»» row

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»» altRow

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»» webFormId

body

integer(int32)

false

none

»» workflowGroupId

body

integer(int32)

false

none

»» filterValues

body

object¦null

false

none

»»» additionalProperties

body

string¦null

false

none

»» webReportId

body

integer(int32)¦null

false

none

»» parameterValues

body

object¦null

false

none

»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» expressionType

body

string

false

none

»»»» cases

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» op

body

string¦null

false

none

»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»» constraintType

body

string

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» expressionType

body

string

false

none

»»»»»»» cases

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» arguments

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» condition

body

any

false

none

»»»»»»» trueValue

body

any

false

none

»»»»»»» falseValue

body

any

false

none

»»»»»»» isDate

body

boolean

false

none

»»»»»»» literalType

body

string

false

none

»»»»»»» value

body

any

false

none

»»»»»» caseSensitive

body

boolean

false

none

»»»»»» constraints

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» literalRight

body

any

false

none

»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»» right

body

any

false

none

»»»»»» expressionLeft

body

any

false

none

»»»»»» expressionRight

body

any

false

none

»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»» like

body

string¦null

false

none

»»»»»» escapeWildcards

body

boolean

false

none

»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» queryDefinitionRight

body

any

false

none

»»»»» trueValue

body

any

false

none

»»»»» falseValue

body

any

false

none

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» isDate

body

boolean

false

none

»»»» literalType

body

string

false

none

»»»» value

body

any

false

none

»» currentUserId

body

string¦null

false

none

»» isBatchExport

body

boolean

false

none

»» batchExportPayeeList

body

[string]¦null

false

none

»» hiddenColumnMap

body

object¦null

false

none

»»» additionalProperties

body

[string]¦null

false

none

»» batchPicklistRefParam

body

string¦null

false

none

»» bpmPublishType

body

string

false

none

»» workflowId

body

integer(int32)

false

none

»» tokenId

body

integer(int32)

false

none

»» timezoneOffset

body

string¦null

false

none

»» offset

body

integer(int32)

false

none

»» limit

body

integer(int32)

false

none

»» orderBy

body

string¦null

false

none

»» queryToolId

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» fromDataServer

body

string

false

none

»» queryString

body

string¦null

false

none

»» description

body

string¦null

false

none

»» timeout

body

integer(int32)

false

none

»» presenterFlexReportId

body

integer(int32)¦null

false

none

»» webTabId

body

integer(int32)¦null

false

none

»» currentPayeeId

body

string¦null

false

none

»» batchExportPayeeIds

body

[string]¦null

false

none

»» bpmTokenId

body

integer(int32)¦null

false

none

»» planApprovalTemplateId

body

integer(int32)

false

none

»» planApprovalStatus

body

string

false

none

»» planDocumentId

body

integer(int32)

false

none

»» payeeWorkflowStatus

body

string

false

none

»» planBuilderCalculationId

body

string¦null

false

none

»» planBuilderCalculationName

body

string¦null

false

none

»» requirementIds

body

[string]¦null

false

none

»» requirementExportAll

body

boolean

false

none

»» requirementExportTitle

body

string¦null

false

none

»» requirementfilter

body

string¦null

false

none

»» requirementOrderBy

body

string¦null

false

none

» isTemporary

body

boolean

false

none

» enableScreenshot

body

boolean

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

» publishType

CalculationExcel

» publishType

CalculationMSCRM

» publishType

CalculationPdf

» publishType

CalculationSalesforce

» publishType

CalculationText

» publishType

CustomTableExcel

» publishType

CustomTableMSCRM

» publishType

CustomTablePdf

» publishType

CustomTableSalesforce

» publishType

CustomTableText

» publishType

WebFormPdf

» publishType

WebReportPdf

» publishType

BPMExcel

» publishType

PortExcel

» publishType

PortPdf

» publishType

PortSalesforce

» publishType

PortText

» publishType

PerformanceExcel

» publishType

PerformancePdf

» publishType

PerformanceSalesforce

» publishType

PerformanceText

» publishType

PayeeWebWebReportPdf

» publishType

DataStoreText

» publishType

DataStoreExcel

» publishType

QueryToolText

» publishType

QueryToolExcel

» publishType

CalculationCOS

» publishType

CustomTableCOS

» publishType

PortCOS

» publishType

PerformanceCOS

» publishType

PresenterFlexPdf

» publishType

PayeeWebPresenterFlexPdf

» publishType

HealthDashboardExcel

» publishType

PlanDocumentPdf

» publishType

StandardReportPdf

» publishType

BulkPlanDocumentsZip

» publishType

MassPlanDocumentDownloadZip

» publishType

AdminPresenterFlexPdf

» publishType

PlanDocument2Pdf

» publishType

PlanBuilderCalculationExcel

» publishType

PlanBuilderCalculationMSCRM

» publishType

PlanBuilderCalculationPdf

» publishType

PlanBuilderCalculationSalesforce

» publishType

PlanBuilderCalculationText

» publishType

PlanBuilderCalculationCOS

» publishType

RequirementPdf

»» type

Calculation

»» type

ColumnMap

»» type

CustomTable

»» type

Delimited

»» type

Email

»» type

Excel

»» type

File

»» type

MSCRM

»» type

Pdf

»» type

Performance

»» type

Salesforce

»» type

TableStyle

»» type

WebForm

»» type

WebReport

»» type

WebReportView

»» type

BPM

»» type

Port

»» type

DataStore

»» type

QueryTool

»» type

PresenterFlex

»» type

PresenterFlexView

»» type

PlanDocument

»» type

StandardReport

»» type

BulkPlanDocuments

»» type

PlanDocumentDownload

»» type

PlanDocument2

»» type

PlanBuilderCalculation

»» type

Requirement

»»» direction

Ascending

»»» direction

Descending

»»» direction

AscendingNullsFirst

»»» direction

DescendingNullsLast

»» dateFormat

Default

»» dateFormat

DayFirst

»» dateFormat

MonthFirst

»»» alignment

Justify

»»» alignment

Left

»»» alignment

Center

»»» alignment

Right

»»»» expressionType

caseExpression

»»»» expressionType

dataField

»»»» expressionType

function

»»»» expressionType

ifExpression

»»»» expressionType

literal

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» constraintType

clause

»»»»»» constraintType

constraint

»»»»»» constraintType

expressionConstraint

»»»»»» constraintType

likeConstraint

»»»»»» constraintType

rowVersionConstraint

»»»»»» constraintType

subQueryConstraint

»»»»»»» expressionType

caseExpression

»»»»»»» expressionType

dataField

»»»»»»» expressionType

function

»»»»»»» expressionType

ifExpression

»»»»»»» expressionType

literal

»»»»»»» literalType

Integer

»»»»»»» literalType

Decimal

»»»»»»» literalType

Date

»»»»»»» literalType

DateTime

»»»»»»» literalType

String

»»»»»»» literalType

Float

»»»»»»» literalType

Long

»»»»»»» literalType

Null

»»»»»»» literalType

Parameter

»»»»»»» literalType

Guid

»»»»»»» literalType

SystemUtcTime

»»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» literalType

Integer

»»»» literalType

Decimal

»»»» literalType

Date

»»»» literalType

DateTime

»»»» literalType

String

»»»» literalType

Float

»»»» literalType

Long

»»»» literalType

Null

»»»» literalType

Parameter

»»»» literalType

Guid

»»»» literalType

SystemUtcTime

»»»» literalType

Boolean

»» bpmPublishType

History

»» bpmPublishType

PendingActions

»» bpmPublishType

ActionNodeErrors

»» bpmPublishType

AlertNodeErrors

»» bpmPublishType

ServiceNodeErrors

»» bpmPublishType

SignNodeErrors

»» bpmPublishType

StatusReport

»» fromDataServer

QUERY_SQL

»» fromDataServer

QUERY_SPARK

»» fromDataServer

QUERY_PRESTO

»» planApprovalStatus

Selected

»» planApprovalStatus

PreManagerApproval

»» planApprovalStatus

PayeeSign

»» planApprovalStatus

Complete

»» payeeWorkflowStatus

InProgress

»» payeeWorkflowStatus

Complete

»» payeeWorkflowStatus

Cancelled

Responses

Status

Meaning

Description

Schema

200

OK

Update existing publication

Varicent.RESTAPI.v1.DTOs.Publisher.PublisherDefinitionDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/publications/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/publications/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "publisherId": 0,
  "name": "string",
  "publishType": "CalculationExcel",
  "location": "string",
  "publisherParams": [
    {
      "type": "Calculation",
      "calculationId": 0,
      "calculationName": "string",
      "portId": 0,
      "columnMap": {},
      "customTableName": "string",
      "filter": "string",
      "inputFormID": 0,
      "columns": "string",
      "headerRow": "string",
      "compress": true,
      "customOrderBy": [],
      "columnFormat": [],
      "columnWithDescription": [],
      "dataStoreName": "string",
      "delimiter": "string",
      "compPlanId": "string",
      "payeeId": "string",
      "period": "string",
      "periodLevel": "string",
      "payeeMajorDim": true,
      "mailWebUsers": true,
      "recipients": [],
      "emailSubject": "string",
      "emailBody": "string",
      "singleWorkbook": true,
      "fileName": "string",
      "headerImage": "string",
      "numberPages": true,
      "showTotalPageNumber": true,
      "portraitOrientation": true,
      "autoScale": true,
      "customScaleValue": 0.1,
      "tableViewportWidth": 0.1,
      "footerText": "string",
      "mergePdfFiles": true,
      "expandAllTableGroups": true,
      "user": "string",
      "password": "string",
      "token": "string",
      "table": "string",
      "sandbox": true,
      "dateFormat": "Default",
      "header": {},
      "row": {},
      "altRow": {},
      "webFormId": 0,
      "workflowGroupId": 0,
      "filterValues": {},
      "webReportId": 0,
      "parameterValues": {},
      "currentUserId": "string",
      "isBatchExport": true,
      "batchExportPayeeList": [],
      "hiddenColumnMap": {},
      "batchPicklistRefParam": "string",
      "bpmPublishType": "History",
      "workflowId": 0,
      "tokenId": 0,
      "timezoneOffset": "string",
      "offset": 0,
      "limit": 0,
      "orderBy": "string",
      "queryToolId": 0,
      "name": "string",
      "fromDataServer": "QUERY_SQL",
      "queryString": "string",
      "description": "string",
      "timeout": 0,
      "presenterFlexReportId": 0,
      "webTabId": 0,
      "currentPayeeId": "string",
      "batchExportPayeeIds": [],
      "bpmTokenId": 0,
      "planApprovalTemplateId": 0,
      "planApprovalStatus": "Selected",
      "planDocumentId": 0,
      "payeeWorkflowStatus": "InProgress",
      "planBuilderCalculationId": "string",
      "planBuilderCalculationName": "string",
      "requirementIds": [],
      "requirementExportAll": true,
      "requirementExportTitle": "string",
      "requirementfilter": "string",
      "requirementOrderBy": "string"
    }
  ],
  "isTemporary": true,
  "enableScreenshot": true,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/publications/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/publications/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/publications/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

Get all publication names and ids by report ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get Publication Names and Ids by Report Id

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Publisher.PublisherNameDTO]

false

none

none

» id

string¦null

false

none

none

» name

string¦null

false

none

none

» parameterValues

object¦null

false

none

none

»» additionalProperties

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»» expressionType

string

false

none

none

»»» cases

array¦null

false

none

none

»»»» anonymous

any

false

none

none

»»» table

string¦null

false

none

none

»»» column

string¦null

false

none

none

»»» op

string¦null

false

none

none

»»» arguments

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

none

[DTO version of IExpression]

»»»» expressionType

string

false

none

none

»»»» cases

array¦null

false

none

none

»»»»» anonymous

any

false

none

none

»»»» table

string¦null

false

none

none

»»»» column

string¦null

false

none

none

»»»» op

string¦null

false

none

none

»»»» arguments

array¦null

false

none

none

»»»»» anonymous

any

false

none

none

»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»» constraintType

string

false

none

none

»»»»» op

string¦null

false

none

none

»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»» expressionType

string

false

none

none

»»»»»» cases

array¦null

false

none

none

»»»»»»» anonymous

any

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» column

string¦null

false

none

none

»»»»»» op

string¦null

false

none

none

»»»»»» arguments

array¦null

false

none

none

»»»»»»» anonymous

any

false

none

none

»»»»»» condition

any

false

none

none

»»»»»» trueValue

any

false

none

none

»»»»»» falseValue

any

false

none

none

»»»»»» isDate

boolean

false

none

none

»»»»»» literalType

string

false

none

none

»»»»»» value

any

false

none

none

»»»»» caseSensitive

boolean

false

none

none

»»»»» constraints

array¦null

false

none

none

»»»»»» anonymous

any

false

none

none

»»»»» literalRight

any

false

none

none

»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»» right

any

false

none

none

»»»»» expressionLeft

any

false

none

none

»»»»» expressionRight

any

false

none

none

»»»»» isPreciseDecimal

boolean

false

none

none

»»»»» like

string¦null

false

none

none

»»»»» escapeWildcards

boolean

false

none

none

»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»» rowVersion

integer(int64)

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» queryDefinitionRight

any

false

none

none

»»»» trueValue

any

false

none

none

»»»» falseValue

any

false

none

none

»»»» isDate

boolean

false

none

none

»»»» literalType

string

false

none

none

»»»» value

any

false

none

none

»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»» trueValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»» falseValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»» isDate

boolean

false

none

none

»»» literalType

string

false

none

none

»»» value

any

false

none

none

Enumerated Values

Property

Value

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/publications/presenterflex/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/publications/presenterflex/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/publications/presenterflex/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/publications/presenterflex/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/publications/presenterflex/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": "string",
    "name": "string",
    "parameterValues": {
      "property1": {},
      "property2": {}
    }
  }
]
[{"id":"string","name":"string","parameterValues":{"property1":{},"property2":{}}}]

Run a publication.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Publication Id

Responses

Status

Meaning

Description

Schema

202

Accepted

Run publication

Inline

Response Schema

Status Code 202

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/publications/{id}/publish", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/publications/{id}/publish");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/publications/{id}/publish',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/publications/{id}/publish', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/publications/{id}/publish',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "property1": "string",
  "property2": "string"
}
{"property1":"string","property2":"string"}

Run a local publication.

Body parameter

{
  "publisherId": 0,
  "name": "string",
  "publishType": "CalculationExcel",
  "location": "string",
  "publisherParams": [
    {
      "type": "Calculation",
      "calculationId": 0,
      "calculationName": "string",
      "portId": 0,
      "columnMap": {},
      "customTableName": "string",
      "filter": "string",
      "inputFormID": 0,
      "columns": "string",
      "headerRow": "string",
      "compress": true,
      "customOrderBy": [],
      "columnFormat": [],
      "columnWithDescription": [],
      "dataStoreName": "string",
      "delimiter": "string",
      "compPlanId": "string",
      "payeeId": "string",
      "period": "string",
      "periodLevel": "string",
      "payeeMajorDim": true,
      "mailWebUsers": true,
      "recipients": [],
      "emailSubject": "string",
      "emailBody": "string",
      "singleWorkbook": true,
      "fileName": "string",
      "headerImage": "string",
      "numberPages": true,
      "showTotalPageNumber": true,
      "portraitOrientation": true,
      "autoScale": true,
      "customScaleValue": 0.1,
      "tableViewportWidth": 0.1,
      "footerText": "string",
      "mergePdfFiles": true,
      "expandAllTableGroups": true,
      "user": "string",
      "password": "string",
      "token": "string",
      "table": "string",
      "sandbox": true,
      "dateFormat": "Default",
      "header": {},
      "row": {},
      "altRow": {},
      "webFormId": 0,
      "workflowGroupId": 0,
      "filterValues": {},
      "webReportId": 0,
      "parameterValues": {},
      "currentUserId": "string",
      "isBatchExport": true,
      "batchExportPayeeList": [],
      "hiddenColumnMap": {},
      "batchPicklistRefParam": "string",
      "bpmPublishType": "History",
      "workflowId": 0,
      "tokenId": 0,
      "timezoneOffset": "string",
      "offset": 0,
      "limit": 0,
      "orderBy": "string",
      "queryToolId": 0,
      "name": "string",
      "fromDataServer": "QUERY_SQL",
      "queryString": "string",
      "description": "string",
      "timeout": 0,
      "presenterFlexReportId": 0,
      "webTabId": 0,
      "currentPayeeId": "string",
      "batchExportPayeeIds": [],
      "bpmTokenId": 0,
      "planApprovalTemplateId": 0,
      "planApprovalStatus": "Selected",
      "planDocumentId": 0,
      "payeeWorkflowStatus": "InProgress",
      "planBuilderCalculationId": "string",
      "planBuilderCalculationName": "string",
      "requirementIds": [],
      "requirementExportAll": true,
      "requirementExportTitle": "string",
      "requirementfilter": "string",
      "requirementOrderBy": "string"
    }
  ],
  "isTemporary": true,
  "enableScreenshot": true,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Publisher.PublisherDefinitionDTO

false

Publication Definition

» publisherId

body

integer(int32)

false

none

» name

body

string¦null

false

none

» publishType

body

string

false

none

» location

body

string¦null

false

none

» publisherParams

body

[Varicent.RESTAPI.v1.DTOs.Publisher.PublisherParamsDTO]¦null

false

none

»» type

body

string

false

none

»» calculationId

body

integer(int32)¦null

false

none

»» calculationName

body

string¦null

false

none

»» portId

body

integer(int32)¦null

false

none

»» columnMap

body

object¦null

false

none

»»» additionalProperties

body

string¦null

false

none

»» customTableName

body

string¦null

false

none

»» filter

body

string¦null

false

none

»» inputFormID

body

integer(int32)

false

none

»» columns

body

string¦null

false

none

»» headerRow

body

string¦null

false

none

»» compress

body

boolean¦null

false

none

»» customOrderBy

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» direction

body

string

false

none

»» columnFormat

body

[Varicent.RESTAPI.v1.DTOs.Publisher.PublisherColumnFormatDTO]¦null

false

none

»»» column

body

string¦null

false

none

»»» scale

body

integer(int32)

false

none

»» columnWithDescription

body

[string]¦null

false

none

»» dataStoreName

body

string¦null

false

none

»» delimiter

body

string¦null

false

none

»» compPlanId

body

string¦null

false

none

»» payeeId

body

string¦null

false

none

»» period

body

string¦null

false

none

»» periodLevel

body

string¦null

false

none

»» payeeMajorDim

body

boolean¦null

false

none

»» mailWebUsers

body

boolean¦null

false

none

»» recipients

body

[string]¦null

false

none

»» emailSubject

body

string¦null

false

none

»» emailBody

body

string¦null

false

none

»» singleWorkbook

body

boolean¦null

false

none

»» fileName

body

string¦null

false

none

»» headerImage

body

string¦null

false

none

»» numberPages

body

boolean¦null

false

none

»» showTotalPageNumber

body

boolean¦null

false

none

»» portraitOrientation

body

boolean¦null

false

none

»» autoScale

body

boolean¦null

false

none

»» customScaleValue

body

number(double)¦null

false

none

»» tableViewportWidth

body

number(double)¦null

false

none

»» footerText

body

string¦null

false

none

»» mergePdfFiles

body

boolean¦null

false

none

»» expandAllTableGroups

body

boolean¦null

false

none

»» user

body

string¦null

false

none

»» password

body

string¦null

false

none

»» token

body

string¦null

false

none

»» table

body

string¦null

false

none

»» sandbox

body

boolean¦null

false

none

»» dateFormat

body

string¦null

false

none

»» header

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»» alignment

body

string

false

none

»»» backColor

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»»» a

body

integer(int32)

false

none

»»»» b

body

integer(int32)

false

none

»»»» g

body

integer(int32)

false

none

»»»» r

body

integer(int32)

false

none

»»» font

body

Varicent.RESTAPI.v1.DTOs.FontDefinitionDTO

false

none

»»»» family

body

string¦null

false

none

»»»» size

body

number(float)

false

none

»»»» unit

body

string¦null

false

none

»»»» bold

body

boolean

false

none

»»»» italic

body

boolean

false

none

»»»» underline

body

boolean

false

none

»»»» strikeout

body

boolean

false

none

»»» foreColor

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»» row

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»» altRow

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»» webFormId

body

integer(int32)

false

none

»» workflowGroupId

body

integer(int32)

false

none

»» filterValues

body

object¦null

false

none

»»» additionalProperties

body

string¦null

false

none

»» webReportId

body

integer(int32)¦null

false

none

»» parameterValues

body

object¦null

false

none

»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» expressionType

body

string

false

none

»»»» cases

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» op

body

string¦null

false

none

»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»» constraintType

body

string

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» expressionType

body

string

false

none

»»»»»»» cases

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» arguments

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» condition

body

any

false

none

»»»»»»» trueValue

body

any

false

none

»»»»»»» falseValue

body

any

false

none

»»»»»»» isDate

body

boolean

false

none

»»»»»»» literalType

body

string

false

none

»»»»»»» value

body

any

false

none

»»»»»» caseSensitive

body

boolean

false

none

»»»»»» constraints

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» literalRight

body

any

false

none

»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»» right

body

any

false

none

»»»»»» expressionLeft

body

any

false

none

»»»»»» expressionRight

body

any

false

none

»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»» like

body

string¦null

false

none

»»»»»» escapeWildcards

body

boolean

false

none

»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» queryDefinitionRight

body

any

false

none

»»»»» trueValue

body

any

false

none

»»»»» falseValue

body

any

false

none

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» isDate

body

boolean

false

none

»»»» literalType

body

string

false

none

»»»» value

body

any

false

none

»» currentUserId

body

string¦null

false

none

»» isBatchExport

body

boolean

false

none

»» batchExportPayeeList

body

[string]¦null

false

none

»» hiddenColumnMap

body

object¦null

false

none

»»» additionalProperties

body

[string]¦null

false

none

»» batchPicklistRefParam

body

string¦null

false

none

»» bpmPublishType

body

string

false

none

»» workflowId

body

integer(int32)

false

none

»» tokenId

body

integer(int32)

false

none

»» timezoneOffset

body

string¦null

false

none

»» offset

body

integer(int32)

false

none

»» limit

body

integer(int32)

false

none

»» orderBy

body

string¦null

false

none

»» queryToolId

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» fromDataServer

body

string

false

none

»» queryString

body

string¦null

false

none

»» description

body

string¦null

false

none

»» timeout

body

integer(int32)

false

none

»» presenterFlexReportId

body

integer(int32)¦null

false

none

»» webTabId

body

integer(int32)¦null

false

none

»» currentPayeeId

body

string¦null

false

none

»» batchExportPayeeIds

body

[string]¦null

false

none

»» bpmTokenId

body

integer(int32)¦null

false

none

»» planApprovalTemplateId

body

integer(int32)

false

none

»» planApprovalStatus

body

string

false

none

»» planDocumentId

body

integer(int32)

false

none

»» payeeWorkflowStatus

body

string

false

none

»» planBuilderCalculationId

body

string¦null

false

none

»» planBuilderCalculationName

body

string¦null

false

none

»» requirementIds

body

[string]¦null

false

none

»» requirementExportAll

body

boolean

false

none

»» requirementExportTitle

body

string¦null

false

none

»» requirementfilter

body

string¦null

false

none

»» requirementOrderBy

body

string¦null

false

none

» isTemporary

body

boolean

false

none

» enableScreenshot

body

boolean

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

» publishType

CalculationExcel

» publishType

CalculationMSCRM

» publishType

CalculationPdf

» publishType

CalculationSalesforce

» publishType

CalculationText

» publishType

CustomTableExcel

» publishType

CustomTableMSCRM

» publishType

CustomTablePdf

» publishType

CustomTableSalesforce

» publishType

CustomTableText

» publishType

WebFormPdf

» publishType

WebReportPdf

» publishType

BPMExcel

» publishType

PortExcel

» publishType

PortPdf

» publishType

PortSalesforce

» publishType

PortText

» publishType

PerformanceExcel

» publishType

PerformancePdf

» publishType

PerformanceSalesforce

» publishType

PerformanceText

» publishType

PayeeWebWebReportPdf

» publishType

DataStoreText

» publishType

DataStoreExcel

» publishType

QueryToolText

» publishType

QueryToolExcel

» publishType

CalculationCOS

» publishType

CustomTableCOS

» publishType

PortCOS

» publishType

PerformanceCOS

» publishType

PresenterFlexPdf

» publishType

PayeeWebPresenterFlexPdf

» publishType

HealthDashboardExcel

» publishType

PlanDocumentPdf

» publishType

StandardReportPdf

» publishType

BulkPlanDocumentsZip

» publishType

MassPlanDocumentDownloadZip

» publishType

AdminPresenterFlexPdf

» publishType

PlanDocument2Pdf

» publishType

PlanBuilderCalculationExcel

» publishType

PlanBuilderCalculationMSCRM

» publishType

PlanBuilderCalculationPdf

» publishType

PlanBuilderCalculationSalesforce

» publishType

PlanBuilderCalculationText

» publishType

PlanBuilderCalculationCOS

» publishType

RequirementPdf

»» type

Calculation

»» type

ColumnMap

»» type

CustomTable

»» type

Delimited

»» type

Email

»» type

Excel

»» type

File

»» type

MSCRM

»» type

Pdf

»» type

Performance

»» type

Salesforce

»» type

TableStyle

»» type

WebForm

»» type

WebReport

»» type

WebReportView

»» type

BPM

»» type

Port

»» type

DataStore

»» type

QueryTool

»» type

PresenterFlex

»» type

PresenterFlexView

»» type

PlanDocument

»» type

StandardReport

»» type

BulkPlanDocuments

»» type

PlanDocumentDownload

»» type

PlanDocument2

»» type

PlanBuilderCalculation

»» type

Requirement

»»» direction

Ascending

»»» direction

Descending

»»» direction

AscendingNullsFirst

»»» direction

DescendingNullsLast

»» dateFormat

Default

»» dateFormat

DayFirst

»» dateFormat

MonthFirst

»»» alignment

Justify

»»» alignment

Left

»»» alignment

Center

»»» alignment

Right

»»»» expressionType

caseExpression

»»»» expressionType

dataField

»»»» expressionType

function

»»»» expressionType

ifExpression

»»»» expressionType

literal

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» constraintType

clause

»»»»»» constraintType

constraint

»»»»»» constraintType

expressionConstraint

»»»»»» constraintType

likeConstraint

»»»»»» constraintType

rowVersionConstraint

»»»»»» constraintType

subQueryConstraint

»»»»»»» expressionType

caseExpression

»»»»»»» expressionType

dataField

»»»»»»» expressionType

function

»»»»»»» expressionType

ifExpression

»»»»»»» expressionType

literal

»»»»»»» literalType

Integer

»»»»»»» literalType

Decimal

»»»»»»» literalType

Date

»»»»»»» literalType

DateTime

»»»»»»» literalType

String

»»»»»»» literalType

Float

»»»»»»» literalType

Long

»»»»»»» literalType

Null

»»»»»»» literalType

Parameter

»»»»»»» literalType

Guid

»»»»»»» literalType

SystemUtcTime

»»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» literalType

Integer

»»»» literalType

Decimal

»»»» literalType

Date

»»»» literalType

DateTime

»»»» literalType

String

»»»» literalType

Float

»»»» literalType

Long

»»»» literalType

Null

»»»» literalType

Parameter

»»»» literalType

Guid

»»»» literalType

SystemUtcTime

»»»» literalType

Boolean

»» bpmPublishType

History

»» bpmPublishType

PendingActions

»» bpmPublishType

ActionNodeErrors

»» bpmPublishType

AlertNodeErrors

»» bpmPublishType

ServiceNodeErrors

»» bpmPublishType

SignNodeErrors

»» bpmPublishType

StatusReport

»» fromDataServer

QUERY_SQL

»» fromDataServer

QUERY_SPARK

»» fromDataServer

QUERY_PRESTO

»» planApprovalStatus

Selected

»» planApprovalStatus

PreManagerApproval

»» planApprovalStatus

PayeeSign

»» planApprovalStatus

Complete

»» payeeWorkflowStatus

InProgress

»» payeeWorkflowStatus

Complete

»» payeeWorkflowStatus

Cancelled

Responses

Status

Meaning

Description

Schema

202

Accepted

Run local publication

Inline

Response Schema

Status Code 202

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/publish", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/publish");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "publisherId": 0,
  "name": "string",
  "publishType": "CalculationExcel",
  "location": "string",
  "publisherParams": [
    {
      "type": "Calculation",
      "calculationId": 0,
      "calculationName": "string",
      "portId": 0,
      "columnMap": {},
      "customTableName": "string",
      "filter": "string",
      "inputFormID": 0,
      "columns": "string",
      "headerRow": "string",
      "compress": true,
      "customOrderBy": [],
      "columnFormat": [],
      "columnWithDescription": [],
      "dataStoreName": "string",
      "delimiter": "string",
      "compPlanId": "string",
      "payeeId": "string",
      "period": "string",
      "periodLevel": "string",
      "payeeMajorDim": true,
      "mailWebUsers": true,
      "recipients": [],
      "emailSubject": "string",
      "emailBody": "string",
      "singleWorkbook": true,
      "fileName": "string",
      "headerImage": "string",
      "numberPages": true,
      "showTotalPageNumber": true,
      "portraitOrientation": true,
      "autoScale": true,
      "customScaleValue": 0.1,
      "tableViewportWidth": 0.1,
      "footerText": "string",
      "mergePdfFiles": true,
      "expandAllTableGroups": true,
      "user": "string",
      "password": "string",
      "token": "string",
      "table": "string",
      "sandbox": true,
      "dateFormat": "Default",
      "header": {},
      "row": {},
      "altRow": {},
      "webFormId": 0,
      "workflowGroupId": 0,
      "filterValues": {},
      "webReportId": 0,
      "parameterValues": {},
      "currentUserId": "string",
      "isBatchExport": true,
      "batchExportPayeeList": [],
      "hiddenColumnMap": {},
      "batchPicklistRefParam": "string",
      "bpmPublishType": "History",
      "workflowId": 0,
      "tokenId": 0,
      "timezoneOffset": "string",
      "offset": 0,
      "limit": 0,
      "orderBy": "string",
      "queryToolId": 0,
      "name": "string",
      "fromDataServer": "QUERY_SQL",
      "queryString": "string",
      "description": "string",
      "timeout": 0,
      "presenterFlexReportId": 0,
      "webTabId": 0,
      "currentPayeeId": "string",
      "batchExportPayeeIds": [],
      "bpmTokenId": 0,
      "planApprovalTemplateId": 0,
      "planApprovalStatus": "Selected",
      "planDocumentId": 0,
      "payeeWorkflowStatus": "InProgress",
      "planBuilderCalculationId": "string",
      "planBuilderCalculationName": "string",
      "requirementIds": [],
      "requirementExportAll": true,
      "requirementExportTitle": "string",
      "requirementfilter": "string",
      "requirementOrderBy": "string"
    }
  ],
  "isTemporary": true,
  "enableScreenshot": true,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/publish',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/publish', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/publish',
  params: {
  }, headers: headers

p JSON.parse(result)

Get all published files contents.

Parameters

Name

In

Type

Required

Description

filter

query

string

false

####Supported operations

orderBy

query

string

false

####Description

limit

query

integer(int32)

false

Number of records to retrieve.

Detailed descriptions

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

filename, fileextension, location, createdat

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

uuid, filename, fileextension, location, createdat, expiresat

limit: Number of records to retrieve.

Default: 0

Responses

Status

Meaning

Description

Schema

200

OK

Get all published files contents

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/publishedfilescontents", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/publishedfilescontents");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/publishedfilescontents',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.get('http://localhost:8080/api/v1/publishedfilescontents')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.get 'http://localhost:8080/api/v1/publishedfilescontents',
  params: {
  }

p JSON.parse(result)

List all published files. An empty GUID will be reported for files with no associated database entry,

namely files which were not created through the API.

Parameters

Name

In

Type

Required

Description

filter

query

string

false

####Supported operations

orderBy

query

string

false

####Description

Detailed descriptions

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

filename, fileextension, location

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

uuid, filename, fileextension, location, createdat, expiresat

Responses

Status

Meaning

Description

Schema

200

OK

List all published files

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.Publisher.PublishedFileDTO]

false

none

none

» uuid

string(uuid)

false

none

none

» fileName

string¦null

false

none

none

» fileExtension

string¦null

false

none

none

» location

string¦null

false

none

none

» createdAt

string(date-time)

false

none

none

» expiresAt

string(date-time)¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/publishedfiles", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/publishedfiles");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/publishedfiles',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/publishedfiles', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/publishedfiles',
  params: {
  }, headers: headers

p JSON.parse(result)

Delete all published files.

Responses

Status

Meaning

Description

Schema

200

OK

Delete all published files

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/publishedfiles", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/publishedfiles");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/publishedfiles',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/publishedfiles')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/publishedfiles',
  params: {
  }

p JSON.parse(result)

Gets root node of file tree structure. An empty GUID will be reported for files with no associated database entry,

namely files which were not created through the API.

Parameters

Name

In

Type

Required

Description

filter

query

string

false

####Supported operations

orderBy

query

string

false

####Description

Detailed descriptions

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

fullname

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

uuid, filename, fileextension, location, createdat, expiresat

Responses

Status

Meaning

Description

Schema

200

OK

Gets root node of file tree structure

RESTAPI.v1.DTOs.Publisher.PublishedNodeDTORESTAPI.v1.DTOs.Publisher.PublishedNodeDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/publishednode", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/publishednode");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/publishednode',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/publishednode', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/publishednode',
  params: {
  }, headers: headers

p JSON.parse(result)

Delete a published file by UUID.

Parameters

Name

In

Type

Required

Description

uuid

path

string(uuid)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Delete a published file by uuid

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/publishedfiles/{uuid}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/publishedfiles/{uuid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/publishedfiles/{uuid}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/publishedfiles/{uuid}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/publishedfiles/{uuid}',
  params: {
  }

p JSON.parse(result)

Get a published file by UUID.

Parameters

Name

In

Type

Required

Description

uuid

path

string(uuid)

true

Published File UUID

Responses

Status

Meaning

Description

Schema

200

OK

Download Published File by UUID

Varicent.RESTAPI.v1.DTOs.FileContentDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/publishedfiles/{uuid}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/publishedfiles/{uuid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/publishedfiles/{uuid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/publishedfiles/{uuid}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/publishedfiles/{uuid}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "filename": "string",
  "data64": "string"
}
{"filename":"string","data64":"string"}

Delete a payee’s published file by UUID.

Parameters

Name

In

Type

Required

Description

uuid

path

string(uuid)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Delete a published file by uuid

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/payee/publishedfiles/{uuid}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payee/publishedfiles/{uuid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/payee/publishedfiles/{uuid}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/payee/publishedfiles/{uuid}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/payee/publishedfiles/{uuid}',
  params: {
  }

p JSON.parse(result)

Delete a published file by filename.

Parameters

Name

In

Type

Required

Description

filename

path

string

true

none

location

query

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Delete a published file by filename

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/publishedfiles/filename/{filename}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/publishedfiles/filename/{filename}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/publishedfiles/filename/{filename}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/publishedfiles/filename/{filename}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/publishedfiles/filename/{filename}',
  params: {
  }

p JSON.parse(result)

Get a published file by filename.

Parameters

Name

In

Type

Required

Description

filename

path

string

true

Published File Name

location

query

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Download Published File by Filename

Varicent.RESTAPI.v1.DTOs.FileContentDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/publishedfiles/filename/{filename}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/publishedfiles/filename/{filename}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/publishedfiles/filename/{filename}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/publishedfiles/filename/{filename}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/publishedfiles/filename/{filename}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "filename": "string",
  "data64": "string"
}
{"filename":"string","data64":"string"}

Get a published file by UUID as a binary stream.

Parameters

Name

In

Type

Required

Description

uuid

path

string(uuid)

true

Published File UUID

Responses

Status

Meaning

Description

Schema

200

OK

Download Published File by UUID

System.Net.Http.StreamContent

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/publishedfilestream/{uuid}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/publishedfilestream/{uuid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/publishedfilestream/{uuid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/publishedfilestream/{uuid}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/publishedfilestream/{uuid}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "headers": [
    {
      "key": "string",
      "value": []
    }
  ]
}
{"headers":[{"key":"string","value":[]}]}

Get a file as a binary stream.

Parameters

Name

In

Type

Required

Description

fileName

query

string

false

Target file name with path

displayName

query

string

false

The filename displayed in Content-Disposition

compress

query

boolean

false

Whether to compress the file into a zip

Responses

Status

Meaning

Description

Schema

200

OK

Payee Download File

System.Net.Http.StreamContent

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/payee/tsapi/downloadfile", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payee/tsapi/downloadfile");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/payee/tsapi/downloadfile',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/payee/tsapi/downloadfile', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/payee/tsapi/downloadfile',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "headers": [
    {
      "key": "string",
      "value": []
    }
  ]
}
{"headers":[{"key":"string","value":[]}]}

Upload a file as a binary stream.

Parameters

Name

In

Type

Required

Description

overwrite

query

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Upload File

string

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/payee/tsapi/uploadfile", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payee/tsapi/uploadfile");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/payee/tsapi/uploadfile',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/payee/tsapi/uploadfile', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/payee/tsapi/uploadfile',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
"string"
"string"

Get a published file by filename as a binary stream.

Parameters

Name

In

Type

Required

Description

filename

path

string

true

Published File Name

location

query

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Download Published File by Filename

System.Net.Http.StreamContent

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/publishedfilestream/filename/{filename}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/publishedfilestream/filename/{filename}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/publishedfilestream/filename/{filename}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/publishedfilestream/filename/{filename}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/publishedfilestream/filename/{filename}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "headers": [
    {
      "key": "string",
      "value": []
    }
  ]
}
{"headers":[{"key":"string","value":[]}]}

Get a salesforce table preview.

Body parameter

{
  "username": "string",
  "password": "string",
  "token": "string",
  "sandbox": true
}

Parameters

Name

In

Type

Required

Description

table

path

string

true

none

limit

query

integer(int32)

false

Number of records to retrieve.

body

body

RESTAPI.v1.DTOs.Composer.DataImport.SalesforceConfigDTO

false

DTO containing the login info for Salesforce

» username

body

string¦null

false

none

» password

body

string¦null

false

none

» token

body

string¦null

false

none

» sandbox

body

boolean

false

none

Detailed descriptions

limit: Number of records to retrieve.

Default: max number of rows to return

Responses

Status

Meaning

Description

Schema

200

OK

Get Salesforce table preview

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/salesforce/tables/{table}/preview", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/salesforce/tables/{table}/preview");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "username": "string",
  "password": "string",
  "token": "string",
  "sandbox": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/salesforce/tables/{table}/preview',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/salesforce/tables/{table}/preview', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/salesforce/tables/{table}/preview',
  params: {
  }, headers: headers

p JSON.parse(result)

Row Viewer

DataControllerV1_GetTableData

Parameters

Name

In

Type

Required

Description

table

path

string

true

none

id

path

integer(int32)

true

none

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

filter

query

string

false

####Supported operations

fields

query

string

false

Comma delimited list of fields to display. Used to limit the output results to selected columns.

unique

query

boolean

false

Boolean value to select only unique values. Default value is false.

effectiveDate

query

string(date-time)

false

none

pinnedFilter

query

string

false

none

pinnedColumn

query

string

false

none

rowViewerExport

query

boolean

false

none

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

Any column

fields: Comma delimited list of fields to display. Used to limit the output results to selected columns.

Defaults to all available fields.

Examples

fields=PayeeID_

unique: Boolean value to select only unique values. Default value is false. When enabled, must specify exactly one column field.

Responses

Status

Meaning

Description

Schema

200

OK

Get data, ordered by key column, for given table (limit, offset, filter supported)

Varicent.RESTAPI.v1.DTOs.ResultSetDTOVaricent.RESTAPI.v1.DTOs.ResultSetDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/datav2", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/datav2");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/datav2',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/datav2', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/datav2',
  params: {
  }, headers: headers

p JSON.parse(result)

Get data for the given table.

Notice that this endpoint doesn’t have a parameter to specify a custom order. This is intentional and was done for performance reasons to prevent users from abusing the order on large tables hurting performance significantly.

Parameters

Name

In

Type

Required

Description

table

path

string

true

The custom table name.

id

path

integer(int32)

true

Input form ID.

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

filter

query

string

false

####Supported operations

fields

query

string

false

Comma delimited list of fields to display. Used to limit the output results to selected columns.

unique

query

boolean

false

Boolean value to select only unique values. Default value is false.

effectiveDate

query

string(date-time)

false

For effectively dated tables, keep this empty to view all data. Specify a date to view the data at a certain point in time.

pinnedFilter

query

string

false

none

pinnedColumn

query

string

false

none

awsEstimated

query

boolean

false

none

rowViewerExport

query

boolean

false

none

includeLastUpdatedTrackingColumns

query

boolean

false

none

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

Any column

fields: Comma delimited list of fields to display. Used to limit the output results to selected columns.

Defaults to all available fields.

Examples

fields=PayeeID_

unique: Boolean value to select only unique values. Default value is false. When enabled, must specify exactly one column field.

effectiveDate: For effectively dated tables, keep this empty to view all data. Specify a date to view the data at a certain point in time. For regular tables this parameter is ignored.

Responses

Status

Meaning

Description

Schema

200

OK

Get data, ordered by key column, for given table (limit, offset, filter supported)

Varicent.RESTAPI.v1.DTOs.ResultSetDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data',
  params: {
  }, headers: headers

p JSON.parse(result)

Insert one row to a given table.

Body parameter

{
  "overwrite": true,
  "effectiveDate": {},
  "rows": [
    null
  ]
}

Parameters

Name

In

Type

Required

Description

table

path

string

true

The custom table name.

id

path

integer(int32)

true

The input form ID.

excelAddIn

query

boolean

false

none

body

body

Varicent.RESTAPI.v1.DTOs.RowViewerWriteDTO

false

Row Viewer Write DTO

» overwrite

body

boolean¦null

false

none

» effectiveDate

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

» rows

body

[any]¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Insert data to the given table

None

409

Conflict

Resolve overwrite conflicts

Varicent.RESTAPI.v1.DTOs.RowViewerOverwriteDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "overwrite": true,
  "effectiveDate": {},
  "rows": [
    null
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "columnDefinitions": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "existingRows": [
    null
  ],
  "overwriteRows": [
    null
  ],
  "endDateChanged": true
}
{"columnDefinitions":[{"name":"string","type":"String","isKey":true,"nullable":true,"values":"string","lockedPeriod":{},"referencedCol":"string","picklistFilter":"string","displayName":"string","isELTPeriod":true}],"existingRows":[null],"overwriteRows":[null],"endDateChanged":true}

Delete rows from a given table.

Body parameter

{
  "overwrite": true,
  "effectiveDate": {},
  "rows": [
    null
  ]
}

Parameters

Name

In

Type

Required

Description

table

path

string

true

The custom table name.

id

path

integer(int32)

true

The input form ID.

body

body

Varicent.RESTAPI.v1.DTOs.RowViewerWriteDTO

false

Row Viewer Write DTO

» overwrite

body

boolean¦null

false

none

» effectiveDate

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

» rows

body

[any]¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Delete the given row from given table

None

409

Conflict

Resolve overwrite conflicts

Varicent.RESTAPI.v1.DTOs.RowViewerOverwriteDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "overwrite": true,
  "effectiveDate": {},
  "rows": [
    null
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.delete('http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.delete 'http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "columnDefinitions": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "existingRows": [
    null
  ],
  "overwriteRows": [
    null
  ],
  "endDateChanged": true
}
{"columnDefinitions":[{"name":"string","type":"String","isKey":true,"nullable":true,"values":"string","lockedPeriod":{},"referencedCol":"string","picklistFilter":"string","displayName":"string","isELTPeriod":true}],"existingRows":[null],"overwriteRows":[null],"endDateChanged":true}

Update one row from a given table.

Body parameter

{
  "oldRows": [
    null
  ],
  "overwrite": true,
  "effectiveDate": {},
  "rows": [
    null
  ]
}

Parameters

Name

In

Type

Required

Description

table

path

string

true

The custom table name.

id

path

integer(int32)

true

the input form ID.

body

body

Varicent.RESTAPI.v1.DTOs.RowViewerUpdateDTO

false

Row Viewer Update DTO

» oldRows

body

[any]¦null

false

none

» overwrite

body

boolean¦null

false

none

» effectiveDate

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

» rows

body

[any]¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Update the given row from given table

None

409

Conflict

Resolve overwrite conflicts

Varicent.RESTAPI.v1.DTOs.RowViewerOverwriteDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "oldRows": [
    null
  ],
  "overwrite": true,
  "effectiveDate": {},
  "rows": [
    null
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "columnDefinitions": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "existingRows": [
    null
  ],
  "overwriteRows": [
    null
  ],
  "endDateChanged": true
}
{"columnDefinitions":[{"name":"string","type":"String","isKey":true,"nullable":true,"values":"string","lockedPeriod":{},"referencedCol":"string","picklistFilter":"string","displayName":"string","isELTPeriod":true}],"existingRows":[null],"overwriteRows":[null],"endDateChanged":true}

Update multiple rows from a given table.

Body parameter

{
  "oldRows": [
    null
  ],
  "overwrite": [
    true
  ],
  "selectedColumns": [
    "string"
  ],
  "ignoreOriginalRows": true,
  "effectiveDate": {},
  "rows": [
    null
  ]
}

Parameters

Name

In

Type

Required

Description

table

path

string

true

The custom table name.

body

body

Varicent.RESTAPI.v1.DTOs.RowViewerPatchDTO

false

Row Viewer Patch DTO

» oldRows

body

[any]¦null

false

none

» overwrite

body

[boolean]¦null

false

none

» selectedColumns

body

[string]¦null

false

none

» ignoreOriginalRows

body

boolean¦null

false

none

» effectiveDate

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

» rows

body

[any]¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Update the given rows from given table

None

409

Conflict

Resolve overwrite conflicts

Varicent.RESTAPI.v1.DTOs.RowViewerPatchOverwriteDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/payee/tsapi/tabledata/{table}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payee/tsapi/tabledata/{table}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "oldRows": [
    null
  ],
  "overwrite": [
    true
  ],
  "selectedColumns": [
    "string"
  ],
  "ignoreOriginalRows": true,
  "effectiveDate": {},
  "rows": [
    null
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/payee/tsapi/tabledata/{table}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/payee/tsapi/tabledata/{table}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/payee/tsapi/tabledata/{table}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "columnDefinitions": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "existingRows": [
    [
      null
    ]
  ],
  "overwriteRows": [
    [
      null
    ]
  ]
}
{"columnDefinitions":[{"name":"string","type":"String","isKey":true,"nullable":true,"values":"string","lockedPeriod":{},"referencedCol":"string","picklistFilter":"string","displayName":"string","isELTPeriod":true}],"existingRows":[[null]],"overwriteRows":[[null]]}

Retrieves entries from the reference table’s ID column in the

following order: - The exact match of the search string (if it exists) - Entries which start with the search string - Any other entries which contain the search string If a non-picklist column is selected, the table itself is used.

Parameters

Name

In

Type

Required

Description

tablename

path

string

true

The custom table name.

columnname

path

string

true

The picklist column name.

filter

query

string

false

The string to search for.

limit

query

integer(int32)

false

The maximum number of rows to return.

effectiveDate

query

string(date-time)

false

none

Detailed descriptions

filter: The string to search for. ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka in; userType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b], (a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

limit: The maximum number of rows to return. Number of records to retrieve.

Default: 50

Responses

Status

Meaning

Description

Schema

200

OK

Get table data, ordered by the most relevant results, for the given table’s picklist column (limit supported)

Varicent.RESTAPI.v1.DTOs.ResultSetDTO Varicent.RESTAPI.v1.DTOs.ResultSetDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/customtables/{tablename}/picklist/{columnName}/ids", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtables/{tablename}/picklist/{columnName}/ids");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/customtables/{tablename}/picklist/{columnName}/ids',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/customtables/{tablename}/picklist/{columnName}/ids', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/customtables/{tablename}/picklist/{columnName}/ids',
  params: {
  }, headers: headers

p JSON.parse(result)

Insert multiple rows into a given table.

Body parameter

{
  "overwrite": [
    true
  ],
  "selectedColumns": [
    "string"
  ],
  "ignoreOriginalRows": true,
  "effectiveDate": {},
  "rows": [
    null
  ]
}

Parameters

Name

In

Type

Required

Description

table

path

string

true

The custom table name.

body

body

Varicent.RESTAPI.v1.DTOs.RowViewerMultiRowWriteDTO

false

The data to insert.

» overwrite

body

[boolean]¦null

false

none

» selectedColumns

body

[string]¦null

false

none

» ignoreOriginalRows

body

boolean¦null

false

none

» effectiveDate

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

» rows

body

[any]¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Insert the given rows into the given table

None

409

Conflict

Resolve overwrite conflicts

Varicent.RESTAPI.v1.DTOs.RowViewerPatchOverwriteDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/payee/tsapi/tabledata/{table}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payee/tsapi/tabledata/{table}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "overwrite": [
    true
  ],
  "selectedColumns": [
    "string"
  ],
  "ignoreOriginalRows": true,
  "effectiveDate": {},
  "rows": [
    null
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/payee/tsapi/tabledata/{table}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/payee/tsapi/tabledata/{table}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/payee/tsapi/tabledata/{table}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "columnDefinitions": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "existingRows": [
    [
      null
    ]
  ],
  "overwriteRows": [
    [
      null
    ]
  ]
}
{"columnDefinitions":[{"name":"string","type":"String","isKey":true,"nullable":true,"values":"string","lockedPeriod":{},"referencedCol":"string","picklistFilter":"string","displayName":"string","isELTPeriod":true}],"existingRows":[[null]],"overwriteRows":[[null]]}

Insert multiple rows of data into a given table.

Body parameter

{
  "overwrite": [
    true
  ],
  "selectedColumns": [
    "string"
  ],
  "ignoreOriginalRows": true,
  "effectiveDate": {},
  "rows": [
    null
  ]
}

Parameters

Name

In

Type

Required

Description

table

path

string

true

The custom table name.

id

path

integer(int32)

true

The input form ID.

body

body

Varicent.RESTAPI.v1.DTOs.RowViewerMultiRowWriteDTO

false

The data to insert.

» overwrite

body

[boolean]¦null

false

none

» selectedColumns

body

[string]¦null

false

none

» ignoreOriginalRows

body

boolean¦null

false

none

» effectiveDate

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

» rows

body

[any]¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Insert multiple rows of data into a given table

None

409

Conflict

Resolve overwrite conflicts

Varicent.RESTAPI.v1.DTOs.RowViewerPatchOverwriteDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data/rows", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data/rows");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "overwrite": [
    true
  ],
  "selectedColumns": [
    "string"
  ],
  "ignoreOriginalRows": true,
  "effectiveDate": {},
  "rows": [
    null
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data/rows',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data/rows', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data/rows',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "columnDefinitions": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "existingRows": [
    [
      null
    ]
  ],
  "overwriteRows": [
    [
      null
    ]
  ]
}
{"columnDefinitions":[{"name":"string","type":"String","isKey":true,"nullable":true,"values":"string","lockedPeriod":{},"referencedCol":"string","picklistFilter":"string","displayName":"string","isELTPeriod":true}],"existingRows":[[null]],"overwriteRows":[[null]]}

Get the history of a given row from a given table.

Body parameter

{
  "timeId": "string",
  "rows": [
    null
  ]
}

Parameters

Name

In

Type

Required

Description

table

path

string

true

The custom table name.

id

path

integer(int32)

true

The input form ID.

body

body

Varicent.RESTAPI.v1.DTOs.RowViewerHistoryDTO

false

Row Viewer History DTO

» timeId

body

string¦null

false

none

» rows

body

[any]¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Get history of given row from given table

Varicent.RESTAPI.v1.DTOs.ResultSetDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data/history", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data/history");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "timeId": "string",
  "rows": [
    null
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data/history',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data/history', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data/history',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "columnDefinitions": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "data": [
    null
  ],
  "columnSourceMap": {
    "property1": "string",
    "property2": "string"
  },
  "isDataSynced": true,
  "hierarchyMetadata": {
    "tableName": "string",
    "idColumnName": "string",
    "parentColumnName": "string"
  }
}
{"columnDefinitions":[{"name":"string","type":"String","isKey":true,"nullable":true,"values":"string","lockedPeriod":{},"referencedCol":"string","picklistFilter":"string","displayName":"string","isELTPeriod":true}],"data":[null],"columnSourceMap":{"property1":"string","property2":"string"},"isDataSynced":true,"hierarchyMetadata":{"tableName":"string","idColumnName":"string","parentColumnName":"string"}}

Get the history of a given table.

Parameters

Name

In

Type

Required

Description

table

path

string

true

The custom table name.

id

path

integer(int32)

true

The input form ID.

historyid

path

integer(int32)

true

none

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

filter

query

string

false

####Supported operations

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

Any column

Responses

Status

Meaning

Description

Schema

200

OK

Get history of given table

Varicent.RESTAPI.v1.DTOs.TableHistoryDTOVaricent.RESTAPI.v1.DTOs.TableHistoryDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data/tablehistory/{historyid}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data/tablehistory/{historyid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data/tablehistory/{historyid}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data/tablehistory/{historyid}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data/tablehistory/{historyid}',
  params: {
  }, headers: headers

p JSON.parse(result)

Get row versions from an effective dated table.

Body parameter

{
  "rows": [
    null
  ]
}

Parameters

Name

In

Type

Required

Description

table

path

string

true

The custom table name.

id

path

integer(int32)

true

The input form ID.

body

body

Varicent.RESTAPI.v1.DTOs.RowViewerDTO

false

Row Viewer DTO

» rows

body

[any]¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Get version of given row

Varicent.RESTAPI.v1.DTOs.ResultSetDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data/version", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data/version");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "rows": [
    null
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data/version',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data/version', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data/version',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "columnDefinitions": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "data": [
    null
  ],
  "columnSourceMap": {
    "property1": "string",
    "property2": "string"
  },
  "isDataSynced": true,
  "hierarchyMetadata": {
    "tableName": "string",
    "idColumnName": "string",
    "parentColumnName": "string"
  }
}
{"columnDefinitions":[{"name":"string","type":"String","isKey":true,"nullable":true,"values":"string","lockedPeriod":{},"referencedCol":"string","picklistFilter":"string","displayName":"string","isELTPeriod":true}],"data":[null],"columnSourceMap":{"property1":"string","property2":"string"},"isDataSynced":true,"hierarchyMetadata":{"tableName":"string","idColumnName":"string","parentColumnName":"string"}}

Delete a row version from an effective dated table.

Body parameter

{
  "option": "None",
  "rows": [
    null
  ]
}

Parameters

Name

In

Type

Required

Description

table

path

string

true

The custom table name.

id

path

integer(int32)

true

The input form ID.

body

body

Varicent.RESTAPI.v1.DTOs.RowViewerVersionDTO

false

Row Viewer Version DTO

» option

body

string¦null

false

none

» rows

body

[any]¦null

false

none

Enumerated Values

Parameter

Value

» option

None

» option

FromPast

» option

FromFuture

Responses

Status

Meaning

Description

Schema

200

OK

Delete version of given row

None

409

Conflict

Confirm gap filling

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data/version", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data/version");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "option": "None",
  "rows": [
    null
  ]
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data/version',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.delete('http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data/version', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.delete 'http://localhost:8080/api/v1/customtables/{table}/inputforms/{id}/data/version',
  params: {
  }, headers: headers

p JSON.parse(result)

Get data for a given table.

Parameters

Name

In

Type

Required

Description

datastoreid

path

integer(int32)

true

DataStore ID

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

filter

query

string

false

####Supported operations

fields

query

string

false

Comma delimited list of fields to display. Used to limit the output results to selected columns.

unique

query

boolean

false

Comma delimited list of fields to display. Used to limit the output results to selected columns.

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

Any column

fields: Comma delimited list of fields to display. Used to limit the output results to selected columns.

Defaults to all available fields.

Examples

fields=PayeeID_

unique: Comma delimited list of fields to display. Used to limit the output results to selected columns.

Defaults to all available fields.

Examples

fields=PayeeID_

Responses

Status

Meaning

Description

Schema

200

OK

Get DataStore data, ordered by key column, for given DataStore ID (limit, offset, filter supported)

Varicent.RESTAPI.v1.DTOs.ResultSetDTO Varicent.RESTAPI.v1.DTOs.ResultSetDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/datastores/{datastoreid}/data", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/datastores/{datastoreid}/data");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/datastores/{datastoreid}/data',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/datastores/{datastoreid}/data', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/datastores/{datastoreid}/data',
  params: {
  }, headers: headers

p JSON.parse(result)

Sync data for a given table asynchronously.

Parameters

Name

In

Type

Required

Description

calcid

path

integer(int32)

true

none

filter

query

string

false

####Supported operations

fields

query

string

false

Comma delimited list of fields to display. Used to limit the output results to selected columns.

allowSync

query

boolean

false

none

partialSyncBack

query

boolean

false

none

pinnedFilter

query

string

false

none

pinnedColumn

query

string

false

none

isRowViewer

query

boolean

false

none

Detailed descriptions

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

Any column

fields: Comma delimited list of fields to display. Used to limit the output results to selected columns.

Defaults to all available fields.

Examples

fields=PayeeID_

Responses

Status

Meaning

Description

Schema

200

OK

Post request to sync calc as a live activity, for given Calculation ID

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/calculations/async/{calcid}/data", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/calculations/async/{calcid}/data");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/calculations/async/{calcid}/data',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/calculations/async/{calcid}/data', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/calculations/async/{calcid}/data',
  params: {
  }, headers: headers

p JSON.parse(result)

Get plan performance data

Parameters

Name

In

Type

Required

Description

dataStoreName

path

string

true

DataStore Name

planId

query

integer(int32)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Get Plan performance data, ordered by key column, for given DataStore name

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Plans.PlanPerformanceDTO]

false

none

none

» planId

integer(int32)

false

none

none

» componentId

integer(int32)

false

none

none

» period

string¦null

false

none

none

» credit

number(double)

false

none

none

» payout

number(double)

false

none

none

» currency

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/datastorelookup/{datastorename}/planperformance", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/datastorelookup/{datastorename}/planperformance");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/datastorelookup/{datastorename}/planperformance',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/datastorelookup/{datastorename}/planperformance', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/datastorelookup/{datastorename}/planperformance',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "planId": 0,
    "componentId": 0,
    "period": "string",
    "credit": 0.1,
    "payout": 0.1,
    "currency": "string"
  }
]
[{"planId":0,"componentId":0,"period":"string","credit":0.1,"payout":0.1,"currency":"string"}]

Get data for given port.

Parameters

Name

In

Type

Required

Description

portid

path

integer(int32)

true

Port ID

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

filter

query

string

false

####Supported operations

fields

query

string

false

Comma delimited list of fields to display. Used to limit the output results to selected columns.

unique

query

boolean

false

Boolean value to select only unique values. Default value is false.

pinnedFilter

query

string

false

none

pinnedColumn

query

string

false

none

picklist

query

boolean

false

none

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

any column

fields: Comma delimited list of fields to display. Used to limit the output results to selected columns.

Defaults to all available fields.

Examples

fields=PayeeID_

unique: Boolean value to select only unique values. Default value is false. When enabled, must specify exactly one column field.

Responses

Status

Meaning

Description

Schema

200

OK

Get Port data, ordered by key column, for given Port ID (limit, offset, filter supported)

Varicent.RESTAPI.v1.DTOs.ResultSetDTO Varicent.RESTAPI.v1.DTOs.ResultSetDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/ports/{portId}/data", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/ports/{portId}/data");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/ports/{portId}/data',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/ports/{portId}/data', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/ports/{portId}/data',
  params: {
  }, headers: headers

p JSON.parse(result)

Scheduler

Get schedule items.

Responses

Status

Meaning

Description

Schema

200

OK

Get the full schedule item heirarchy (all items and subitems)

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» scheduleItemType

string

false

none

none

» order

integer(int32)

false

none

none

» lastRun

string(date-time)

false

none

none

» lastRunStatus

string

false

none

none

» activation

string

false

none

none

» nextRun

string(date-time)

false

none

none

» parent

integer(int32)¦null

false

none

none

» scheduledTime

Varicent.RESTAPI.v1.DTOs.Scheduler.ScheduleTimeDTO

false

none

none

»» id

integer(int32)

false

none

none

»» scheduleItemId

integer(int32)

false

none

none

»» minute

integer(int32)

false

none

none

»» hour

integer(int32)

false

none

none

»» dayOfMonth

integer(int32)

false

none

none

»» month

integer(int32)

false

none

none

»» dayOfWeek

integer(int32)

false

none

none

»» nextRunTime

string(date-time)

false

none

none

»» isDSTAdjusted

boolean¦null

false

none

none

»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»» rowVersion

integer(int64)

false

none

none

» parentItem

any

false

none

none

» childScheduleItems

array¦null

false

none

none

»» anonymous

any

false

none

none

» settings

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

false

none

none

»» schedulerSettingsId

integer(int32)

false

none

none

»» scheduleItemId

integer(int32)¦null

false

none

none

»» parentSettingsID

integer(int32)¦null

false

none

none

»» emailOnFailure

boolean

false

none

none

»» emailOnSuccess

boolean

false

none

none

»» stopOnFailure

boolean

false

none

none

»» stopToolOnTimeout

boolean

false

none

none

»» isGlobal

boolean

false

none

none

»» overrideChildSettings

boolean

false

none

none

»» successEmails

[string]¦null

false

none

none

»» failEmails

[string]¦null

false

none

none

»» externalToolTimeout

integer(int32)

false

none

none

»» parentSettings

any

false

none

none

»» enableRetries

boolean

false

none

none

»» retries

integer(int32)¦null

false

none

none

»» interval

integer(int32)¦null

false

none

none

»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

» previousName

string¦null

false

none

none

» runInParallel

boolean

false

none

none

» externalItemID

string¦null

false

none

none

» ptzId

string¦null

false

none

none

Enumerated Values

Property

Value

scheduleItemType

Folder

scheduleItemType

Calculation

scheduleItemType

Import

scheduleItemType

ExternalTool

scheduleItemType

TaskGeneration

scheduleItemType

StarSchemaPopulation

scheduleItemType

LockPeriod

scheduleItemType

EnableWeb

scheduleItemType

DisableWeb

scheduleItemType

Plan

scheduleItemType

Transformation

scheduleItemType

ClearTable

scheduleItemType

Publish

scheduleItemType

WebReport

scheduleItemType

Optimize

scheduleItemType

TaskRun

scheduleItemType

AddWorkflowMembers

scheduleItemType

UnassignIdleInquiries

scheduleItemType

PurgeHistory

scheduleItemType

ExpiringPasswordEmailNotificationAdmin

scheduleItemType

ExpiringPasswordEmailNotificationWeb

scheduleItemType

EnableWebUsers

scheduleItemType

CloudExternalTool

scheduleItemType

CloudSystemTool

scheduleItemType

IndexRebuild

scheduleItemType

PublishQueryTool

scheduleItemType

CalculateAndLock

scheduleItemType

HealthDashboardEvaluation

scheduleItemType

CalculationComponent

scheduleItemType

RefreshMaterializedView

scheduleItemType

RemoveWorkflowMembers

scheduleItemType

ELTRun

scheduleItemType

CalculationPlanBuilder

lastRunStatus

Success

lastRunStatus

Warning

lastRunStatus

Error

lastRunStatus

Cancelled

lastRunStatus

None

activation

Enabled

activation

DisabledForNextScheduledRunOnly

activation

Disabled

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/scheduleitem", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/scheduleitem");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/scheduleitem',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/scheduleitem', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/scheduleitem',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "name": "string",
    "scheduleItemType": "Folder",
    "order": 0,
    "lastRun": "2019-08-24T14:15:22Z",
    "lastRunStatus": "Success",
    "activation": "Enabled",
    "nextRun": "2019-08-24T14:15:22Z",
    "parent": 0,
    "scheduledTime": {
      "id": 0,
      "scheduleItemId": 0,
      "minute": 0,
      "hour": 0,
      "dayOfMonth": 0,
      "month": 0,
      "dayOfWeek": 0,
      "nextRunTime": "2019-08-24T14:15:22Z",
      "isDSTAdjusted": true,
      "version": {}
    },
    "parentItem": null,
    "childScheduleItems": [],
    "settings": {
      "schedulerSettingsId": 0,
      "scheduleItemId": 0,
      "parentSettingsID": 0,
      "emailOnFailure": true,
      "emailOnSuccess": true,
      "stopOnFailure": true,
      "stopToolOnTimeout": true,
      "isGlobal": true,
      "overrideChildSettings": true,
      "successEmails": [],
      "failEmails": [],
      "externalToolTimeout": 0,
      "parentSettings": null,
      "enableRetries": true,
      "retries": 0,
      "interval": 0,
      "version": {}
    },
    "version": {
      "rowVersion": 0
    },
    "previousName": "string",
    "runInParallel": true,
    "externalItemID": "string",
    "ptzId": "string"
  }
]
[{"id":0,"name":"string","scheduleItemType":"Folder","order":0,"lastRun":"2019-08-24T14:15:22Z","lastRunStatus":"Success","activation":"Enabled","nextRun":"2019-08-24T14:15:22Z","parent":0,"scheduledTime":{"id":0,"scheduleItemId":0,"minute":0,"hour":0,"dayOfMonth":0,"month":0,"dayOfWeek":0,"nextRunTime":"2019-08-24T14:15:22Z","isDSTAdjusted":true,"version":{}},"parentItem":null,"childScheduleItems":[],"settings":{"schedulerSettingsId":0,"scheduleItemId":0,"parentSettingsID":0,"emailOnFailure":true,"emailOnSuccess":true,"stopOnFailure":true,"stopToolOnTimeout":true,"isGlobal":true,"overrideChildSettings":true,"successEmails":[],"failEmails":[],"externalToolTimeout":0,"parentSettings":null,"enableRetries":true,"retries":0,"interval":0,"version":{}},"version":{"rowVersion":0},"previousName":"string","runInParallel":true,"externalItemID":"string","ptzId":"string"}]

Create a new schedule item.

Body parameter

{
  "publishFolderPath": "string",
  "id": 0,
  "name": "string",
  "scheduleItemType": "Folder",
  "order": 0,
  "lastRun": "2019-08-24T14:15:22Z",
  "lastRunStatus": "Success",
  "activation": "Enabled",
  "nextRun": "2019-08-24T14:15:22Z",
  "parent": 0,
  "scheduledTime": {
    "id": 0,
    "scheduleItemId": 0,
    "minute": 0,
    "hour": 0,
    "dayOfMonth": 0,
    "month": 0,
    "dayOfWeek": 0,
    "nextRunTime": "2019-08-24T14:15:22Z",
    "isDSTAdjusted": true,
    "version": {
      "rowVersion": 0
    }
  },
  "parentItem": {
    "id": 0,
    "name": "string",
    "scheduleItemType": "Folder",
    "order": 0,
    "lastRun": "2019-08-24T14:15:22Z",
    "lastRunStatus": "Success",
    "activation": "Enabled",
    "nextRun": "2019-08-24T14:15:22Z",
    "parent": 0,
    "scheduledTime": {
      "id": 0,
      "scheduleItemId": 0,
      "minute": 0,
      "hour": 0,
      "dayOfMonth": 0,
      "month": 0,
      "dayOfWeek": 0,
      "nextRunTime": "2019-08-24T14:15:22Z",
      "isDSTAdjusted": true,
      "version": {}
    },
    "parentItem": null,
    "childScheduleItems": [],
    "settings": {
      "schedulerSettingsId": 0,
      "scheduleItemId": 0,
      "parentSettingsID": 0,
      "emailOnFailure": true,
      "emailOnSuccess": true,
      "stopOnFailure": true,
      "stopToolOnTimeout": true,
      "isGlobal": true,
      "overrideChildSettings": true,
      "successEmails": [],
      "failEmails": [],
      "externalToolTimeout": 0,
      "parentSettings": null,
      "enableRetries": true,
      "retries": 0,
      "interval": 0,
      "version": {}
    },
    "version": {
      "rowVersion": 0
    },
    "previousName": "string",
    "runInParallel": true,
    "externalItemID": "string",
    "ptzId": "string"
  },
  "childScheduleItems": [
    {
      "id": 0,
      "name": "string",
      "scheduleItemType": "Folder",
      "order": 0,
      "lastRun": "2019-08-24T14:15:22Z",
      "lastRunStatus": "Success",
      "activation": "Enabled",
      "nextRun": "2019-08-24T14:15:22Z",
      "parent": 0,
      "scheduledTime": {},
      "parentItem": null,
      "childScheduleItems": [],
      "settings": {},
      "version": {},
      "previousName": "string",
      "runInParallel": true,
      "externalItemID": "string",
      "ptzId": "string"
    }
  ],
  "settings": {
    "schedulerSettingsId": 0,
    "scheduleItemId": 0,
    "parentSettingsID": 0,
    "emailOnFailure": true,
    "emailOnSuccess": true,
    "stopOnFailure": true,
    "stopToolOnTimeout": true,
    "isGlobal": true,
    "overrideChildSettings": true,
    "successEmails": [
      "string"
    ],
    "failEmails": [
      "string"
    ],
    "externalToolTimeout": 0,
    "parentSettings": null,
    "enableRetries": true,
    "retries": 0,
    "interval": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "version": {
    "rowVersion": 0
  },
  "previousName": "string",
  "runInParallel": true,
  "externalItemID": "string",
  "ptzId": "string"
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Scheduler.ScheduleItemPublishDTO

false

none

» publishFolderPath

body

string¦null

false

none

» id

body

integer(int32)

false

none

» name

body

string¦null

false

none

» scheduleItemType

body

string

false

none

» order

body

integer(int32)

false

none

» lastRun

body

string(date-time)

false

none

» lastRunStatus

body

string

false

none

» activation

body

string

false

none

» nextRun

body

string(date-time)

false

none

» parent

body

integer(int32)¦null

false

none

» scheduledTime

body

Varicent.RESTAPI.v1.DTOs.Scheduler.ScheduleTimeDTO

false

none

»» id

body

integer(int32)

false

none

»» scheduleItemId

body

integer(int32)

false

none

»» minute

body

integer(int32)

false

none

»» hour

body

integer(int32)

false

none

»» dayOfMonth

body

integer(int32)

false

none

»» month

body

integer(int32)

false

none

»» dayOfWeek

body

integer(int32)

false

none

»» nextRunTime

body

string(date-time)

false

none

»» isDSTAdjusted

body

boolean¦null

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» rowVersion

body

integer(int64)

false

none

» parentItem

body

Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO

false

none

»» id

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» scheduleItemType

body

string

false

none

»» order

body

integer(int32)

false

none

»» lastRun

body

string(date-time)

false

none

»» lastRunStatus

body

string

false

none

»» activation

body

string

false

none

»» nextRun

body

string(date-time)

false

none

»» parent

body

integer(int32)¦null

false

none

»» scheduledTime

body

Varicent.RESTAPI.v1.DTOs.Scheduler.ScheduleTimeDTO

false

none

»» parentItem

body

any

false

none

»» childScheduleItems

body

array¦null

false

none

»»» anonymous

body

any

false

none

»» settings

body

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

false

none

»»» schedulerSettingsId

body

integer(int32)

false

none

»»» scheduleItemId

body

integer(int32)¦null

false

none

»»» parentSettingsID

body

integer(int32)¦null

false

none

»»» emailOnFailure

body

boolean

false

none

»»» emailOnSuccess

body

boolean

false

none

»»» stopOnFailure

body

boolean

false

none

»»» stopToolOnTimeout

body

boolean

false

none

»»» isGlobal

body

boolean

false

none

»»» overrideChildSettings

body

boolean

false

none

»»» successEmails

body

[string]¦null

false

none

»»» failEmails

body

[string]¦null

false

none

»»» externalToolTimeout

body

integer(int32)

false

none

»»» parentSettings

body

any

false

none

»»» enableRetries

body

boolean

false

none

»»» retries

body

integer(int32)¦null

false

none

»»» interval

body

integer(int32)¦null

false

none

»»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» previousName

body

string¦null

false

none

»» runInParallel

body

boolean

false

none

»» externalItemID

body

string¦null

false

none

»» ptzId

body

string¦null

false

none

» childScheduleItems

body

[Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO]¦null

false

none

» settings

body

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

» previousName

body

string¦null

false

none

» runInParallel

body

boolean

false

none

» externalItemID

body

string¦null

false

none

» ptzId

body

string¦null

false

none

Enumerated Values

Parameter

Value

» scheduleItemType

Folder

» scheduleItemType

Calculation

» scheduleItemType

Import

» scheduleItemType

ExternalTool

» scheduleItemType

TaskGeneration

» scheduleItemType

StarSchemaPopulation

» scheduleItemType

LockPeriod

» scheduleItemType

EnableWeb

» scheduleItemType

DisableWeb

» scheduleItemType

Plan

» scheduleItemType

Transformation

» scheduleItemType

ClearTable

» scheduleItemType

Publish

» scheduleItemType

WebReport

» scheduleItemType

Optimize

» scheduleItemType

TaskRun

» scheduleItemType

AddWorkflowMembers

» scheduleItemType

UnassignIdleInquiries

» scheduleItemType

PurgeHistory

» scheduleItemType

ExpiringPasswordEmailNotificationAdmin

» scheduleItemType

ExpiringPasswordEmailNotificationWeb

» scheduleItemType

EnableWebUsers

» scheduleItemType

CloudExternalTool

» scheduleItemType

CloudSystemTool

» scheduleItemType

IndexRebuild

» scheduleItemType

PublishQueryTool

» scheduleItemType

CalculateAndLock

» scheduleItemType

HealthDashboardEvaluation

» scheduleItemType

CalculationComponent

» scheduleItemType

RefreshMaterializedView

» scheduleItemType

RemoveWorkflowMembers

» scheduleItemType

ELTRun

» scheduleItemType

CalculationPlanBuilder

» lastRunStatus

Success

» lastRunStatus

Warning

» lastRunStatus

Error

» lastRunStatus

Cancelled

» lastRunStatus

None

» activation

Enabled

» activation

DisabledForNextScheduledRunOnly

» activation

Disabled

»» scheduleItemType

Folder

»» scheduleItemType

Calculation

»» scheduleItemType

Import

»» scheduleItemType

ExternalTool

»» scheduleItemType

TaskGeneration

»» scheduleItemType

StarSchemaPopulation

»» scheduleItemType

LockPeriod

»» scheduleItemType

EnableWeb

»» scheduleItemType

DisableWeb

»» scheduleItemType

Plan

»» scheduleItemType

Transformation

»» scheduleItemType

ClearTable

»» scheduleItemType

Publish

»» scheduleItemType

WebReport

»» scheduleItemType

Optimize

»» scheduleItemType

TaskRun

»» scheduleItemType

AddWorkflowMembers

»» scheduleItemType

UnassignIdleInquiries

»» scheduleItemType

PurgeHistory

»» scheduleItemType

ExpiringPasswordEmailNotificationAdmin

»» scheduleItemType

ExpiringPasswordEmailNotificationWeb

»» scheduleItemType

EnableWebUsers

»» scheduleItemType

CloudExternalTool

»» scheduleItemType

CloudSystemTool

»» scheduleItemType

IndexRebuild

»» scheduleItemType

PublishQueryTool

»» scheduleItemType

CalculateAndLock

»» scheduleItemType

HealthDashboardEvaluation

»» scheduleItemType

CalculationComponent

»» scheduleItemType

RefreshMaterializedView

»» scheduleItemType

RemoveWorkflowMembers

»» scheduleItemType

ELTRun

»» scheduleItemType

CalculationPlanBuilder

»» lastRunStatus

Success

»» lastRunStatus

Warning

»» lastRunStatus

Error

»» lastRunStatus

Cancelled

»» lastRunStatus

None

»» activation

Enabled

»» activation

DisabledForNextScheduledRunOnly

»» activation

Disabled

Responses

Status

Meaning

Description

Schema

201

Created

Create a new schedule item (task or folder)

Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/scheduleitempublish", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/scheduleitempublish");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "publishFolderPath": "string",
  "id": 0,
  "name": "string",
  "scheduleItemType": "Folder",
  "order": 0,
  "lastRun": "2019-08-24T14:15:22Z",
  "lastRunStatus": "Success",
  "activation": "Enabled",
  "nextRun": "2019-08-24T14:15:22Z",
  "parent": 0,
  "scheduledTime": {
    "id": 0,
    "scheduleItemId": 0,
    "minute": 0,
    "hour": 0,
    "dayOfMonth": 0,
    "month": 0,
    "dayOfWeek": 0,
    "nextRunTime": "2019-08-24T14:15:22Z",
    "isDSTAdjusted": true,
    "version": {
      "rowVersion": 0
    }
  },
  "parentItem": {
    "id": 0,
    "name": "string",
    "scheduleItemType": "Folder",
    "order": 0,
    "lastRun": "2019-08-24T14:15:22Z",
    "lastRunStatus": "Success",
    "activation": "Enabled",
    "nextRun": "2019-08-24T14:15:22Z",
    "parent": 0,
    "scheduledTime": {
      "id": 0,
      "scheduleItemId": 0,
      "minute": 0,
      "hour": 0,
      "dayOfMonth": 0,
      "month": 0,
      "dayOfWeek": 0,
      "nextRunTime": "2019-08-24T14:15:22Z",
      "isDSTAdjusted": true,
      "version": {}
    },
    "parentItem": null,
    "childScheduleItems": [],
    "settings": {
      "schedulerSettingsId": 0,
      "scheduleItemId": 0,
      "parentSettingsID": 0,
      "emailOnFailure": true,
      "emailOnSuccess": true,
      "stopOnFailure": true,
      "stopToolOnTimeout": true,
      "isGlobal": true,
      "overrideChildSettings": true,
      "successEmails": [],
      "failEmails": [],
      "externalToolTimeout": 0,
      "parentSettings": null,
      "enableRetries": true,
      "retries": 0,
      "interval": 0,
      "version": {}
    },
    "version": {
      "rowVersion": 0
    },
    "previousName": "string",
    "runInParallel": true,
    "externalItemID": "string",
    "ptzId": "string"
  },
  "childScheduleItems": [
    {
      "id": 0,
      "name": "string",
      "scheduleItemType": "Folder",
      "order": 0,
      "lastRun": "2019-08-24T14:15:22Z",
      "lastRunStatus": "Success",
      "activation": "Enabled",
      "nextRun": "2019-08-24T14:15:22Z",
      "parent": 0,
      "scheduledTime": {},
      "parentItem": null,
      "childScheduleItems": [],
      "settings": {},
      "version": {},
      "previousName": "string",
      "runInParallel": true,
      "externalItemID": "string",
      "ptzId": "string"
    }
  ],
  "settings": {
    "schedulerSettingsId": 0,
    "scheduleItemId": 0,
    "parentSettingsID": 0,
    "emailOnFailure": true,
    "emailOnSuccess": true,
    "stopOnFailure": true,
    "stopToolOnTimeout": true,
    "isGlobal": true,
    "overrideChildSettings": true,
    "successEmails": [
      "string"
    ],
    "failEmails": [
      "string"
    ],
    "externalToolTimeout": 0,
    "parentSettings": null,
    "enableRetries": true,
    "retries": 0,
    "interval": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "version": {
    "rowVersion": 0
  },
  "previousName": "string",
  "runInParallel": true,
  "externalItemID": "string",
  "ptzId": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/scheduleitempublish',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/scheduleitempublish', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/scheduleitempublish',
  params: {
  }, headers: headers

p JSON.parse(result)

Create a new Enable Web Users Schedule item.

Body parameter

{
  "portalAccessGroupId": 0,
  "defaultPwd": "string",
  "id": 0,
  "name": "string",
  "scheduleItemType": "Folder",
  "order": 0,
  "lastRun": "2019-08-24T14:15:22Z",
  "lastRunStatus": "Success",
  "activation": "Enabled",
  "nextRun": "2019-08-24T14:15:22Z",
  "parent": 0,
  "scheduledTime": {
    "id": 0,
    "scheduleItemId": 0,
    "minute": 0,
    "hour": 0,
    "dayOfMonth": 0,
    "month": 0,
    "dayOfWeek": 0,
    "nextRunTime": "2019-08-24T14:15:22Z",
    "isDSTAdjusted": true,
    "version": {
      "rowVersion": 0
    }
  },
  "parentItem": {
    "id": 0,
    "name": "string",
    "scheduleItemType": "Folder",
    "order": 0,
    "lastRun": "2019-08-24T14:15:22Z",
    "lastRunStatus": "Success",
    "activation": "Enabled",
    "nextRun": "2019-08-24T14:15:22Z",
    "parent": 0,
    "scheduledTime": {
      "id": 0,
      "scheduleItemId": 0,
      "minute": 0,
      "hour": 0,
      "dayOfMonth": 0,
      "month": 0,
      "dayOfWeek": 0,
      "nextRunTime": "2019-08-24T14:15:22Z",
      "isDSTAdjusted": true,
      "version": {}
    },
    "parentItem": null,
    "childScheduleItems": [],
    "settings": {
      "schedulerSettingsId": 0,
      "scheduleItemId": 0,
      "parentSettingsID": 0,
      "emailOnFailure": true,
      "emailOnSuccess": true,
      "stopOnFailure": true,
      "stopToolOnTimeout": true,
      "isGlobal": true,
      "overrideChildSettings": true,
      "successEmails": [],
      "failEmails": [],
      "externalToolTimeout": 0,
      "parentSettings": null,
      "enableRetries": true,
      "retries": 0,
      "interval": 0,
      "version": {}
    },
    "version": {
      "rowVersion": 0
    },
    "previousName": "string",
    "runInParallel": true,
    "externalItemID": "string",
    "ptzId": "string"
  },
  "childScheduleItems": [
    {
      "id": 0,
      "name": "string",
      "scheduleItemType": "Folder",
      "order": 0,
      "lastRun": "2019-08-24T14:15:22Z",
      "lastRunStatus": "Success",
      "activation": "Enabled",
      "nextRun": "2019-08-24T14:15:22Z",
      "parent": 0,
      "scheduledTime": {},
      "parentItem": null,
      "childScheduleItems": [],
      "settings": {},
      "version": {},
      "previousName": "string",
      "runInParallel": true,
      "externalItemID": "string",
      "ptzId": "string"
    }
  ],
  "settings": {
    "schedulerSettingsId": 0,
    "scheduleItemId": 0,
    "parentSettingsID": 0,
    "emailOnFailure": true,
    "emailOnSuccess": true,
    "stopOnFailure": true,
    "stopToolOnTimeout": true,
    "isGlobal": true,
    "overrideChildSettings": true,
    "successEmails": [
      "string"
    ],
    "failEmails": [
      "string"
    ],
    "externalToolTimeout": 0,
    "parentSettings": null,
    "enableRetries": true,
    "retries": 0,
    "interval": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "version": {
    "rowVersion": 0
  },
  "previousName": "string",
  "runInParallel": true,
  "externalItemID": "string",
  "ptzId": "string"
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Scheduler.ScheduleItemEnableWebUsersDTO

false

none

» portalAccessGroupId

body

integer(int32)

false

none

» defaultPwd

body

string¦null

false

none

» id

body

integer(int32)

false

none

» name

body

string¦null

false

none

» scheduleItemType

body

string

false

none

» order

body

integer(int32)

false

none

» lastRun

body

string(date-time)

false

none

» lastRunStatus

body

string

false

none

» activation

body

string

false

none

» nextRun

body

string(date-time)

false

none

» parent

body

integer(int32)¦null

false

none

» scheduledTime

body

Varicent.RESTAPI.v1.DTOs.Scheduler.ScheduleTimeDTO

false

none

»» id

body

integer(int32)

false

none

»» scheduleItemId

body

integer(int32)

false

none

»» minute

body

integer(int32)

false

none

»» hour

body

integer(int32)

false

none

»» dayOfMonth

body

integer(int32)

false

none

»» month

body

integer(int32)

false

none

»» dayOfWeek

body

integer(int32)

false

none

»» nextRunTime

body

string(date-time)

false

none

»» isDSTAdjusted

body

boolean¦null

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» rowVersion

body

integer(int64)

false

none

» parentItem

body

Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO

false

none

»» id

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» scheduleItemType

body

string

false

none

»» order

body

integer(int32)

false

none

»» lastRun

body

string(date-time)

false

none

»» lastRunStatus

body

string

false

none

»» activation

body

string

false

none

»» nextRun

body

string(date-time)

false

none

»» parent

body

integer(int32)¦null

false

none

»» scheduledTime

body

Varicent.RESTAPI.v1.DTOs.Scheduler.ScheduleTimeDTO

false

none

»» parentItem

body

any

false

none

»» childScheduleItems

body

array¦null

false

none

»»» anonymous

body

any

false

none

»» settings

body

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

false

none

»»» schedulerSettingsId

body

integer(int32)

false

none

»»» scheduleItemId

body

integer(int32)¦null

false

none

»»» parentSettingsID

body

integer(int32)¦null

false

none

»»» emailOnFailure

body

boolean

false

none

»»» emailOnSuccess

body

boolean

false

none

»»» stopOnFailure

body

boolean

false

none

»»» stopToolOnTimeout

body

boolean

false

none

»»» isGlobal

body

boolean

false

none

»»» overrideChildSettings

body

boolean

false

none

»»» successEmails

body

[string]¦null

false

none

»»» failEmails

body

[string]¦null

false

none

»»» externalToolTimeout

body

integer(int32)

false

none

»»» parentSettings

body

any

false

none

»»» enableRetries

body

boolean

false

none

»»» retries

body

integer(int32)¦null

false

none

»»» interval

body

integer(int32)¦null

false

none

»»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» previousName

body

string¦null

false

none

»» runInParallel

body

boolean

false

none

»» externalItemID

body

string¦null

false

none

»» ptzId

body

string¦null

false

none

» childScheduleItems

body

[Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO]¦null

false

none

» settings

body

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

» previousName

body

string¦null

false

none

» runInParallel

body

boolean

false

none

» externalItemID

body

string¦null

false

none

» ptzId

body

string¦null

false

none

Enumerated Values

Parameter

Value

» scheduleItemType

Folder

» scheduleItemType

Calculation

» scheduleItemType

Import

» scheduleItemType

ExternalTool

» scheduleItemType

TaskGeneration

» scheduleItemType

StarSchemaPopulation

» scheduleItemType

LockPeriod

» scheduleItemType

EnableWeb

» scheduleItemType

DisableWeb

» scheduleItemType

Plan

» scheduleItemType

Transformation

» scheduleItemType

ClearTable

» scheduleItemType

Publish

» scheduleItemType

WebReport

» scheduleItemType

Optimize

» scheduleItemType

TaskRun

» scheduleItemType

AddWorkflowMembers

» scheduleItemType

UnassignIdleInquiries

» scheduleItemType

PurgeHistory

» scheduleItemType

ExpiringPasswordEmailNotificationAdmin

» scheduleItemType

ExpiringPasswordEmailNotificationWeb

» scheduleItemType

EnableWebUsers

» scheduleItemType

CloudExternalTool

» scheduleItemType

CloudSystemTool

» scheduleItemType

IndexRebuild

» scheduleItemType

PublishQueryTool

» scheduleItemType

CalculateAndLock

» scheduleItemType

HealthDashboardEvaluation

» scheduleItemType

CalculationComponent

» scheduleItemType

RefreshMaterializedView

» scheduleItemType

RemoveWorkflowMembers

» scheduleItemType

ELTRun

» scheduleItemType

CalculationPlanBuilder

» lastRunStatus

Success

» lastRunStatus

Warning

» lastRunStatus

Error

» lastRunStatus

Cancelled

» lastRunStatus

None

» activation

Enabled

» activation

DisabledForNextScheduledRunOnly

» activation

Disabled

»» scheduleItemType

Folder

»» scheduleItemType

Calculation

»» scheduleItemType

Import

»» scheduleItemType

ExternalTool

»» scheduleItemType

TaskGeneration

»» scheduleItemType

StarSchemaPopulation

»» scheduleItemType

LockPeriod

»» scheduleItemType

EnableWeb

»» scheduleItemType

DisableWeb

»» scheduleItemType

Plan

»» scheduleItemType

Transformation

»» scheduleItemType

ClearTable

»» scheduleItemType

Publish

»» scheduleItemType

WebReport

»» scheduleItemType

Optimize

»» scheduleItemType

TaskRun

»» scheduleItemType

AddWorkflowMembers

»» scheduleItemType

UnassignIdleInquiries

»» scheduleItemType

PurgeHistory

»» scheduleItemType

ExpiringPasswordEmailNotificationAdmin

»» scheduleItemType

ExpiringPasswordEmailNotificationWeb

»» scheduleItemType

EnableWebUsers

»» scheduleItemType

CloudExternalTool

»» scheduleItemType

CloudSystemTool

»» scheduleItemType

IndexRebuild

»» scheduleItemType

PublishQueryTool

»» scheduleItemType

CalculateAndLock

»» scheduleItemType

HealthDashboardEvaluation

»» scheduleItemType

CalculationComponent

»» scheduleItemType

RefreshMaterializedView

»» scheduleItemType

RemoveWorkflowMembers

»» scheduleItemType

ELTRun

»» scheduleItemType

CalculationPlanBuilder

»» lastRunStatus

Success

»» lastRunStatus

Warning

»» lastRunStatus

Error

»» lastRunStatus

Cancelled

»» lastRunStatus

None

»» activation

Enabled

»» activation

DisabledForNextScheduledRunOnly

»» activation

Disabled

Responses

Status

Meaning

Description

Schema

201

Created

Create a new schedule item to enable web users.

Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/scheduleitemenableweb", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/scheduleitemenableweb");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "portalAccessGroupId": 0,
  "defaultPwd": "string",
  "id": 0,
  "name": "string",
  "scheduleItemType": "Folder",
  "order": 0,
  "lastRun": "2019-08-24T14:15:22Z",
  "lastRunStatus": "Success",
  "activation": "Enabled",
  "nextRun": "2019-08-24T14:15:22Z",
  "parent": 0,
  "scheduledTime": {
    "id": 0,
    "scheduleItemId": 0,
    "minute": 0,
    "hour": 0,
    "dayOfMonth": 0,
    "month": 0,
    "dayOfWeek": 0,
    "nextRunTime": "2019-08-24T14:15:22Z",
    "isDSTAdjusted": true,
    "version": {
      "rowVersion": 0
    }
  },
  "parentItem": {
    "id": 0,
    "name": "string",
    "scheduleItemType": "Folder",
    "order": 0,
    "lastRun": "2019-08-24T14:15:22Z",
    "lastRunStatus": "Success",
    "activation": "Enabled",
    "nextRun": "2019-08-24T14:15:22Z",
    "parent": 0,
    "scheduledTime": {
      "id": 0,
      "scheduleItemId": 0,
      "minute": 0,
      "hour": 0,
      "dayOfMonth": 0,
      "month": 0,
      "dayOfWeek": 0,
      "nextRunTime": "2019-08-24T14:15:22Z",
      "isDSTAdjusted": true,
      "version": {}
    },
    "parentItem": null,
    "childScheduleItems": [],
    "settings": {
      "schedulerSettingsId": 0,
      "scheduleItemId": 0,
      "parentSettingsID": 0,
      "emailOnFailure": true,
      "emailOnSuccess": true,
      "stopOnFailure": true,
      "stopToolOnTimeout": true,
      "isGlobal": true,
      "overrideChildSettings": true,
      "successEmails": [],
      "failEmails": [],
      "externalToolTimeout": 0,
      "parentSettings": null,
      "enableRetries": true,
      "retries": 0,
      "interval": 0,
      "version": {}
    },
    "version": {
      "rowVersion": 0
    },
    "previousName": "string",
    "runInParallel": true,
    "externalItemID": "string",
    "ptzId": "string"
  },
  "childScheduleItems": [
    {
      "id": 0,
      "name": "string",
      "scheduleItemType": "Folder",
      "order": 0,
      "lastRun": "2019-08-24T14:15:22Z",
      "lastRunStatus": "Success",
      "activation": "Enabled",
      "nextRun": "2019-08-24T14:15:22Z",
      "parent": 0,
      "scheduledTime": {},
      "parentItem": null,
      "childScheduleItems": [],
      "settings": {},
      "version": {},
      "previousName": "string",
      "runInParallel": true,
      "externalItemID": "string",
      "ptzId": "string"
    }
  ],
  "settings": {
    "schedulerSettingsId": 0,
    "scheduleItemId": 0,
    "parentSettingsID": 0,
    "emailOnFailure": true,
    "emailOnSuccess": true,
    "stopOnFailure": true,
    "stopToolOnTimeout": true,
    "isGlobal": true,
    "overrideChildSettings": true,
    "successEmails": [
      "string"
    ],
    "failEmails": [
      "string"
    ],
    "externalToolTimeout": 0,
    "parentSettings": null,
    "enableRetries": true,
    "retries": 0,
    "interval": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "version": {
    "rowVersion": 0
  },
  "previousName": "string",
  "runInParallel": true,
  "externalItemID": "string",
  "ptzId": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/scheduleitemenableweb',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/scheduleitemenableweb', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/scheduleitemenableweb',
  params: {
  }, headers: headers

p JSON.parse(result)

Create a new index rebuild schedule item.

Body parameter

{
  "calculationIDs": [
    0
  ],
  "tables": [
    "string"
  ],
  "calculationIDsV2": {
    "property1": "Reorganize",
    "property2": "Reorganize"
  },
  "tablesV2": {
    "property1": "Reorganize",
    "property2": "Reorganize"
  },
  "id": 0,
  "name": "string",
  "scheduleItemType": "Folder",
  "order": 0,
  "lastRun": "2019-08-24T14:15:22Z",
  "lastRunStatus": "Success",
  "activation": "Enabled",
  "nextRun": "2019-08-24T14:15:22Z",
  "parent": 0,
  "scheduledTime": {
    "id": 0,
    "scheduleItemId": 0,
    "minute": 0,
    "hour": 0,
    "dayOfMonth": 0,
    "month": 0,
    "dayOfWeek": 0,
    "nextRunTime": "2019-08-24T14:15:22Z",
    "isDSTAdjusted": true,
    "version": {
      "rowVersion": 0
    }
  },
  "parentItem": {
    "id": 0,
    "name": "string",
    "scheduleItemType": "Folder",
    "order": 0,
    "lastRun": "2019-08-24T14:15:22Z",
    "lastRunStatus": "Success",
    "activation": "Enabled",
    "nextRun": "2019-08-24T14:15:22Z",
    "parent": 0,
    "scheduledTime": {
      "id": 0,
      "scheduleItemId": 0,
      "minute": 0,
      "hour": 0,
      "dayOfMonth": 0,
      "month": 0,
      "dayOfWeek": 0,
      "nextRunTime": "2019-08-24T14:15:22Z",
      "isDSTAdjusted": true,
      "version": {}
    },
    "parentItem": null,
    "childScheduleItems": [],
    "settings": {
      "schedulerSettingsId": 0,
      "scheduleItemId": 0,
      "parentSettingsID": 0,
      "emailOnFailure": true,
      "emailOnSuccess": true,
      "stopOnFailure": true,
      "stopToolOnTimeout": true,
      "isGlobal": true,
      "overrideChildSettings": true,
      "successEmails": [],
      "failEmails": [],
      "externalToolTimeout": 0,
      "parentSettings": null,
      "enableRetries": true,
      "retries": 0,
      "interval": 0,
      "version": {}
    },
    "version": {
      "rowVersion": 0
    },
    "previousName": "string",
    "runInParallel": true,
    "externalItemID": "string",
    "ptzId": "string"
  },
  "childScheduleItems": [
    {
      "id": 0,
      "name": "string",
      "scheduleItemType": "Folder",
      "order": 0,
      "lastRun": "2019-08-24T14:15:22Z",
      "lastRunStatus": "Success",
      "activation": "Enabled",
      "nextRun": "2019-08-24T14:15:22Z",
      "parent": 0,
      "scheduledTime": {},
      "parentItem": null,
      "childScheduleItems": [],
      "settings": {},
      "version": {},
      "previousName": "string",
      "runInParallel": true,
      "externalItemID": "string",
      "ptzId": "string"
    }
  ],
  "settings": {
    "schedulerSettingsId": 0,
    "scheduleItemId": 0,
    "parentSettingsID": 0,
    "emailOnFailure": true,
    "emailOnSuccess": true,
    "stopOnFailure": true,
    "stopToolOnTimeout": true,
    "isGlobal": true,
    "overrideChildSettings": true,
    "successEmails": [
      "string"
    ],
    "failEmails": [
      "string"
    ],
    "externalToolTimeout": 0,
    "parentSettings": null,
    "enableRetries": true,
    "retries": 0,
    "interval": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "version": {
    "rowVersion": 0
  },
  "previousName": "string",
  "runInParallel": true,
  "externalItemID": "string",
  "ptzId": "string"
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Scheduler.ScheduleItemIndexRebuildDTO

false

none

» calculationIDs

body

[integer]¦null

false

none

» tables

body

[string]¦null

false

none

» calculationIDsV2

body

object¦null

false

none

»» additionalProperties

body

string¦null

false

none

» tablesV2

body

object¦null

false

none

»» additionalProperties

body

string¦null

false

none

» id

body

integer(int32)

false

none

» name

body

string¦null

false

none

» scheduleItemType

body

string

false

none

» order

body

integer(int32)

false

none

» lastRun

body

string(date-time)

false

none

» lastRunStatus

body

string

false

none

» activation

body

string

false

none

» nextRun

body

string(date-time)

false

none

» parent

body

integer(int32)¦null

false

none

» scheduledTime

body

Varicent.RESTAPI.v1.DTOs.Scheduler.ScheduleTimeDTO

false

none

»» id

body

integer(int32)

false

none

»» scheduleItemId

body

integer(int32)

false

none

»» minute

body

integer(int32)

false

none

»» hour

body

integer(int32)

false

none

»» dayOfMonth

body

integer(int32)

false

none

»» month

body

integer(int32)

false

none

»» dayOfWeek

body

integer(int32)

false

none

»» nextRunTime

body

string(date-time)

false

none

»» isDSTAdjusted

body

boolean¦null

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» rowVersion

body

integer(int64)

false

none

» parentItem

body

Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO

false

none

»» id

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» scheduleItemType

body

string

false

none

»» order

body

integer(int32)

false

none

»» lastRun

body

string(date-time)

false

none

»» lastRunStatus

body

string

false

none

»» activation

body

string

false

none

»» nextRun

body

string(date-time)

false

none

»» parent

body

integer(int32)¦null

false

none

»» scheduledTime

body

Varicent.RESTAPI.v1.DTOs.Scheduler.ScheduleTimeDTO

false

none

»» parentItem

body

any

false

none

»» childScheduleItems

body

array¦null

false

none

»»» anonymous

body

any

false

none

»» settings

body

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

false

none

»»» schedulerSettingsId

body

integer(int32)

false

none

»»» scheduleItemId

body

integer(int32)¦null

false

none

»»» parentSettingsID

body

integer(int32)¦null

false

none

»»» emailOnFailure

body

boolean

false

none

»»» emailOnSuccess

body

boolean

false

none

»»» stopOnFailure

body

boolean

false

none

»»» stopToolOnTimeout

body

boolean

false

none

»»» isGlobal

body

boolean

false

none

»»» overrideChildSettings

body

boolean

false

none

»»» successEmails

body

[string]¦null

false

none

»»» failEmails

body

[string]¦null

false

none

»»» externalToolTimeout

body

integer(int32)

false

none

»»» parentSettings

body

any

false

none

»»» enableRetries

body

boolean

false

none

»»» retries

body

integer(int32)¦null

false

none

»»» interval

body

integer(int32)¦null

false

none

»»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» previousName

body

string¦null

false

none

»» runInParallel

body

boolean

false

none

»» externalItemID

body

string¦null

false

none

»» ptzId

body

string¦null

false

none

» childScheduleItems

body

[Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO]¦null

false

none

» settings

body

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

» previousName

body

string¦null

false

none

» runInParallel

body

boolean

false

none

» externalItemID

body

string¦null

false

none

» ptzId

body

string¦null

false

none

Enumerated Values

Parameter

Value

»» additionalProperties

Reorganize

»» additionalProperties

Full

»» additionalProperties

CompleteWithFullscan

»» additionalProperties

Reorganize

»» additionalProperties

Full

»» additionalProperties

CompleteWithFullscan

» scheduleItemType

Folder

» scheduleItemType

Calculation

» scheduleItemType

Import

» scheduleItemType

ExternalTool

» scheduleItemType

TaskGeneration

» scheduleItemType

StarSchemaPopulation

» scheduleItemType

LockPeriod

» scheduleItemType

EnableWeb

» scheduleItemType

DisableWeb

» scheduleItemType

Plan

» scheduleItemType

Transformation

» scheduleItemType

ClearTable

» scheduleItemType

Publish

» scheduleItemType

WebReport

» scheduleItemType

Optimize

» scheduleItemType

TaskRun

» scheduleItemType

AddWorkflowMembers

» scheduleItemType

UnassignIdleInquiries

» scheduleItemType

PurgeHistory

» scheduleItemType

ExpiringPasswordEmailNotificationAdmin

» scheduleItemType

ExpiringPasswordEmailNotificationWeb

» scheduleItemType

EnableWebUsers

» scheduleItemType

CloudExternalTool

» scheduleItemType

CloudSystemTool

» scheduleItemType

IndexRebuild

» scheduleItemType

PublishQueryTool

» scheduleItemType

CalculateAndLock

» scheduleItemType

HealthDashboardEvaluation

» scheduleItemType

CalculationComponent

» scheduleItemType

RefreshMaterializedView

» scheduleItemType

RemoveWorkflowMembers

» scheduleItemType

ELTRun

» scheduleItemType

CalculationPlanBuilder

» lastRunStatus

Success

» lastRunStatus

Warning

» lastRunStatus

Error

» lastRunStatus

Cancelled

» lastRunStatus

None

» activation

Enabled

» activation

DisabledForNextScheduledRunOnly

» activation

Disabled

»» scheduleItemType

Folder

»» scheduleItemType

Calculation

»» scheduleItemType

Import

»» scheduleItemType

ExternalTool

»» scheduleItemType

TaskGeneration

»» scheduleItemType

StarSchemaPopulation

»» scheduleItemType

LockPeriod

»» scheduleItemType

EnableWeb

»» scheduleItemType

DisableWeb

»» scheduleItemType

Plan

»» scheduleItemType

Transformation

»» scheduleItemType

ClearTable

»» scheduleItemType

Publish

»» scheduleItemType

WebReport

»» scheduleItemType

Optimize

»» scheduleItemType

TaskRun

»» scheduleItemType

AddWorkflowMembers

»» scheduleItemType

UnassignIdleInquiries

»» scheduleItemType

PurgeHistory

»» scheduleItemType

ExpiringPasswordEmailNotificationAdmin

»» scheduleItemType

ExpiringPasswordEmailNotificationWeb

»» scheduleItemType

EnableWebUsers

»» scheduleItemType

CloudExternalTool

»» scheduleItemType

CloudSystemTool

»» scheduleItemType

IndexRebuild

»» scheduleItemType

PublishQueryTool

»» scheduleItemType

CalculateAndLock

»» scheduleItemType

HealthDashboardEvaluation

»» scheduleItemType

CalculationComponent

»» scheduleItemType

RefreshMaterializedView

»» scheduleItemType

RemoveWorkflowMembers

»» scheduleItemType

ELTRun

»» scheduleItemType

CalculationPlanBuilder

»» lastRunStatus

Success

»» lastRunStatus

Warning

»» lastRunStatus

Error

»» lastRunStatus

Cancelled

»» lastRunStatus

None

»» activation

Enabled

»» activation

DisabledForNextScheduledRunOnly

»» activation

Disabled

Responses

Status

Meaning

Description

Schema

201

Created

Create a new schedule item (index rebuild)

RESTAPI.v1.DTOs.Scheduler.ScheduleItemIndexRebuildDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/scheduleitemcreateindexrebuild", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/scheduleitemcreateindexrebuild");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "calculationIDs": [
    0
  ],
  "tables": [
    "string"
  ],
  "calculationIDsV2": {
    "property1": "Reorganize",
    "property2": "Reorganize"
  },
  "tablesV2": {
    "property1": "Reorganize",
    "property2": "Reorganize"
  },
  "id": 0,
  "name": "string",
  "scheduleItemType": "Folder",
  "order": 0,
  "lastRun": "2019-08-24T14:15:22Z",
  "lastRunStatus": "Success",
  "activation": "Enabled",
  "nextRun": "2019-08-24T14:15:22Z",
  "parent": 0,
  "scheduledTime": {
    "id": 0,
    "scheduleItemId": 0,
    "minute": 0,
    "hour": 0,
    "dayOfMonth": 0,
    "month": 0,
    "dayOfWeek": 0,
    "nextRunTime": "2019-08-24T14:15:22Z",
    "isDSTAdjusted": true,
    "version": {
      "rowVersion": 0
    }
  },
  "parentItem": {
    "id": 0,
    "name": "string",
    "scheduleItemType": "Folder",
    "order": 0,
    "lastRun": "2019-08-24T14:15:22Z",
    "lastRunStatus": "Success",
    "activation": "Enabled",
    "nextRun": "2019-08-24T14:15:22Z",
    "parent": 0,
    "scheduledTime": {
      "id": 0,
      "scheduleItemId": 0,
      "minute": 0,
      "hour": 0,
      "dayOfMonth": 0,
      "month": 0,
      "dayOfWeek": 0,
      "nextRunTime": "2019-08-24T14:15:22Z",
      "isDSTAdjusted": true,
      "version": {}
    },
    "parentItem": null,
    "childScheduleItems": [],
    "settings": {
      "schedulerSettingsId": 0,
      "scheduleItemId": 0,
      "parentSettingsID": 0,
      "emailOnFailure": true,
      "emailOnSuccess": true,
      "stopOnFailure": true,
      "stopToolOnTimeout": true,
      "isGlobal": true,
      "overrideChildSettings": true,
      "successEmails": [],
      "failEmails": [],
      "externalToolTimeout": 0,
      "parentSettings": null,
      "enableRetries": true,
      "retries": 0,
      "interval": 0,
      "version": {}
    },
    "version": {
      "rowVersion": 0
    },
    "previousName": "string",
    "runInParallel": true,
    "externalItemID": "string",
    "ptzId": "string"
  },
  "childScheduleItems": [
    {
      "id": 0,
      "name": "string",
      "scheduleItemType": "Folder",
      "order": 0,
      "lastRun": "2019-08-24T14:15:22Z",
      "lastRunStatus": "Success",
      "activation": "Enabled",
      "nextRun": "2019-08-24T14:15:22Z",
      "parent": 0,
      "scheduledTime": {},
      "parentItem": null,
      "childScheduleItems": [],
      "settings": {},
      "version": {},
      "previousName": "string",
      "runInParallel": true,
      "externalItemID": "string",
      "ptzId": "string"
    }
  ],
  "settings": {
    "schedulerSettingsId": 0,
    "scheduleItemId": 0,
    "parentSettingsID": 0,
    "emailOnFailure": true,
    "emailOnSuccess": true,
    "stopOnFailure": true,
    "stopToolOnTimeout": true,
    "isGlobal": true,
    "overrideChildSettings": true,
    "successEmails": [
      "string"
    ],
    "failEmails": [
      "string"
    ],
    "externalToolTimeout": 0,
    "parentSettings": null,
    "enableRetries": true,
    "retries": 0,
    "interval": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "version": {
    "rowVersion": 0
  },
  "previousName": "string",
  "runInParallel": true,
  "externalItemID": "string",
  "ptzId": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/scheduleitemcreateindexrebuild',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/scheduleitemcreateindexrebuild', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/scheduleitemcreateindexrebuild',
  params: {
  }, headers: headers

p JSON.parse(result)

Remove a schedule item.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Remove a schedule item (task or folder)

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/scheduleitem/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/scheduleitem/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/scheduleitem/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/scheduleitem/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/scheduleitem/{id}',
  params: {
  }

p JSON.parse(result)

SchedulerProcessesControllerV1_Get

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get Schedule Item by id (hierarchical)

Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO

404

Not Found

Schedule Item does not exist

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/scheduleitem/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/scheduleitem/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/scheduleitem/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/scheduleitem/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/scheduleitem/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "scheduleItemType": "Folder",
  "order": 0,
  "lastRun": "2019-08-24T14:15:22Z",
  "lastRunStatus": "Success",
  "activation": "Enabled",
  "nextRun": "2019-08-24T14:15:22Z",
  "parent": 0,
  "scheduledTime": {
    "id": 0,
    "scheduleItemId": 0,
    "minute": 0,
    "hour": 0,
    "dayOfMonth": 0,
    "month": 0,
    "dayOfWeek": 0,
    "nextRunTime": "2019-08-24T14:15:22Z",
    "isDSTAdjusted": true,
    "version": {
      "rowVersion": 0
    }
  },
  "parentItem": null,
  "childScheduleItems": [],
  "settings": {
    "schedulerSettingsId": 0,
    "scheduleItemId": 0,
    "parentSettingsID": 0,
    "emailOnFailure": true,
    "emailOnSuccess": true,
    "stopOnFailure": true,
    "stopToolOnTimeout": true,
    "isGlobal": true,
    "overrideChildSettings": true,
    "successEmails": [
      "string"
    ],
    "failEmails": [
      "string"
    ],
    "externalToolTimeout": 0,
    "parentSettings": null,
    "enableRetries": true,
    "retries": 0,
    "interval": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "version": {
    "rowVersion": 0
  },
  "previousName": "string",
  "runInParallel": true,
  "externalItemID": "string",
  "ptzId": "string"
}
{"id":0,"name":"string","scheduleItemType":"Folder","order":0,"lastRun":"2019-08-24T14:15:22Z","lastRunStatus":"Success","activation":"Enabled","nextRun":"2019-08-24T14:15:22Z","parent":0,"scheduledTime":{"id":0,"scheduleItemId":0,"minute":0,"hour":0,"dayOfMonth":0,"month":0,"dayOfWeek":0,"nextRunTime":"2019-08-24T14:15:22Z","isDSTAdjusted":true,"version":{"rowVersion":0}},"parentItem":null,"childScheduleItems":[],"settings":{"schedulerSettingsId":0,"scheduleItemId":0,"parentSettingsID":0,"emailOnFailure":true,"emailOnSuccess":true,"stopOnFailure":true,"stopToolOnTimeout":true,"isGlobal":true,"overrideChildSettings":true,"successEmails":["string"],"failEmails":["string"],"externalToolTimeout":0,"parentSettings":null,"enableRetries":true,"retries":0,"interval":0,"version":{"rowVersion":0}},"version":{"rowVersion":0},"previousName":"string","runInParallel":true,"externalItemID":"string","ptzId":"string"}

SchedulerProcessesControllerV1_PatchScheduleItem

Body parameter

{
  "order": 0,
  "runInParallel": true
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

RESTAPI.v1.DTOs.ScheduleItemPatchDTO

false

none

» order

body

integer(int32)

false

none

» runInParallel

body

boolean¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Move a ScheduleItem to an new index within the current parent

Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO

404

Not Found

Schedule Item does not exist

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/scheduleitem/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/scheduleitem/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "order": 0,
  "runInParallel": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/scheduleitem/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/scheduleitem/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/scheduleitem/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "scheduleItemType": "Folder",
  "order": 0,
  "lastRun": "2019-08-24T14:15:22Z",
  "lastRunStatus": "Success",
  "activation": "Enabled",
  "nextRun": "2019-08-24T14:15:22Z",
  "parent": 0,
  "scheduledTime": {
    "id": 0,
    "scheduleItemId": 0,
    "minute": 0,
    "hour": 0,
    "dayOfMonth": 0,
    "month": 0,
    "dayOfWeek": 0,
    "nextRunTime": "2019-08-24T14:15:22Z",
    "isDSTAdjusted": true,
    "version": {
      "rowVersion": 0
    }
  },
  "parentItem": null,
  "childScheduleItems": [],
  "settings": {
    "schedulerSettingsId": 0,
    "scheduleItemId": 0,
    "parentSettingsID": 0,
    "emailOnFailure": true,
    "emailOnSuccess": true,
    "stopOnFailure": true,
    "stopToolOnTimeout": true,
    "isGlobal": true,
    "overrideChildSettings": true,
    "successEmails": [
      "string"
    ],
    "failEmails": [
      "string"
    ],
    "externalToolTimeout": 0,
    "parentSettings": null,
    "enableRetries": true,
    "retries": 0,
    "interval": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "version": {
    "rowVersion": 0
  },
  "previousName": "string",
  "runInParallel": true,
  "externalItemID": "string",
  "ptzId": "string"
}
{"id":0,"name":"string","scheduleItemType":"Folder","order":0,"lastRun":"2019-08-24T14:15:22Z","lastRunStatus":"Success","activation":"Enabled","nextRun":"2019-08-24T14:15:22Z","parent":0,"scheduledTime":{"id":0,"scheduleItemId":0,"minute":0,"hour":0,"dayOfMonth":0,"month":0,"dayOfWeek":0,"nextRunTime":"2019-08-24T14:15:22Z","isDSTAdjusted":true,"version":{"rowVersion":0}},"parentItem":null,"childScheduleItems":[],"settings":{"schedulerSettingsId":0,"scheduleItemId":0,"parentSettingsID":0,"emailOnFailure":true,"emailOnSuccess":true,"stopOnFailure":true,"stopToolOnTimeout":true,"isGlobal":true,"overrideChildSettings":true,"successEmails":["string"],"failEmails":["string"],"externalToolTimeout":0,"parentSettings":null,"enableRetries":true,"retries":0,"interval":0,"version":{"rowVersion":0}},"version":{"rowVersion":0},"previousName":"string","runInParallel":true,"externalItemID":"string","ptzId":"string"}

SchedulerProcessesControllerV1_CanRename

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

newName

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Test if a schedule item can be renamed to the provided name

Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO

404

Not Found

Schedule Item does not exist

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/scheduleitemcanrename/{id}/{newname}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/scheduleitemcanrename/{id}/{newname}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/scheduleitemcanrename/{id}/{newname}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/scheduleitemcanrename/{id}/{newname}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/scheduleitemcanrename/{id}/{newname}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "scheduleItemType": "Folder",
  "order": 0,
  "lastRun": "2019-08-24T14:15:22Z",
  "lastRunStatus": "Success",
  "activation": "Enabled",
  "nextRun": "2019-08-24T14:15:22Z",
  "parent": 0,
  "scheduledTime": {
    "id": 0,
    "scheduleItemId": 0,
    "minute": 0,
    "hour": 0,
    "dayOfMonth": 0,
    "month": 0,
    "dayOfWeek": 0,
    "nextRunTime": "2019-08-24T14:15:22Z",
    "isDSTAdjusted": true,
    "version": {
      "rowVersion": 0
    }
  },
  "parentItem": null,
  "childScheduleItems": [],
  "settings": {
    "schedulerSettingsId": 0,
    "scheduleItemId": 0,
    "parentSettingsID": 0,
    "emailOnFailure": true,
    "emailOnSuccess": true,
    "stopOnFailure": true,
    "stopToolOnTimeout": true,
    "isGlobal": true,
    "overrideChildSettings": true,
    "successEmails": [
      "string"
    ],
    "failEmails": [
      "string"
    ],
    "externalToolTimeout": 0,
    "parentSettings": null,
    "enableRetries": true,
    "retries": 0,
    "interval": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "version": {
    "rowVersion": 0
  },
  "previousName": "string",
  "runInParallel": true,
  "externalItemID": "string",
  "ptzId": "string"
}
{"id":0,"name":"string","scheduleItemType":"Folder","order":0,"lastRun":"2019-08-24T14:15:22Z","lastRunStatus":"Success","activation":"Enabled","nextRun":"2019-08-24T14:15:22Z","parent":0,"scheduledTime":{"id":0,"scheduleItemId":0,"minute":0,"hour":0,"dayOfMonth":0,"month":0,"dayOfWeek":0,"nextRunTime":"2019-08-24T14:15:22Z","isDSTAdjusted":true,"version":{"rowVersion":0}},"parentItem":null,"childScheduleItems":[],"settings":{"schedulerSettingsId":0,"scheduleItemId":0,"parentSettingsID":0,"emailOnFailure":true,"emailOnSuccess":true,"stopOnFailure":true,"stopToolOnTimeout":true,"isGlobal":true,"overrideChildSettings":true,"successEmails":["string"],"failEmails":["string"],"externalToolTimeout":0,"parentSettings":null,"enableRetries":true,"retries":0,"interval":0,"version":{"rowVersion":0}},"version":{"rowVersion":0},"previousName":"string","runInParallel":true,"externalItemID":"string","ptzId":"string"}

SchedulerProcessesControllerV1_PostRename

Body parameter

{
  "id": 0,
  "name": "string",
  "scheduleItemType": "Folder",
  "order": 0,
  "lastRun": "2019-08-24T14:15:22Z",
  "lastRunStatus": "Success",
  "activation": "Enabled",
  "nextRun": "2019-08-24T14:15:22Z",
  "parent": 0,
  "scheduledTime": {
    "id": 0,
    "scheduleItemId": 0,
    "minute": 0,
    "hour": 0,
    "dayOfMonth": 0,
    "month": 0,
    "dayOfWeek": 0,
    "nextRunTime": "2019-08-24T14:15:22Z",
    "isDSTAdjusted": true,
    "version": {
      "rowVersion": 0
    }
  },
  "parentItem": null,
  "childScheduleItems": [],
  "settings": {
    "schedulerSettingsId": 0,
    "scheduleItemId": 0,
    "parentSettingsID": 0,
    "emailOnFailure": true,
    "emailOnSuccess": true,
    "stopOnFailure": true,
    "stopToolOnTimeout": true,
    "isGlobal": true,
    "overrideChildSettings": true,
    "successEmails": [
      "string"
    ],
    "failEmails": [
      "string"
    ],
    "externalToolTimeout": 0,
    "parentSettings": null,
    "enableRetries": true,
    "retries": 0,
    "interval": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "version": {
    "rowVersion": 0
  },
  "previousName": "string",
  "runInParallel": true,
  "externalItemID": "string",
  "ptzId": "string"
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO

false

none

» id

body

integer(int32)

false

none

» name

body

string¦null

false

none

» scheduleItemType

body

string

false

none

» order

body

integer(int32)

false

none

» lastRun

body

string(date-time)

false

none

» lastRunStatus

body

string

false

none

» activation

body

string

false

none

» nextRun

body

string(date-time)

false

none

» parent

body

integer(int32)¦null

false

none

» scheduledTime

body

Varicent.RESTAPI.v1.DTOs.Scheduler.ScheduleTimeDTO

false

none

»» id

body

integer(int32)

false

none

»» scheduleItemId

body

integer(int32)

false

none

»» minute

body

integer(int32)

false

none

»» hour

body

integer(int32)

false

none

»» dayOfMonth

body

integer(int32)

false

none

»» month

body

integer(int32)

false

none

»» dayOfWeek

body

integer(int32)

false

none

»» nextRunTime

body

string(date-time)

false

none

»» isDSTAdjusted

body

boolean¦null

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» rowVersion

body

integer(int64)

false

none

» parentItem

body

any

false

none

» childScheduleItems

body

array¦null

false

none

»» anonymous

body

any

false

none

» settings

body

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

false

none

»» schedulerSettingsId

body

integer(int32)

false

none

»» scheduleItemId

body

integer(int32)¦null

false

none

»» parentSettingsID

body

integer(int32)¦null

false

none

»» emailOnFailure

body

boolean

false

none

»» emailOnSuccess

body

boolean

false

none

»» stopOnFailure

body

boolean

false

none

»» stopToolOnTimeout

body

boolean

false

none

»» isGlobal

body

boolean

false

none

»» overrideChildSettings

body

boolean

false

none

»» successEmails

body

[string]¦null

false

none

»» failEmails

body

[string]¦null

false

none

»» externalToolTimeout

body

integer(int32)

false

none

»» parentSettings

body

any

false

none

»» enableRetries

body

boolean

false

none

»» retries

body

integer(int32)¦null

false

none

»» interval

body

integer(int32)¦null

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

» previousName

body

string¦null

false

none

» runInParallel

body

boolean

false

none

» externalItemID

body

string¦null

false

none

» ptzId

body

string¦null

false

none

Enumerated Values

Parameter

Value

» scheduleItemType

Folder

» scheduleItemType

Calculation

» scheduleItemType

Import

» scheduleItemType

ExternalTool

» scheduleItemType

TaskGeneration

» scheduleItemType

StarSchemaPopulation

» scheduleItemType

LockPeriod

» scheduleItemType

EnableWeb

» scheduleItemType

DisableWeb

» scheduleItemType

Plan

» scheduleItemType

Transformation

» scheduleItemType

ClearTable

» scheduleItemType

Publish

» scheduleItemType

WebReport

» scheduleItemType

Optimize

» scheduleItemType

TaskRun

» scheduleItemType

AddWorkflowMembers

» scheduleItemType

UnassignIdleInquiries

» scheduleItemType

PurgeHistory

» scheduleItemType

ExpiringPasswordEmailNotificationAdmin

» scheduleItemType

ExpiringPasswordEmailNotificationWeb

» scheduleItemType

EnableWebUsers

» scheduleItemType

CloudExternalTool

» scheduleItemType

CloudSystemTool

» scheduleItemType

IndexRebuild

» scheduleItemType

PublishQueryTool

» scheduleItemType

CalculateAndLock

» scheduleItemType

HealthDashboardEvaluation

» scheduleItemType

CalculationComponent

» scheduleItemType

RefreshMaterializedView

» scheduleItemType

RemoveWorkflowMembers

» scheduleItemType

ELTRun

» scheduleItemType

CalculationPlanBuilder

» lastRunStatus

Success

» lastRunStatus

Warning

» lastRunStatus

Error

» lastRunStatus

Cancelled

» lastRunStatus

None

» activation

Enabled

» activation

DisabledForNextScheduledRunOnly

» activation

Disabled

Responses

Status

Meaning

Description

Schema

200

OK

Rename a schedule item

Inline

404

Not Found

Schedule Item does not exist

None

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» scheduleItemType

string

false

none

none

» order

integer(int32)

false

none

none

» lastRun

string(date-time)

false

none

none

» lastRunStatus

string

false

none

none

» activation

string

false

none

none

» nextRun

string(date-time)

false

none

none

» parent

integer(int32)¦null

false

none

none

» scheduledTime

Varicent.RESTAPI.v1.DTOs.Scheduler.ScheduleTimeDTO

false

none

none

»» id

integer(int32)

false

none

none

»» scheduleItemId

integer(int32)

false

none

none

»» minute

integer(int32)

false

none

none

»» hour

integer(int32)

false

none

none

»» dayOfMonth

integer(int32)

false

none

none

»» month

integer(int32)

false

none

none

»» dayOfWeek

integer(int32)

false

none

none

»» nextRunTime

string(date-time)

false

none

none

»» isDSTAdjusted

boolean¦null

false

none

none

»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»» rowVersion

integer(int64)

false

none

none

» parentItem

any

false

none

none

» childScheduleItems

array¦null

false

none

none

»» anonymous

any

false

none

none

» settings

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

false

none

none

»» schedulerSettingsId

integer(int32)

false

none

none

»» scheduleItemId

integer(int32)¦null

false

none

none

»» parentSettingsID

integer(int32)¦null

false

none

none

»» emailOnFailure

boolean

false

none

none

»» emailOnSuccess

boolean

false

none

none

»» stopOnFailure

boolean

false

none

none

»» stopToolOnTimeout

boolean

false

none

none

»» isGlobal

boolean

false

none

none

»» overrideChildSettings

boolean

false

none

none

»» successEmails

[string]¦null

false

none

none

»» failEmails

[string]¦null

false

none

none

»» externalToolTimeout

integer(int32)

false

none

none

»» parentSettings

any

false

none

none

»» enableRetries

boolean

false

none

none

»» retries

integer(int32)¦null

false

none

none

»» interval

integer(int32)¦null

false

none

none

»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

» previousName

string¦null

false

none

none

» runInParallel

boolean

false

none

none

» externalItemID

string¦null

false

none

none

» ptzId

string¦null

false

none

none

Enumerated Values

Property

Value

scheduleItemType

Folder

scheduleItemType

Calculation

scheduleItemType

Import

scheduleItemType

ExternalTool

scheduleItemType

TaskGeneration

scheduleItemType

StarSchemaPopulation

scheduleItemType

LockPeriod

scheduleItemType

EnableWeb

scheduleItemType

DisableWeb

scheduleItemType

Plan

scheduleItemType

Transformation

scheduleItemType

ClearTable

scheduleItemType

Publish

scheduleItemType

WebReport

scheduleItemType

Optimize

scheduleItemType

TaskRun

scheduleItemType

AddWorkflowMembers

scheduleItemType

UnassignIdleInquiries

scheduleItemType

PurgeHistory

scheduleItemType

ExpiringPasswordEmailNotificationAdmin

scheduleItemType

ExpiringPasswordEmailNotificationWeb

scheduleItemType

EnableWebUsers

scheduleItemType

CloudExternalTool

scheduleItemType

CloudSystemTool

scheduleItemType

IndexRebuild

scheduleItemType

PublishQueryTool

scheduleItemType

CalculateAndLock

scheduleItemType

HealthDashboardEvaluation

scheduleItemType

CalculationComponent

scheduleItemType

RefreshMaterializedView

scheduleItemType

RemoveWorkflowMembers

scheduleItemType

ELTRun

scheduleItemType

CalculationPlanBuilder

lastRunStatus

Success

lastRunStatus

Warning

lastRunStatus

Error

lastRunStatus

Cancelled

lastRunStatus

None

activation

Enabled

activation

DisabledForNextScheduledRunOnly

activation

Disabled

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/scheduleitemrename", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/scheduleitemrename");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "name": "string",
  "scheduleItemType": "Folder",
  "order": 0,
  "lastRun": "2019-08-24T14:15:22Z",
  "lastRunStatus": "Success",
  "activation": "Enabled",
  "nextRun": "2019-08-24T14:15:22Z",
  "parent": 0,
  "scheduledTime": {
    "id": 0,
    "scheduleItemId": 0,
    "minute": 0,
    "hour": 0,
    "dayOfMonth": 0,
    "month": 0,
    "dayOfWeek": 0,
    "nextRunTime": "2019-08-24T14:15:22Z",
    "isDSTAdjusted": true,
    "version": {
      "rowVersion": 0
    }
  },
  "parentItem": null,
  "childScheduleItems": [],
  "settings": {
    "schedulerSettingsId": 0,
    "scheduleItemId": 0,
    "parentSettingsID": 0,
    "emailOnFailure": true,
    "emailOnSuccess": true,
    "stopOnFailure": true,
    "stopToolOnTimeout": true,
    "isGlobal": true,
    "overrideChildSettings": true,
    "successEmails": [
      "string"
    ],
    "failEmails": [
      "string"
    ],
    "externalToolTimeout": 0,
    "parentSettings": null,
    "enableRetries": true,
    "retries": 0,
    "interval": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "version": {
    "rowVersion": 0
  },
  "previousName": "string",
  "runInParallel": true,
  "externalItemID": "string",
  "ptzId": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/scheduleitemrename',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/scheduleitemrename', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/scheduleitemrename',
  params: {
  }, headers: headers

p JSON.parse(result)

SchedulerProcessesControllerV1_PutScheduleTimezone

Body parameter

{
  "id": 0,
  "name": "string",
  "scheduleItemType": "Folder",
  "order": 0,
  "lastRun": "2019-08-24T14:15:22Z",
  "lastRunStatus": "Success",
  "activation": "Enabled",
  "nextRun": "2019-08-24T14:15:22Z",
  "parent": 0,
  "scheduledTime": {
    "id": 0,
    "scheduleItemId": 0,
    "minute": 0,
    "hour": 0,
    "dayOfMonth": 0,
    "month": 0,
    "dayOfWeek": 0,
    "nextRunTime": "2019-08-24T14:15:22Z",
    "isDSTAdjusted": true,
    "version": {
      "rowVersion": 0
    }
  },
  "parentItem": null,
  "childScheduleItems": [],
  "settings": {
    "schedulerSettingsId": 0,
    "scheduleItemId": 0,
    "parentSettingsID": 0,
    "emailOnFailure": true,
    "emailOnSuccess": true,
    "stopOnFailure": true,
    "stopToolOnTimeout": true,
    "isGlobal": true,
    "overrideChildSettings": true,
    "successEmails": [
      "string"
    ],
    "failEmails": [
      "string"
    ],
    "externalToolTimeout": 0,
    "parentSettings": null,
    "enableRetries": true,
    "retries": 0,
    "interval": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "version": {
    "rowVersion": 0
  },
  "previousName": "string",
  "runInParallel": true,
  "externalItemID": "string",
  "ptzId": "string"
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO

false

none

» id

body

integer(int32)

false

none

» name

body

string¦null

false

none

» scheduleItemType

body

string

false

none

» order

body

integer(int32)

false

none

» lastRun

body

string(date-time)

false

none

» lastRunStatus

body

string

false

none

» activation

body

string

false

none

» nextRun

body

string(date-time)

false

none

» parent

body

integer(int32)¦null

false

none

» scheduledTime

body

Varicent.RESTAPI.v1.DTOs.Scheduler.ScheduleTimeDTO

false

none

»» id

body

integer(int32)

false

none

»» scheduleItemId

body

integer(int32)

false

none

»» minute

body

integer(int32)

false

none

»» hour

body

integer(int32)

false

none

»» dayOfMonth

body

integer(int32)

false

none

»» month

body

integer(int32)

false

none

»» dayOfWeek

body

integer(int32)

false

none

»» nextRunTime

body

string(date-time)

false

none

»» isDSTAdjusted

body

boolean¦null

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» rowVersion

body

integer(int64)

false

none

» parentItem

body

any

false

none

» childScheduleItems

body

array¦null

false

none

»» anonymous

body

any

false

none

» settings

body

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

false

none

»» schedulerSettingsId

body

integer(int32)

false

none

»» scheduleItemId

body

integer(int32)¦null

false

none

»» parentSettingsID

body

integer(int32)¦null

false

none

»» emailOnFailure

body

boolean

false

none

»» emailOnSuccess

body

boolean

false

none

»» stopOnFailure

body

boolean

false

none

»» stopToolOnTimeout

body

boolean

false

none

»» isGlobal

body

boolean

false

none

»» overrideChildSettings

body

boolean

false

none

»» successEmails

body

[string]¦null

false

none

»» failEmails

body

[string]¦null

false

none

»» externalToolTimeout

body

integer(int32)

false

none

»» parentSettings

body

any

false

none

»» enableRetries

body

boolean

false

none

»» retries

body

integer(int32)¦null

false

none

»» interval

body

integer(int32)¦null

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

» previousName

body

string¦null

false

none

» runInParallel

body

boolean

false

none

» externalItemID

body

string¦null

false

none

» ptzId

body

string¦null

false

none

Enumerated Values

Parameter

Value

» scheduleItemType

Folder

» scheduleItemType

Calculation

» scheduleItemType

Import

» scheduleItemType

ExternalTool

» scheduleItemType

TaskGeneration

» scheduleItemType

StarSchemaPopulation

» scheduleItemType

LockPeriod

» scheduleItemType

EnableWeb

» scheduleItemType

DisableWeb

» scheduleItemType

Plan

» scheduleItemType

Transformation

» scheduleItemType

ClearTable

» scheduleItemType

Publish

» scheduleItemType

WebReport

» scheduleItemType

Optimize

» scheduleItemType

TaskRun

» scheduleItemType

AddWorkflowMembers

» scheduleItemType

UnassignIdleInquiries

» scheduleItemType

PurgeHistory

» scheduleItemType

ExpiringPasswordEmailNotificationAdmin

» scheduleItemType

ExpiringPasswordEmailNotificationWeb

» scheduleItemType

EnableWebUsers

» scheduleItemType

CloudExternalTool

» scheduleItemType

CloudSystemTool

» scheduleItemType

IndexRebuild

» scheduleItemType

PublishQueryTool

» scheduleItemType

CalculateAndLock

» scheduleItemType

HealthDashboardEvaluation

» scheduleItemType

CalculationComponent

» scheduleItemType

RefreshMaterializedView

» scheduleItemType

RemoveWorkflowMembers

» scheduleItemType

ELTRun

» scheduleItemType

CalculationPlanBuilder

» lastRunStatus

Success

» lastRunStatus

Warning

» lastRunStatus

Error

» lastRunStatus

Cancelled

» lastRunStatus

None

» activation

Enabled

» activation

DisabledForNextScheduledRunOnly

» activation

Disabled

Responses

Status

Meaning

Description

Schema

200

OK

Edit an existing schedule’s timezone

Inline

404

Not Found

Schedule Item does not exist

None

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» scheduleItemType

string

false

none

none

» order

integer(int32)

false

none

none

» lastRun

string(date-time)

false

none

none

» lastRunStatus

string

false

none

none

» activation

string

false

none

none

» nextRun

string(date-time)

false

none

none

» parent

integer(int32)¦null

false

none

none

» scheduledTime

Varicent.RESTAPI.v1.DTOs.Scheduler.ScheduleTimeDTO

false

none

none

»» id

integer(int32)

false

none

none

»» scheduleItemId

integer(int32)

false

none

none

»» minute

integer(int32)

false

none

none

»» hour

integer(int32)

false

none

none

»» dayOfMonth

integer(int32)

false

none

none

»» month

integer(int32)

false

none

none

»» dayOfWeek

integer(int32)

false

none

none

»» nextRunTime

string(date-time)

false

none

none

»» isDSTAdjusted

boolean¦null

false

none

none

»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»» rowVersion

integer(int64)

false

none

none

» parentItem

any

false

none

none

» childScheduleItems

array¦null

false

none

none

»» anonymous

any

false

none

none

» settings

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

false

none

none

»» schedulerSettingsId

integer(int32)

false

none

none

»» scheduleItemId

integer(int32)¦null

false

none

none

»» parentSettingsID

integer(int32)¦null

false

none

none

»» emailOnFailure

boolean

false

none

none

»» emailOnSuccess

boolean

false

none

none

»» stopOnFailure

boolean

false

none

none

»» stopToolOnTimeout

boolean

false

none

none

»» isGlobal

boolean

false

none

none

»» overrideChildSettings

boolean

false

none

none

»» successEmails

[string]¦null

false

none

none

»» failEmails

[string]¦null

false

none

none

»» externalToolTimeout

integer(int32)

false

none

none

»» parentSettings

any

false

none

none

»» enableRetries

boolean

false

none

none

»» retries

integer(int32)¦null

false

none

none

»» interval

integer(int32)¦null

false

none

none

»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

» previousName

string¦null

false

none

none

» runInParallel

boolean

false

none

none

» externalItemID

string¦null

false

none

none

» ptzId

string¦null

false

none

none

Enumerated Values

Property

Value

scheduleItemType

Folder

scheduleItemType

Calculation

scheduleItemType

Import

scheduleItemType

ExternalTool

scheduleItemType

TaskGeneration

scheduleItemType

StarSchemaPopulation

scheduleItemType

LockPeriod

scheduleItemType

EnableWeb

scheduleItemType

DisableWeb

scheduleItemType

Plan

scheduleItemType

Transformation

scheduleItemType

ClearTable

scheduleItemType

Publish

scheduleItemType

WebReport

scheduleItemType

Optimize

scheduleItemType

TaskRun

scheduleItemType

AddWorkflowMembers

scheduleItemType

UnassignIdleInquiries

scheduleItemType

PurgeHistory

scheduleItemType

ExpiringPasswordEmailNotificationAdmin

scheduleItemType

ExpiringPasswordEmailNotificationWeb

scheduleItemType

EnableWebUsers

scheduleItemType

CloudExternalTool

scheduleItemType

CloudSystemTool

scheduleItemType

IndexRebuild

scheduleItemType

PublishQueryTool

scheduleItemType

CalculateAndLock

scheduleItemType

HealthDashboardEvaluation

scheduleItemType

CalculationComponent

scheduleItemType

RefreshMaterializedView

scheduleItemType

RemoveWorkflowMembers

scheduleItemType

ELTRun

scheduleItemType

CalculationPlanBuilder

lastRunStatus

Success

lastRunStatus

Warning

lastRunStatus

Error

lastRunStatus

Cancelled

lastRunStatus

None

activation

Enabled

activation

DisabledForNextScheduledRunOnly

activation

Disabled

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/scheduleitem/{id}/timezone", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/scheduleitem/{id}/timezone");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "name": "string",
  "scheduleItemType": "Folder",
  "order": 0,
  "lastRun": "2019-08-24T14:15:22Z",
  "lastRunStatus": "Success",
  "activation": "Enabled",
  "nextRun": "2019-08-24T14:15:22Z",
  "parent": 0,
  "scheduledTime": {
    "id": 0,
    "scheduleItemId": 0,
    "minute": 0,
    "hour": 0,
    "dayOfMonth": 0,
    "month": 0,
    "dayOfWeek": 0,
    "nextRunTime": "2019-08-24T14:15:22Z",
    "isDSTAdjusted": true,
    "version": {
      "rowVersion": 0
    }
  },
  "parentItem": null,
  "childScheduleItems": [],
  "settings": {
    "schedulerSettingsId": 0,
    "scheduleItemId": 0,
    "parentSettingsID": 0,
    "emailOnFailure": true,
    "emailOnSuccess": true,
    "stopOnFailure": true,
    "stopToolOnTimeout": true,
    "isGlobal": true,
    "overrideChildSettings": true,
    "successEmails": [
      "string"
    ],
    "failEmails": [
      "string"
    ],
    "externalToolTimeout": 0,
    "parentSettings": null,
    "enableRetries": true,
    "retries": 0,
    "interval": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "version": {
    "rowVersion": 0
  },
  "previousName": "string",
  "runInParallel": true,
  "externalItemID": "string",
  "ptzId": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/scheduleitem/{id}/timezone',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/scheduleitem/{id}/timezone', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/scheduleitem/{id}/timezone',
  params: {
  }, headers: headers

p JSON.parse(result)

SchedulerProcessesControllerV1_PutScheduleTask

Body parameter

{
  "id": 0,
  "scheduleItemId": 0,
  "minute": 0,
  "hour": 0,
  "dayOfMonth": 0,
  "month": 0,
  "dayOfWeek": 0,
  "nextRunTime": "2019-08-24T14:15:22Z",
  "isDSTAdjusted": true,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.Scheduler.ScheduleTimeDTO

false

none

» id

body

integer(int32)

false

none

» scheduleItemId

body

integer(int32)

false

none

» minute

body

integer(int32)

false

none

» hour

body

integer(int32)

false

none

» dayOfMonth

body

integer(int32)

false

none

» month

body

integer(int32)

false

none

» dayOfWeek

body

integer(int32)

false

none

» nextRunTime

body

string(date-time)

false

none

» isDSTAdjusted

body

boolean¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Schedule an existing schedule item

Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO

404

Not Found

Schedule Item does not exist

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/scheduleitem/{id}/schedule", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/scheduleitem/{id}/schedule");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "scheduleItemId": 0,
  "minute": 0,
  "hour": 0,
  "dayOfMonth": 0,
  "month": 0,
  "dayOfWeek": 0,
  "nextRunTime": "2019-08-24T14:15:22Z",
  "isDSTAdjusted": true,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/scheduleitem/{id}/schedule',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/scheduleitem/{id}/schedule', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/scheduleitem/{id}/schedule',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "scheduleItemType": "Folder",
  "order": 0,
  "lastRun": "2019-08-24T14:15:22Z",
  "lastRunStatus": "Success",
  "activation": "Enabled",
  "nextRun": "2019-08-24T14:15:22Z",
  "parent": 0,
  "scheduledTime": {
    "id": 0,
    "scheduleItemId": 0,
    "minute": 0,
    "hour": 0,
    "dayOfMonth": 0,
    "month": 0,
    "dayOfWeek": 0,
    "nextRunTime": "2019-08-24T14:15:22Z",
    "isDSTAdjusted": true,
    "version": {
      "rowVersion": 0
    }
  },
  "parentItem": null,
  "childScheduleItems": [],
  "settings": {
    "schedulerSettingsId": 0,
    "scheduleItemId": 0,
    "parentSettingsID": 0,
    "emailOnFailure": true,
    "emailOnSuccess": true,
    "stopOnFailure": true,
    "stopToolOnTimeout": true,
    "isGlobal": true,
    "overrideChildSettings": true,
    "successEmails": [
      "string"
    ],
    "failEmails": [
      "string"
    ],
    "externalToolTimeout": 0,
    "parentSettings": null,
    "enableRetries": true,
    "retries": 0,
    "interval": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "version": {
    "rowVersion": 0
  },
  "previousName": "string",
  "runInParallel": true,
  "externalItemID": "string",
  "ptzId": "string"
}
{"id":0,"name":"string","scheduleItemType":"Folder","order":0,"lastRun":"2019-08-24T14:15:22Z","lastRunStatus":"Success","activation":"Enabled","nextRun":"2019-08-24T14:15:22Z","parent":0,"scheduledTime":{"id":0,"scheduleItemId":0,"minute":0,"hour":0,"dayOfMonth":0,"month":0,"dayOfWeek":0,"nextRunTime":"2019-08-24T14:15:22Z","isDSTAdjusted":true,"version":{"rowVersion":0}},"parentItem":null,"childScheduleItems":[],"settings":{"schedulerSettingsId":0,"scheduleItemId":0,"parentSettingsID":0,"emailOnFailure":true,"emailOnSuccess":true,"stopOnFailure":true,"stopToolOnTimeout":true,"isGlobal":true,"overrideChildSettings":true,"successEmails":["string"],"failEmails":["string"],"externalToolTimeout":0,"parentSettings":null,"enableRetries":true,"retries":0,"interval":0,"version":{"rowVersion":0}},"version":{"rowVersion":0},"previousName":"string","runInParallel":true,"externalItemID":"string","ptzId":"string"}

SchedulerProcessesControllerV1_PutUnscheduleTask

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Un-schedule an existing schedule item

Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO

404

Not Found

Schedule Item does not exist

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/scheduleitem/{id}/unschedule", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/scheduleitem/{id}/unschedule");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/scheduleitem/{id}/unschedule',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/scheduleitem/{id}/unschedule', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/scheduleitem/{id}/unschedule',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "scheduleItemType": "Folder",
  "order": 0,
  "lastRun": "2019-08-24T14:15:22Z",
  "lastRunStatus": "Success",
  "activation": "Enabled",
  "nextRun": "2019-08-24T14:15:22Z",
  "parent": 0,
  "scheduledTime": {
    "id": 0,
    "scheduleItemId": 0,
    "minute": 0,
    "hour": 0,
    "dayOfMonth": 0,
    "month": 0,
    "dayOfWeek": 0,
    "nextRunTime": "2019-08-24T14:15:22Z",
    "isDSTAdjusted": true,
    "version": {
      "rowVersion": 0
    }
  },
  "parentItem": null,
  "childScheduleItems": [],
  "settings": {
    "schedulerSettingsId": 0,
    "scheduleItemId": 0,
    "parentSettingsID": 0,
    "emailOnFailure": true,
    "emailOnSuccess": true,
    "stopOnFailure": true,
    "stopToolOnTimeout": true,
    "isGlobal": true,
    "overrideChildSettings": true,
    "successEmails": [
      "string"
    ],
    "failEmails": [
      "string"
    ],
    "externalToolTimeout": 0,
    "parentSettings": null,
    "enableRetries": true,
    "retries": 0,
    "interval": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "version": {
    "rowVersion": 0
  },
  "previousName": "string",
  "runInParallel": true,
  "externalItemID": "string",
  "ptzId": "string"
}
{"id":0,"name":"string","scheduleItemType":"Folder","order":0,"lastRun":"2019-08-24T14:15:22Z","lastRunStatus":"Success","activation":"Enabled","nextRun":"2019-08-24T14:15:22Z","parent":0,"scheduledTime":{"id":0,"scheduleItemId":0,"minute":0,"hour":0,"dayOfMonth":0,"month":0,"dayOfWeek":0,"nextRunTime":"2019-08-24T14:15:22Z","isDSTAdjusted":true,"version":{"rowVersion":0}},"parentItem":null,"childScheduleItems":[],"settings":{"schedulerSettingsId":0,"scheduleItemId":0,"parentSettingsID":0,"emailOnFailure":true,"emailOnSuccess":true,"stopOnFailure":true,"stopToolOnTimeout":true,"isGlobal":true,"overrideChildSettings":true,"successEmails":["string"],"failEmails":["string"],"externalToolTimeout":0,"parentSettings":null,"enableRetries":true,"retries":0,"interval":0,"version":{"rowVersion":0}},"version":{"rowVersion":0},"previousName":"string","runInParallel":true,"externalItemID":"string","ptzId":"string"}

SchedulerProcessesControllerV1_PutUnscheduleAllTask

Responses

Status

Meaning

Description

Schema

200

OK

Un-schedule all scheduled items

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» scheduleItemType

string

false

none

none

» order

integer(int32)

false

none

none

» lastRun

string(date-time)

false

none

none

» lastRunStatus

string

false

none

none

» activation

string

false

none

none

» nextRun

string(date-time)

false

none

none

» parent

integer(int32)¦null

false

none

none

» scheduledTime

Varicent.RESTAPI.v1.DTOs.Scheduler.ScheduleTimeDTO

false

none

none

»» id

integer(int32)

false

none

none

»» scheduleItemId

integer(int32)

false

none

none

»» minute

integer(int32)

false

none

none

»» hour

integer(int32)

false

none

none

»» dayOfMonth

integer(int32)

false

none

none

»» month

integer(int32)

false

none

none

»» dayOfWeek

integer(int32)

false

none

none

»» nextRunTime

string(date-time)

false

none

none

»» isDSTAdjusted

boolean¦null

false

none

none

»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»» rowVersion

integer(int64)

false

none

none

» parentItem

any

false

none

none

» childScheduleItems

array¦null

false

none

none

»» anonymous

any

false

none

none

» settings

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

false

none

none

»» schedulerSettingsId

integer(int32)

false

none

none

»» scheduleItemId

integer(int32)¦null

false

none

none

»» parentSettingsID

integer(int32)¦null

false

none

none

»» emailOnFailure

boolean

false

none

none

»» emailOnSuccess

boolean

false

none

none

»» stopOnFailure

boolean

false

none

none

»» stopToolOnTimeout

boolean

false

none

none

»» isGlobal

boolean

false

none

none

»» overrideChildSettings

boolean

false

none

none

»» successEmails

[string]¦null

false

none

none

»» failEmails

[string]¦null

false

none

none

»» externalToolTimeout

integer(int32)

false

none

none

»» parentSettings

any

false

none

none

»» enableRetries

boolean

false

none

none

»» retries

integer(int32)¦null

false

none

none

»» interval

integer(int32)¦null

false

none

none

»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

» previousName

string¦null

false

none

none

» runInParallel

boolean

false

none

none

» externalItemID

string¦null

false

none

none

» ptzId

string¦null

false

none

none

Enumerated Values

Property

Value

scheduleItemType

Folder

scheduleItemType

Calculation

scheduleItemType

Import

scheduleItemType

ExternalTool

scheduleItemType

TaskGeneration

scheduleItemType

StarSchemaPopulation

scheduleItemType

LockPeriod

scheduleItemType

EnableWeb

scheduleItemType

DisableWeb

scheduleItemType

Plan

scheduleItemType

Transformation

scheduleItemType

ClearTable

scheduleItemType

Publish

scheduleItemType

WebReport

scheduleItemType

Optimize

scheduleItemType

TaskRun

scheduleItemType

AddWorkflowMembers

scheduleItemType

UnassignIdleInquiries

scheduleItemType

PurgeHistory

scheduleItemType

ExpiringPasswordEmailNotificationAdmin

scheduleItemType

ExpiringPasswordEmailNotificationWeb

scheduleItemType

EnableWebUsers

scheduleItemType

CloudExternalTool

scheduleItemType

CloudSystemTool

scheduleItemType

IndexRebuild

scheduleItemType

PublishQueryTool

scheduleItemType

CalculateAndLock

scheduleItemType

HealthDashboardEvaluation

scheduleItemType

CalculationComponent

scheduleItemType

RefreshMaterializedView

scheduleItemType

RemoveWorkflowMembers

scheduleItemType

ELTRun

scheduleItemType

CalculationPlanBuilder

lastRunStatus

Success

lastRunStatus

Warning

lastRunStatus

Error

lastRunStatus

Cancelled

lastRunStatus

None

activation

Enabled

activation

DisabledForNextScheduledRunOnly

activation

Disabled

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/scheduleitem/unschedule", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/scheduleitem/unschedule");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/scheduleitem/unschedule',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/scheduleitem/unschedule', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/scheduleitem/unschedule',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "name": "string",
    "scheduleItemType": "Folder",
    "order": 0,
    "lastRun": "2019-08-24T14:15:22Z",
    "lastRunStatus": "Success",
    "activation": "Enabled",
    "nextRun": "2019-08-24T14:15:22Z",
    "parent": 0,
    "scheduledTime": {
      "id": 0,
      "scheduleItemId": 0,
      "minute": 0,
      "hour": 0,
      "dayOfMonth": 0,
      "month": 0,
      "dayOfWeek": 0,
      "nextRunTime": "2019-08-24T14:15:22Z",
      "isDSTAdjusted": true,
      "version": {}
    },
    "parentItem": null,
    "childScheduleItems": [],
    "settings": {
      "schedulerSettingsId": 0,
      "scheduleItemId": 0,
      "parentSettingsID": 0,
      "emailOnFailure": true,
      "emailOnSuccess": true,
      "stopOnFailure": true,
      "stopToolOnTimeout": true,
      "isGlobal": true,
      "overrideChildSettings": true,
      "successEmails": [],
      "failEmails": [],
      "externalToolTimeout": 0,
      "parentSettings": null,
      "enableRetries": true,
      "retries": 0,
      "interval": 0,
      "version": {}
    },
    "version": {
      "rowVersion": 0
    },
    "previousName": "string",
    "runInParallel": true,
    "externalItemID": "string",
    "ptzId": "string"
  }
]
[{"id":0,"name":"string","scheduleItemType":"Folder","order":0,"lastRun":"2019-08-24T14:15:22Z","lastRunStatus":"Success","activation":"Enabled","nextRun":"2019-08-24T14:15:22Z","parent":0,"scheduledTime":{"id":0,"scheduleItemId":0,"minute":0,"hour":0,"dayOfMonth":0,"month":0,"dayOfWeek":0,"nextRunTime":"2019-08-24T14:15:22Z","isDSTAdjusted":true,"version":{}},"parentItem":null,"childScheduleItems":[],"settings":{"schedulerSettingsId":0,"scheduleItemId":0,"parentSettingsID":0,"emailOnFailure":true,"emailOnSuccess":true,"stopOnFailure":true,"stopToolOnTimeout":true,"isGlobal":true,"overrideChildSettings":true,"successEmails":[],"failEmails":[],"externalToolTimeout":0,"parentSettings":null,"enableRetries":true,"retries":0,"interval":0,"version":{}},"version":{"rowVersion":0},"previousName":"string","runInParallel":true,"externalItemID":"string","ptzId":"string"}]

SchedulerProcessesControllerV1_PostRunScheduleItem

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Run a scheduler item

Inline

404

Not Found

Schedule Item does not exist

None

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/scheduleitem/{id}/run", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/scheduleitem/{id}/run");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/scheduleitem/{id}/run',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/scheduleitem/{id}/run', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/scheduleitem/{id}/run',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "property1": "string",
  "property2": "string"
}
{"property1":"string","property2":"string"}

SchedulerProcessesControllerV1_PostRunProcess

Body parameter

"string"

Parameters

Name

In

Type

Required

Description

body

body

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Run Scheduler process (folder) and assoicated tasks.

Inline

404

Not Found

Schedule process (folder) does not exist.

None

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/scheduleitem/runprocess", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/scheduleitem/runprocess");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = 'string';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/scheduleitem/runprocess',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/scheduleitem/runprocess', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/scheduleitem/runprocess',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "property1": "string",
  "property2": "string"
}
{"property1":"string","property2":"string"}

SchedulerProcessesControllerV1_GetOptimizableTableNames

Responses

Status

Meaning

Description

Schema

200

OK

Get all table names.

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/optimizableTables", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/optimizableTables");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/optimizableTables',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/optimizableTables', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/optimizableTables',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "property1": "string",
  "property2": "string"
}
{"property1":"string","property2":"string"}

SchedulerProcessesControllerV1_PostMoveScheduleItem

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

targetId

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Move schedule item to child of target item, it will be the last child.

Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO

404

Not Found

Target Schedule Item does not exist

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/scheduleitem/{id}/move/{targetId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/scheduleitem/{id}/move/{targetId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/scheduleitem/{id}/move/{targetId}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/scheduleitem/{id}/move/{targetId}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/scheduleitem/{id}/move/{targetId}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "scheduleItemType": "Folder",
  "order": 0,
  "lastRun": "2019-08-24T14:15:22Z",
  "lastRunStatus": "Success",
  "activation": "Enabled",
  "nextRun": "2019-08-24T14:15:22Z",
  "parent": 0,
  "scheduledTime": {
    "id": 0,
    "scheduleItemId": 0,
    "minute": 0,
    "hour": 0,
    "dayOfMonth": 0,
    "month": 0,
    "dayOfWeek": 0,
    "nextRunTime": "2019-08-24T14:15:22Z",
    "isDSTAdjusted": true,
    "version": {
      "rowVersion": 0
    }
  },
  "parentItem": null,
  "childScheduleItems": [],
  "settings": {
    "schedulerSettingsId": 0,
    "scheduleItemId": 0,
    "parentSettingsID": 0,
    "emailOnFailure": true,
    "emailOnSuccess": true,
    "stopOnFailure": true,
    "stopToolOnTimeout": true,
    "isGlobal": true,
    "overrideChildSettings": true,
    "successEmails": [
      "string"
    ],
    "failEmails": [
      "string"
    ],
    "externalToolTimeout": 0,
    "parentSettings": null,
    "enableRetries": true,
    "retries": 0,
    "interval": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "version": {
    "rowVersion": 0
  },
  "previousName": "string",
  "runInParallel": true,
  "externalItemID": "string",
  "ptzId": "string"
}
{"id":0,"name":"string","scheduleItemType":"Folder","order":0,"lastRun":"2019-08-24T14:15:22Z","lastRunStatus":"Success","activation":"Enabled","nextRun":"2019-08-24T14:15:22Z","parent":0,"scheduledTime":{"id":0,"scheduleItemId":0,"minute":0,"hour":0,"dayOfMonth":0,"month":0,"dayOfWeek":0,"nextRunTime":"2019-08-24T14:15:22Z","isDSTAdjusted":true,"version":{"rowVersion":0}},"parentItem":null,"childScheduleItems":[],"settings":{"schedulerSettingsId":0,"scheduleItemId":0,"parentSettingsID":0,"emailOnFailure":true,"emailOnSuccess":true,"stopOnFailure":true,"stopToolOnTimeout":true,"isGlobal":true,"overrideChildSettings":true,"successEmails":["string"],"failEmails":["string"],"externalToolTimeout":0,"parentSettings":null,"enableRetries":true,"retries":0,"interval":0,"version":{"rowVersion":0}},"version":{"rowVersion":0},"previousName":"string","runInParallel":true,"externalItemID":"string","ptzId":"string"}

SchedulerProcessesControllerV1_PostMoveScheduleItemIdx

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

targetId

path

integer(int32)

true

none

idx

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Move a schedule item to the specified parent at the specified index.

Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO

404

Not Found

Schedule Item does not exist

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/scheduleitem/{id}/move/{targetId}/{idx}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/scheduleitem/{id}/move/{targetId}/{idx}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/scheduleitem/{id}/move/{targetId}/{idx}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/scheduleitem/{id}/move/{targetId}/{idx}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/scheduleitem/{id}/move/{targetId}/{idx}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "scheduleItemType": "Folder",
  "order": 0,
  "lastRun": "2019-08-24T14:15:22Z",
  "lastRunStatus": "Success",
  "activation": "Enabled",
  "nextRun": "2019-08-24T14:15:22Z",
  "parent": 0,
  "scheduledTime": {
    "id": 0,
    "scheduleItemId": 0,
    "minute": 0,
    "hour": 0,
    "dayOfMonth": 0,
    "month": 0,
    "dayOfWeek": 0,
    "nextRunTime": "2019-08-24T14:15:22Z",
    "isDSTAdjusted": true,
    "version": {
      "rowVersion": 0
    }
  },
  "parentItem": null,
  "childScheduleItems": [],
  "settings": {
    "schedulerSettingsId": 0,
    "scheduleItemId": 0,
    "parentSettingsID": 0,
    "emailOnFailure": true,
    "emailOnSuccess": true,
    "stopOnFailure": true,
    "stopToolOnTimeout": true,
    "isGlobal": true,
    "overrideChildSettings": true,
    "successEmails": [
      "string"
    ],
    "failEmails": [
      "string"
    ],
    "externalToolTimeout": 0,
    "parentSettings": null,
    "enableRetries": true,
    "retries": 0,
    "interval": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "version": {
    "rowVersion": 0
  },
  "previousName": "string",
  "runInParallel": true,
  "externalItemID": "string",
  "ptzId": "string"
}
{"id":0,"name":"string","scheduleItemType":"Folder","order":0,"lastRun":"2019-08-24T14:15:22Z","lastRunStatus":"Success","activation":"Enabled","nextRun":"2019-08-24T14:15:22Z","parent":0,"scheduledTime":{"id":0,"scheduleItemId":0,"minute":0,"hour":0,"dayOfMonth":0,"month":0,"dayOfWeek":0,"nextRunTime":"2019-08-24T14:15:22Z","isDSTAdjusted":true,"version":{"rowVersion":0}},"parentItem":null,"childScheduleItems":[],"settings":{"schedulerSettingsId":0,"scheduleItemId":0,"parentSettingsID":0,"emailOnFailure":true,"emailOnSuccess":true,"stopOnFailure":true,"stopToolOnTimeout":true,"isGlobal":true,"overrideChildSettings":true,"successEmails":["string"],"failEmails":["string"],"externalToolTimeout":0,"parentSettings":null,"enableRetries":true,"retries":0,"interval":0,"version":{"rowVersion":0}},"version":{"rowVersion":0},"previousName":"string","runInParallel":true,"externalItemID":"string","ptzId":"string"}

SchedulerProcessesControllerV1_GetScheduledImportsByName

Parameters

Name

In

Type

Required

Description

name

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get all scheduled item ids with an import name

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» scheduleItemType

string

false

none

none

» order

integer(int32)

false

none

none

» lastRun

string(date-time)

false

none

none

» lastRunStatus

string

false

none

none

» activation

string

false

none

none

» nextRun

string(date-time)

false

none

none

» parent

integer(int32)¦null

false

none

none

» scheduledTime

Varicent.RESTAPI.v1.DTOs.Scheduler.ScheduleTimeDTO

false

none

none

»» id

integer(int32)

false

none

none

»» scheduleItemId

integer(int32)

false

none

none

»» minute

integer(int32)

false

none

none

»» hour

integer(int32)

false

none

none

»» dayOfMonth

integer(int32)

false

none

none

»» month

integer(int32)

false

none

none

»» dayOfWeek

integer(int32)

false

none

none

»» nextRunTime

string(date-time)

false

none

none

»» isDSTAdjusted

boolean¦null

false

none

none

»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»» rowVersion

integer(int64)

false

none

none

» parentItem

any

false

none

none

» childScheduleItems

array¦null

false

none

none

»» anonymous

any

false

none

none

» settings

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

false

none

none

»» schedulerSettingsId

integer(int32)

false

none

none

»» scheduleItemId

integer(int32)¦null

false

none

none

»» parentSettingsID

integer(int32)¦null

false

none

none

»» emailOnFailure

boolean

false

none

none

»» emailOnSuccess

boolean

false

none

none

»» stopOnFailure

boolean

false

none

none

»» stopToolOnTimeout

boolean

false

none

none

»» isGlobal

boolean

false

none

none

»» overrideChildSettings

boolean

false

none

none

»» successEmails

[string]¦null

false

none

none

»» failEmails

[string]¦null

false

none

none

»» externalToolTimeout

integer(int32)

false

none

none

»» parentSettings

any

false

none

none

»» enableRetries

boolean

false

none

none

»» retries

integer(int32)¦null

false

none

none

»» interval

integer(int32)¦null

false

none

none

»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

» previousName

string¦null

false

none

none

» runInParallel

boolean

false

none

none

» externalItemID

string¦null

false

none

none

» ptzId

string¦null

false

none

none

Enumerated Values

Property

Value

scheduleItemType

Folder

scheduleItemType

Calculation

scheduleItemType

Import

scheduleItemType

ExternalTool

scheduleItemType

TaskGeneration

scheduleItemType

StarSchemaPopulation

scheduleItemType

LockPeriod

scheduleItemType

EnableWeb

scheduleItemType

DisableWeb

scheduleItemType

Plan

scheduleItemType

Transformation

scheduleItemType

ClearTable

scheduleItemType

Publish

scheduleItemType

WebReport

scheduleItemType

Optimize

scheduleItemType

TaskRun

scheduleItemType

AddWorkflowMembers

scheduleItemType

UnassignIdleInquiries

scheduleItemType

PurgeHistory

scheduleItemType

ExpiringPasswordEmailNotificationAdmin

scheduleItemType

ExpiringPasswordEmailNotificationWeb

scheduleItemType

EnableWebUsers

scheduleItemType

CloudExternalTool

scheduleItemType

CloudSystemTool

scheduleItemType

IndexRebuild

scheduleItemType

PublishQueryTool

scheduleItemType

CalculateAndLock

scheduleItemType

HealthDashboardEvaluation

scheduleItemType

CalculationComponent

scheduleItemType

RefreshMaterializedView

scheduleItemType

RemoveWorkflowMembers

scheduleItemType

ELTRun

scheduleItemType

CalculationPlanBuilder

lastRunStatus

Success

lastRunStatus

Warning

lastRunStatus

Error

lastRunStatus

Cancelled

lastRunStatus

None

activation

Enabled

activation

DisabledForNextScheduledRunOnly

activation

Disabled

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/scheduleimports/{name}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/scheduleimports/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/scheduleimports/{name}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/scheduleimports/{name}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/scheduleimports/{name}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "name": "string",
    "scheduleItemType": "Folder",
    "order": 0,
    "lastRun": "2019-08-24T14:15:22Z",
    "lastRunStatus": "Success",
    "activation": "Enabled",
    "nextRun": "2019-08-24T14:15:22Z",
    "parent": 0,
    "scheduledTime": {
      "id": 0,
      "scheduleItemId": 0,
      "minute": 0,
      "hour": 0,
      "dayOfMonth": 0,
      "month": 0,
      "dayOfWeek": 0,
      "nextRunTime": "2019-08-24T14:15:22Z",
      "isDSTAdjusted": true,
      "version": {}
    },
    "parentItem": null,
    "childScheduleItems": [],
    "settings": {
      "schedulerSettingsId": 0,
      "scheduleItemId": 0,
      "parentSettingsID": 0,
      "emailOnFailure": true,
      "emailOnSuccess": true,
      "stopOnFailure": true,
      "stopToolOnTimeout": true,
      "isGlobal": true,
      "overrideChildSettings": true,
      "successEmails": [],
      "failEmails": [],
      "externalToolTimeout": 0,
      "parentSettings": null,
      "enableRetries": true,
      "retries": 0,
      "interval": 0,
      "version": {}
    },
    "version": {
      "rowVersion": 0
    },
    "previousName": "string",
    "runInParallel": true,
    "externalItemID": "string",
    "ptzId": "string"
  }
]
[{"id":0,"name":"string","scheduleItemType":"Folder","order":0,"lastRun":"2019-08-24T14:15:22Z","lastRunStatus":"Success","activation":"Enabled","nextRun":"2019-08-24T14:15:22Z","parent":0,"scheduledTime":{"id":0,"scheduleItemId":0,"minute":0,"hour":0,"dayOfMonth":0,"month":0,"dayOfWeek":0,"nextRunTime":"2019-08-24T14:15:22Z","isDSTAdjusted":true,"version":{}},"parentItem":null,"childScheduleItems":[],"settings":{"schedulerSettingsId":0,"scheduleItemId":0,"parentSettingsID":0,"emailOnFailure":true,"emailOnSuccess":true,"stopOnFailure":true,"stopToolOnTimeout":true,"isGlobal":true,"overrideChildSettings":true,"successEmails":[],"failEmails":[],"externalToolTimeout":0,"parentSettings":null,"enableRetries":true,"retries":0,"interval":0,"version":{}},"version":{"rowVersion":0},"previousName":"string","runInParallel":true,"externalItemID":"string","ptzId":"string"}]

SchedulerProcessesControllerV1_PostMoveScheduleItemToTop

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Schedule an existing schedule item

Inline

404

Not Found

Schedule Item does not exist

None

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» scheduleItemType

string

false

none

none

» order

integer(int32)

false

none

none

» lastRun

string(date-time)

false

none

none

» lastRunStatus

string

false

none

none

» activation

string

false

none

none

» nextRun

string(date-time)

false

none

none

» parent

integer(int32)¦null

false

none

none

» scheduledTime

Varicent.RESTAPI.v1.DTOs.Scheduler.ScheduleTimeDTO

false

none

none

»» id

integer(int32)

false

none

none

»» scheduleItemId

integer(int32)

false

none

none

»» minute

integer(int32)

false

none

none

»» hour

integer(int32)

false

none

none

»» dayOfMonth

integer(int32)

false

none

none

»» month

integer(int32)

false

none

none

»» dayOfWeek

integer(int32)

false

none

none

»» nextRunTime

string(date-time)

false

none

none

»» isDSTAdjusted

boolean¦null

false

none

none

»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»» rowVersion

integer(int64)

false

none

none

» parentItem

any

false

none

none

» childScheduleItems

array¦null

false

none

none

»» anonymous

any

false

none

none

» settings

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

false

none

none

»» schedulerSettingsId

integer(int32)

false

none

none

»» scheduleItemId

integer(int32)¦null

false

none

none

»» parentSettingsID

integer(int32)¦null

false

none

none

»» emailOnFailure

boolean

false

none

none

»» emailOnSuccess

boolean

false

none

none

»» stopOnFailure

boolean

false

none

none

»» stopToolOnTimeout

boolean

false

none

none

»» isGlobal

boolean

false

none

none

»» overrideChildSettings

boolean

false

none

none

»» successEmails

[string]¦null

false

none

none

»» failEmails

[string]¦null

false

none

none

»» externalToolTimeout

integer(int32)

false

none

none

»» parentSettings

any

false

none

none

»» enableRetries

boolean

false

none

none

»» retries

integer(int32)¦null

false

none

none

»» interval

integer(int32)¦null

false

none

none

»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

» previousName

string¦null

false

none

none

» runInParallel

boolean

false

none

none

» externalItemID

string¦null

false

none

none

» ptzId

string¦null

false

none

none

Enumerated Values

Property

Value

scheduleItemType

Folder

scheduleItemType

Calculation

scheduleItemType

Import

scheduleItemType

ExternalTool

scheduleItemType

TaskGeneration

scheduleItemType

StarSchemaPopulation

scheduleItemType

LockPeriod

scheduleItemType

EnableWeb

scheduleItemType

DisableWeb

scheduleItemType

Plan

scheduleItemType

Transformation

scheduleItemType

ClearTable

scheduleItemType

Publish

scheduleItemType

WebReport

scheduleItemType

Optimize

scheduleItemType

TaskRun

scheduleItemType

AddWorkflowMembers

scheduleItemType

UnassignIdleInquiries

scheduleItemType

PurgeHistory

scheduleItemType

ExpiringPasswordEmailNotificationAdmin

scheduleItemType

ExpiringPasswordEmailNotificationWeb

scheduleItemType

EnableWebUsers

scheduleItemType

CloudExternalTool

scheduleItemType

CloudSystemTool

scheduleItemType

IndexRebuild

scheduleItemType

PublishQueryTool

scheduleItemType

CalculateAndLock

scheduleItemType

HealthDashboardEvaluation

scheduleItemType

CalculationComponent

scheduleItemType

RefreshMaterializedView

scheduleItemType

RemoveWorkflowMembers

scheduleItemType

ELTRun

scheduleItemType

CalculationPlanBuilder

lastRunStatus

Success

lastRunStatus

Warning

lastRunStatus

Error

lastRunStatus

Cancelled

lastRunStatus

None

activation

Enabled

activation

DisabledForNextScheduledRunOnly

activation

Disabled

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/scheduleitem/{id}/movetotop", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/scheduleitem/{id}/movetotop");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/scheduleitem/{id}/movetotop',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/scheduleitem/{id}/movetotop', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/scheduleitem/{id}/movetotop',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "name": "string",
    "scheduleItemType": "Folder",
    "order": 0,
    "lastRun": "2019-08-24T14:15:22Z",
    "lastRunStatus": "Success",
    "activation": "Enabled",
    "nextRun": "2019-08-24T14:15:22Z",
    "parent": 0,
    "scheduledTime": {
      "id": 0,
      "scheduleItemId": 0,
      "minute": 0,
      "hour": 0,
      "dayOfMonth": 0,
      "month": 0,
      "dayOfWeek": 0,
      "nextRunTime": "2019-08-24T14:15:22Z",
      "isDSTAdjusted": true,
      "version": {}
    },
    "parentItem": null,
    "childScheduleItems": [],
    "settings": {
      "schedulerSettingsId": 0,
      "scheduleItemId": 0,
      "parentSettingsID": 0,
      "emailOnFailure": true,
      "emailOnSuccess": true,
      "stopOnFailure": true,
      "stopToolOnTimeout": true,
      "isGlobal": true,
      "overrideChildSettings": true,
      "successEmails": [],
      "failEmails": [],
      "externalToolTimeout": 0,
      "parentSettings": null,
      "enableRetries": true,
      "retries": 0,
      "interval": 0,
      "version": {}
    },
    "version": {
      "rowVersion": 0
    },
    "previousName": "string",
    "runInParallel": true,
    "externalItemID": "string",
    "ptzId": "string"
  }
]
[{"id":0,"name":"string","scheduleItemType":"Folder","order":0,"lastRun":"2019-08-24T14:15:22Z","lastRunStatus":"Success","activation":"Enabled","nextRun":"2019-08-24T14:15:22Z","parent":0,"scheduledTime":{"id":0,"scheduleItemId":0,"minute":0,"hour":0,"dayOfMonth":0,"month":0,"dayOfWeek":0,"nextRunTime":"2019-08-24T14:15:22Z","isDSTAdjusted":true,"version":{}},"parentItem":null,"childScheduleItems":[],"settings":{"schedulerSettingsId":0,"scheduleItemId":0,"parentSettingsID":0,"emailOnFailure":true,"emailOnSuccess":true,"stopOnFailure":true,"stopToolOnTimeout":true,"isGlobal":true,"overrideChildSettings":true,"successEmails":[],"failEmails":[],"externalToolTimeout":0,"parentSettings":null,"enableRetries":true,"retries":0,"interval":0,"version":{}},"version":{"rowVersion":0},"previousName":"string","runInParallel":true,"externalItemID":"string","ptzId":"string"}]

SchedulerProcessesControllerV1_PostMoveScheduleItemToTopIndex

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

idx

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Schedule an existing schedule item

Inline

404

Not Found

Schedule Item does not exist

None

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» scheduleItemType

string

false

none

none

» order

integer(int32)

false

none

none

» lastRun

string(date-time)

false

none

none

» lastRunStatus

string

false

none

none

» activation

string

false

none

none

» nextRun

string(date-time)

false

none

none

» parent

integer(int32)¦null

false

none

none

» scheduledTime

Varicent.RESTAPI.v1.DTOs.Scheduler.ScheduleTimeDTO

false

none

none

»» id

integer(int32)

false

none

none

»» scheduleItemId

integer(int32)

false

none

none

»» minute

integer(int32)

false

none

none

»» hour

integer(int32)

false

none

none

»» dayOfMonth

integer(int32)

false

none

none

»» month

integer(int32)

false

none

none

»» dayOfWeek

integer(int32)

false

none

none

»» nextRunTime

string(date-time)

false

none

none

»» isDSTAdjusted

boolean¦null

false

none

none

»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»» rowVersion

integer(int64)

false

none

none

» parentItem

any

false

none

none

» childScheduleItems

array¦null

false

none

none

»» anonymous

any

false

none

none

» settings

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

false

none

none

»» schedulerSettingsId

integer(int32)

false

none

none

»» scheduleItemId

integer(int32)¦null

false

none

none

»» parentSettingsID

integer(int32)¦null

false

none

none

»» emailOnFailure

boolean

false

none

none

»» emailOnSuccess

boolean

false

none

none

»» stopOnFailure

boolean

false

none

none

»» stopToolOnTimeout

boolean

false

none

none

»» isGlobal

boolean

false

none

none

»» overrideChildSettings

boolean

false

none

none

»» successEmails

[string]¦null

false

none

none

»» failEmails

[string]¦null

false

none

none

»» externalToolTimeout

integer(int32)

false

none

none

»» parentSettings

any

false

none

none

»» enableRetries

boolean

false

none

none

»» retries

integer(int32)¦null

false

none

none

»» interval

integer(int32)¦null

false

none

none

»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

» previousName

string¦null

false

none

none

» runInParallel

boolean

false

none

none

» externalItemID

string¦null

false

none

none

» ptzId

string¦null

false

none

none

Enumerated Values

Property

Value

scheduleItemType

Folder

scheduleItemType

Calculation

scheduleItemType

Import

scheduleItemType

ExternalTool

scheduleItemType

TaskGeneration

scheduleItemType

StarSchemaPopulation

scheduleItemType

LockPeriod

scheduleItemType

EnableWeb

scheduleItemType

DisableWeb

scheduleItemType

Plan

scheduleItemType

Transformation

scheduleItemType

ClearTable

scheduleItemType

Publish

scheduleItemType

WebReport

scheduleItemType

Optimize

scheduleItemType

TaskRun

scheduleItemType

AddWorkflowMembers

scheduleItemType

UnassignIdleInquiries

scheduleItemType

PurgeHistory

scheduleItemType

ExpiringPasswordEmailNotificationAdmin

scheduleItemType

ExpiringPasswordEmailNotificationWeb

scheduleItemType

EnableWebUsers

scheduleItemType

CloudExternalTool

scheduleItemType

CloudSystemTool

scheduleItemType

IndexRebuild

scheduleItemType

PublishQueryTool

scheduleItemType

CalculateAndLock

scheduleItemType

HealthDashboardEvaluation

scheduleItemType

CalculationComponent

scheduleItemType

RefreshMaterializedView

scheduleItemType

RemoveWorkflowMembers

scheduleItemType

ELTRun

scheduleItemType

CalculationPlanBuilder

lastRunStatus

Success

lastRunStatus

Warning

lastRunStatus

Error

lastRunStatus

Cancelled

lastRunStatus

None

activation

Enabled

activation

DisabledForNextScheduledRunOnly

activation

Disabled

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/scheduleitem/{id}/movetotop/{idx}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/scheduleitem/{id}/movetotop/{idx}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/scheduleitem/{id}/movetotop/{idx}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/scheduleitem/{id}/movetotop/{idx}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/scheduleitem/{id}/movetotop/{idx}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "name": "string",
    "scheduleItemType": "Folder",
    "order": 0,
    "lastRun": "2019-08-24T14:15:22Z",
    "lastRunStatus": "Success",
    "activation": "Enabled",
    "nextRun": "2019-08-24T14:15:22Z",
    "parent": 0,
    "scheduledTime": {
      "id": 0,
      "scheduleItemId": 0,
      "minute": 0,
      "hour": 0,
      "dayOfMonth": 0,
      "month": 0,
      "dayOfWeek": 0,
      "nextRunTime": "2019-08-24T14:15:22Z",
      "isDSTAdjusted": true,
      "version": {}
    },
    "parentItem": null,
    "childScheduleItems": [],
    "settings": {
      "schedulerSettingsId": 0,
      "scheduleItemId": 0,
      "parentSettingsID": 0,
      "emailOnFailure": true,
      "emailOnSuccess": true,
      "stopOnFailure": true,
      "stopToolOnTimeout": true,
      "isGlobal": true,
      "overrideChildSettings": true,
      "successEmails": [],
      "failEmails": [],
      "externalToolTimeout": 0,
      "parentSettings": null,
      "enableRetries": true,
      "retries": 0,
      "interval": 0,
      "version": {}
    },
    "version": {
      "rowVersion": 0
    },
    "previousName": "string",
    "runInParallel": true,
    "externalItemID": "string",
    "ptzId": "string"
  }
]
[{"id":0,"name":"string","scheduleItemType":"Folder","order":0,"lastRun":"2019-08-24T14:15:22Z","lastRunStatus":"Success","activation":"Enabled","nextRun":"2019-08-24T14:15:22Z","parent":0,"scheduledTime":{"id":0,"scheduleItemId":0,"minute":0,"hour":0,"dayOfMonth":0,"month":0,"dayOfWeek":0,"nextRunTime":"2019-08-24T14:15:22Z","isDSTAdjusted":true,"version":{}},"parentItem":null,"childScheduleItems":[],"settings":{"schedulerSettingsId":0,"scheduleItemId":0,"parentSettingsID":0,"emailOnFailure":true,"emailOnSuccess":true,"stopOnFailure":true,"stopToolOnTimeout":true,"isGlobal":true,"overrideChildSettings":true,"successEmails":[],"failEmails":[],"externalToolTimeout":0,"parentSettings":null,"enableRetries":true,"retries":0,"interval":0,"version":{}},"version":{"rowVersion":0},"previousName":"string","runInParallel":true,"externalItemID":"string","ptzId":"string"}]

SchedulerProcessesControllerV1_PostEnableScheduleItem

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Enable an existing schedule item

Inline

404

Not Found

Schedule Item does not exist

None

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» scheduleItemType

string

false

none

none

» order

integer(int32)

false

none

none

» lastRun

string(date-time)

false

none

none

» lastRunStatus

string

false

none

none

» activation

string

false

none

none

» nextRun

string(date-time)

false

none

none

» parent

integer(int32)¦null

false

none

none

» scheduledTime

Varicent.RESTAPI.v1.DTOs.Scheduler.ScheduleTimeDTO

false

none

none

»» id

integer(int32)

false

none

none

»» scheduleItemId

integer(int32)

false

none

none

»» minute

integer(int32)

false

none

none

»» hour

integer(int32)

false

none

none

»» dayOfMonth

integer(int32)

false

none

none

»» month

integer(int32)

false

none

none

»» dayOfWeek

integer(int32)

false

none

none

»» nextRunTime

string(date-time)

false

none

none

»» isDSTAdjusted

boolean¦null

false

none

none

»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»» rowVersion

integer(int64)

false

none

none

» parentItem

any

false

none

none

» childScheduleItems

array¦null

false

none

none

»» anonymous

any

false

none

none

» settings

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

false

none

none

»» schedulerSettingsId

integer(int32)

false

none

none

»» scheduleItemId

integer(int32)¦null

false

none

none

»» parentSettingsID

integer(int32)¦null

false

none

none

»» emailOnFailure

boolean

false

none

none

»» emailOnSuccess

boolean

false

none

none

»» stopOnFailure

boolean

false

none

none

»» stopToolOnTimeout

boolean

false

none

none

»» isGlobal

boolean

false

none

none

»» overrideChildSettings

boolean

false

none

none

»» successEmails

[string]¦null

false

none

none

»» failEmails

[string]¦null

false

none

none

»» externalToolTimeout

integer(int32)

false

none

none

»» parentSettings

any

false

none

none

»» enableRetries

boolean

false

none

none

»» retries

integer(int32)¦null

false

none

none

»» interval

integer(int32)¦null

false

none

none

»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

» previousName

string¦null

false

none

none

» runInParallel

boolean

false

none

none

» externalItemID

string¦null

false

none

none

» ptzId

string¦null

false

none

none

Enumerated Values

Property

Value

scheduleItemType

Folder

scheduleItemType

Calculation

scheduleItemType

Import

scheduleItemType

ExternalTool

scheduleItemType

TaskGeneration

scheduleItemType

StarSchemaPopulation

scheduleItemType

LockPeriod

scheduleItemType

EnableWeb

scheduleItemType

DisableWeb

scheduleItemType

Plan

scheduleItemType

Transformation

scheduleItemType

ClearTable

scheduleItemType

Publish

scheduleItemType

WebReport

scheduleItemType

Optimize

scheduleItemType

TaskRun

scheduleItemType

AddWorkflowMembers

scheduleItemType

UnassignIdleInquiries

scheduleItemType

PurgeHistory

scheduleItemType

ExpiringPasswordEmailNotificationAdmin

scheduleItemType

ExpiringPasswordEmailNotificationWeb

scheduleItemType

EnableWebUsers

scheduleItemType

CloudExternalTool

scheduleItemType

CloudSystemTool

scheduleItemType

IndexRebuild

scheduleItemType

PublishQueryTool

scheduleItemType

CalculateAndLock

scheduleItemType

HealthDashboardEvaluation

scheduleItemType

CalculationComponent

scheduleItemType

RefreshMaterializedView

scheduleItemType

RemoveWorkflowMembers

scheduleItemType

ELTRun

scheduleItemType

CalculationPlanBuilder

lastRunStatus

Success

lastRunStatus

Warning

lastRunStatus

Error

lastRunStatus

Cancelled

lastRunStatus

None

activation

Enabled

activation

DisabledForNextScheduledRunOnly

activation

Disabled

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/scheduleitem/{id}/enable", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/scheduleitem/{id}/enable");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/scheduleitem/{id}/enable',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/scheduleitem/{id}/enable', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/scheduleitem/{id}/enable',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "name": "string",
    "scheduleItemType": "Folder",
    "order": 0,
    "lastRun": "2019-08-24T14:15:22Z",
    "lastRunStatus": "Success",
    "activation": "Enabled",
    "nextRun": "2019-08-24T14:15:22Z",
    "parent": 0,
    "scheduledTime": {
      "id": 0,
      "scheduleItemId": 0,
      "minute": 0,
      "hour": 0,
      "dayOfMonth": 0,
      "month": 0,
      "dayOfWeek": 0,
      "nextRunTime": "2019-08-24T14:15:22Z",
      "isDSTAdjusted": true,
      "version": {}
    },
    "parentItem": null,
    "childScheduleItems": [],
    "settings": {
      "schedulerSettingsId": 0,
      "scheduleItemId": 0,
      "parentSettingsID": 0,
      "emailOnFailure": true,
      "emailOnSuccess": true,
      "stopOnFailure": true,
      "stopToolOnTimeout": true,
      "isGlobal": true,
      "overrideChildSettings": true,
      "successEmails": [],
      "failEmails": [],
      "externalToolTimeout": 0,
      "parentSettings": null,
      "enableRetries": true,
      "retries": 0,
      "interval": 0,
      "version": {}
    },
    "version": {
      "rowVersion": 0
    },
    "previousName": "string",
    "runInParallel": true,
    "externalItemID": "string",
    "ptzId": "string"
  }
]
[{"id":0,"name":"string","scheduleItemType":"Folder","order":0,"lastRun":"2019-08-24T14:15:22Z","lastRunStatus":"Success","activation":"Enabled","nextRun":"2019-08-24T14:15:22Z","parent":0,"scheduledTime":{"id":0,"scheduleItemId":0,"minute":0,"hour":0,"dayOfMonth":0,"month":0,"dayOfWeek":0,"nextRunTime":"2019-08-24T14:15:22Z","isDSTAdjusted":true,"version":{}},"parentItem":null,"childScheduleItems":[],"settings":{"schedulerSettingsId":0,"scheduleItemId":0,"parentSettingsID":0,"emailOnFailure":true,"emailOnSuccess":true,"stopOnFailure":true,"stopToolOnTimeout":true,"isGlobal":true,"overrideChildSettings":true,"successEmails":[],"failEmails":[],"externalToolTimeout":0,"parentSettings":null,"enableRetries":true,"retries":0,"interval":0,"version":{}},"version":{"rowVersion":0},"previousName":"string","runInParallel":true,"externalItemID":"string","ptzId":"string"}]

SchedulerProcessesControllerV1_PostDisableScheduleItem

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Disable an existing schedule item

Inline

404

Not Found

Schedule Item does not exist

None

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» scheduleItemType

string

false

none

none

» order

integer(int32)

false

none

none

» lastRun

string(date-time)

false

none

none

» lastRunStatus

string

false

none

none

» activation

string

false

none

none

» nextRun

string(date-time)

false

none

none

» parent

integer(int32)¦null

false

none

none

» scheduledTime

Varicent.RESTAPI.v1.DTOs.Scheduler.ScheduleTimeDTO

false

none

none

»» id

integer(int32)

false

none

none

»» scheduleItemId

integer(int32)

false

none

none

»» minute

integer(int32)

false

none

none

»» hour

integer(int32)

false

none

none

»» dayOfMonth

integer(int32)

false

none

none

»» month

integer(int32)

false

none

none

»» dayOfWeek

integer(int32)

false

none

none

»» nextRunTime

string(date-time)

false

none

none

»» isDSTAdjusted

boolean¦null

false

none

none

»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»» rowVersion

integer(int64)

false

none

none

» parentItem

any

false

none

none

» childScheduleItems

array¦null

false

none

none

»» anonymous

any

false

none

none

» settings

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

false

none

none

»» schedulerSettingsId

integer(int32)

false

none

none

»» scheduleItemId

integer(int32)¦null

false

none

none

»» parentSettingsID

integer(int32)¦null

false

none

none

»» emailOnFailure

boolean

false

none

none

»» emailOnSuccess

boolean

false

none

none

»» stopOnFailure

boolean

false

none

none

»» stopToolOnTimeout

boolean

false

none

none

»» isGlobal

boolean

false

none

none

»» overrideChildSettings

boolean

false

none

none

»» successEmails

[string]¦null

false

none

none

»» failEmails

[string]¦null

false

none

none

»» externalToolTimeout

integer(int32)

false

none

none

»» parentSettings

any

false

none

none

»» enableRetries

boolean

false

none

none

»» retries

integer(int32)¦null

false

none

none

»» interval

integer(int32)¦null

false

none

none

»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

» previousName

string¦null

false

none

none

» runInParallel

boolean

false

none

none

» externalItemID

string¦null

false

none

none

» ptzId

string¦null

false

none

none

Enumerated Values

Property

Value

scheduleItemType

Folder

scheduleItemType

Calculation

scheduleItemType

Import

scheduleItemType

ExternalTool

scheduleItemType

TaskGeneration

scheduleItemType

StarSchemaPopulation

scheduleItemType

LockPeriod

scheduleItemType

EnableWeb

scheduleItemType

DisableWeb

scheduleItemType

Plan

scheduleItemType

Transformation

scheduleItemType

ClearTable

scheduleItemType

Publish

scheduleItemType

WebReport

scheduleItemType

Optimize

scheduleItemType

TaskRun

scheduleItemType

AddWorkflowMembers

scheduleItemType

UnassignIdleInquiries

scheduleItemType

PurgeHistory

scheduleItemType

ExpiringPasswordEmailNotificationAdmin

scheduleItemType

ExpiringPasswordEmailNotificationWeb

scheduleItemType

EnableWebUsers

scheduleItemType

CloudExternalTool

scheduleItemType

CloudSystemTool

scheduleItemType

IndexRebuild

scheduleItemType

PublishQueryTool

scheduleItemType

CalculateAndLock

scheduleItemType

HealthDashboardEvaluation

scheduleItemType

CalculationComponent

scheduleItemType

RefreshMaterializedView

scheduleItemType

RemoveWorkflowMembers

scheduleItemType

ELTRun

scheduleItemType

CalculationPlanBuilder

lastRunStatus

Success

lastRunStatus

Warning

lastRunStatus

Error

lastRunStatus

Cancelled

lastRunStatus

None

activation

Enabled

activation

DisabledForNextScheduledRunOnly

activation

Disabled

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/scheduleitem/{id}/disable", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/scheduleitem/{id}/disable");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/scheduleitem/{id}/disable',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/scheduleitem/{id}/disable', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/scheduleitem/{id}/disable',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "name": "string",
    "scheduleItemType": "Folder",
    "order": 0,
    "lastRun": "2019-08-24T14:15:22Z",
    "lastRunStatus": "Success",
    "activation": "Enabled",
    "nextRun": "2019-08-24T14:15:22Z",
    "parent": 0,
    "scheduledTime": {
      "id": 0,
      "scheduleItemId": 0,
      "minute": 0,
      "hour": 0,
      "dayOfMonth": 0,
      "month": 0,
      "dayOfWeek": 0,
      "nextRunTime": "2019-08-24T14:15:22Z",
      "isDSTAdjusted": true,
      "version": {}
    },
    "parentItem": null,
    "childScheduleItems": [],
    "settings": {
      "schedulerSettingsId": 0,
      "scheduleItemId": 0,
      "parentSettingsID": 0,
      "emailOnFailure": true,
      "emailOnSuccess": true,
      "stopOnFailure": true,
      "stopToolOnTimeout": true,
      "isGlobal": true,
      "overrideChildSettings": true,
      "successEmails": [],
      "failEmails": [],
      "externalToolTimeout": 0,
      "parentSettings": null,
      "enableRetries": true,
      "retries": 0,
      "interval": 0,
      "version": {}
    },
    "version": {
      "rowVersion": 0
    },
    "previousName": "string",
    "runInParallel": true,
    "externalItemID": "string",
    "ptzId": "string"
  }
]
[{"id":0,"name":"string","scheduleItemType":"Folder","order":0,"lastRun":"2019-08-24T14:15:22Z","lastRunStatus":"Success","activation":"Enabled","nextRun":"2019-08-24T14:15:22Z","parent":0,"scheduledTime":{"id":0,"scheduleItemId":0,"minute":0,"hour":0,"dayOfMonth":0,"month":0,"dayOfWeek":0,"nextRunTime":"2019-08-24T14:15:22Z","isDSTAdjusted":true,"version":{}},"parentItem":null,"childScheduleItems":[],"settings":{"schedulerSettingsId":0,"scheduleItemId":0,"parentSettingsID":0,"emailOnFailure":true,"emailOnSuccess":true,"stopOnFailure":true,"stopToolOnTimeout":true,"isGlobal":true,"overrideChildSettings":true,"successEmails":[],"failEmails":[],"externalToolTimeout":0,"parentSettings":null,"enableRetries":true,"retries":0,"interval":0,"version":{}},"version":{"rowVersion":0},"previousName":"string","runInParallel":true,"externalItemID":"string","ptzId":"string"}]

SchedulerProcessesControllerV1_PostDisableScheduleItemNextRunOnly

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Disable an existing schedule item for the next run only

Inline

404

Not Found

Schedule Item does not exist

None

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» scheduleItemType

string

false

none

none

» order

integer(int32)

false

none

none

» lastRun

string(date-time)

false

none

none

» lastRunStatus

string

false

none

none

» activation

string

false

none

none

» nextRun

string(date-time)

false

none

none

» parent

integer(int32)¦null

false

none

none

» scheduledTime

Varicent.RESTAPI.v1.DTOs.Scheduler.ScheduleTimeDTO

false

none

none

»» id

integer(int32)

false

none

none

»» scheduleItemId

integer(int32)

false

none

none

»» minute

integer(int32)

false

none

none

»» hour

integer(int32)

false

none

none

»» dayOfMonth

integer(int32)

false

none

none

»» month

integer(int32)

false

none

none

»» dayOfWeek

integer(int32)

false

none

none

»» nextRunTime

string(date-time)

false

none

none

»» isDSTAdjusted

boolean¦null

false

none

none

»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»» rowVersion

integer(int64)

false

none

none

» parentItem

any

false

none

none

» childScheduleItems

array¦null

false

none

none

»» anonymous

any

false

none

none

» settings

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

false

none

none

»» schedulerSettingsId

integer(int32)

false

none

none

»» scheduleItemId

integer(int32)¦null

false

none

none

»» parentSettingsID

integer(int32)¦null

false

none

none

»» emailOnFailure

boolean

false

none

none

»» emailOnSuccess

boolean

false

none

none

»» stopOnFailure

boolean

false

none

none

»» stopToolOnTimeout

boolean

false

none

none

»» isGlobal

boolean

false

none

none

»» overrideChildSettings

boolean

false

none

none

»» successEmails

[string]¦null

false

none

none

»» failEmails

[string]¦null

false

none

none

»» externalToolTimeout

integer(int32)

false

none

none

»» parentSettings

any

false

none

none

»» enableRetries

boolean

false

none

none

»» retries

integer(int32)¦null

false

none

none

»» interval

integer(int32)¦null

false

none

none

»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

» previousName

string¦null

false

none

none

» runInParallel

boolean

false

none

none

» externalItemID

string¦null

false

none

none

» ptzId

string¦null

false

none

none

Enumerated Values

Property

Value

scheduleItemType

Folder

scheduleItemType

Calculation

scheduleItemType

Import

scheduleItemType

ExternalTool

scheduleItemType

TaskGeneration

scheduleItemType

StarSchemaPopulation

scheduleItemType

LockPeriod

scheduleItemType

EnableWeb

scheduleItemType

DisableWeb

scheduleItemType

Plan

scheduleItemType

Transformation

scheduleItemType

ClearTable

scheduleItemType

Publish

scheduleItemType

WebReport

scheduleItemType

Optimize

scheduleItemType

TaskRun

scheduleItemType

AddWorkflowMembers

scheduleItemType

UnassignIdleInquiries

scheduleItemType

PurgeHistory

scheduleItemType

ExpiringPasswordEmailNotificationAdmin

scheduleItemType

ExpiringPasswordEmailNotificationWeb

scheduleItemType

EnableWebUsers

scheduleItemType

CloudExternalTool

scheduleItemType

CloudSystemTool

scheduleItemType

IndexRebuild

scheduleItemType

PublishQueryTool

scheduleItemType

CalculateAndLock

scheduleItemType

HealthDashboardEvaluation

scheduleItemType

CalculationComponent

scheduleItemType

RefreshMaterializedView

scheduleItemType

RemoveWorkflowMembers

scheduleItemType

ELTRun

scheduleItemType

CalculationPlanBuilder

lastRunStatus

Success

lastRunStatus

Warning

lastRunStatus

Error

lastRunStatus

Cancelled

lastRunStatus

None

activation

Enabled

activation

DisabledForNextScheduledRunOnly

activation

Disabled

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/scheduleitem/{id}/disablenextrun", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/scheduleitem/{id}/disablenextrun");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/scheduleitem/{id}/disablenextrun',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/scheduleitem/{id}/disablenextrun', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/scheduleitem/{id}/disablenextrun',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "name": "string",
    "scheduleItemType": "Folder",
    "order": 0,
    "lastRun": "2019-08-24T14:15:22Z",
    "lastRunStatus": "Success",
    "activation": "Enabled",
    "nextRun": "2019-08-24T14:15:22Z",
    "parent": 0,
    "scheduledTime": {
      "id": 0,
      "scheduleItemId": 0,
      "minute": 0,
      "hour": 0,
      "dayOfMonth": 0,
      "month": 0,
      "dayOfWeek": 0,
      "nextRunTime": "2019-08-24T14:15:22Z",
      "isDSTAdjusted": true,
      "version": {}
    },
    "parentItem": null,
    "childScheduleItems": [],
    "settings": {
      "schedulerSettingsId": 0,
      "scheduleItemId": 0,
      "parentSettingsID": 0,
      "emailOnFailure": true,
      "emailOnSuccess": true,
      "stopOnFailure": true,
      "stopToolOnTimeout": true,
      "isGlobal": true,
      "overrideChildSettings": true,
      "successEmails": [],
      "failEmails": [],
      "externalToolTimeout": 0,
      "parentSettings": null,
      "enableRetries": true,
      "retries": 0,
      "interval": 0,
      "version": {}
    },
    "version": {
      "rowVersion": 0
    },
    "previousName": "string",
    "runInParallel": true,
    "externalItemID": "string",
    "ptzId": "string"
  }
]
[{"id":0,"name":"string","scheduleItemType":"Folder","order":0,"lastRun":"2019-08-24T14:15:22Z","lastRunStatus":"Success","activation":"Enabled","nextRun":"2019-08-24T14:15:22Z","parent":0,"scheduledTime":{"id":0,"scheduleItemId":0,"minute":0,"hour":0,"dayOfMonth":0,"month":0,"dayOfWeek":0,"nextRunTime":"2019-08-24T14:15:22Z","isDSTAdjusted":true,"version":{}},"parentItem":null,"childScheduleItems":[],"settings":{"schedulerSettingsId":0,"scheduleItemId":0,"parentSettingsID":0,"emailOnFailure":true,"emailOnSuccess":true,"stopOnFailure":true,"stopToolOnTimeout":true,"isGlobal":true,"overrideChildSettings":true,"successEmails":[],"failEmails":[],"externalToolTimeout":0,"parentSettings":null,"enableRetries":true,"retries":0,"interval":0,"version":{}},"version":{"rowVersion":0},"previousName":"string","runInParallel":true,"externalItemID":"string","ptzId":"string"}]

SchedulerProcessesControllerV1_PatchScheduleItemRunInParallel

Body parameter

{
  "order": 0,
  "runInParallel": true
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

RESTAPI.v1.DTOs.ScheduleItemPatchDTO

false

none

» order

body

integer(int32)

false

none

» runInParallel

body

boolean¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Update Run In Parallel toggle

Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO

404

Not Found

Schedule Item does not exist

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/scheduleitem/{id}/runinparallel", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/scheduleitem/{id}/runinparallel");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "order": 0,
  "runInParallel": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/scheduleitem/{id}/runinparallel',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/scheduleitem/{id}/runinparallel', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/scheduleitem/{id}/runinparallel',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "scheduleItemType": "Folder",
  "order": 0,
  "lastRun": "2019-08-24T14:15:22Z",
  "lastRunStatus": "Success",
  "activation": "Enabled",
  "nextRun": "2019-08-24T14:15:22Z",
  "parent": 0,
  "scheduledTime": {
    "id": 0,
    "scheduleItemId": 0,
    "minute": 0,
    "hour": 0,
    "dayOfMonth": 0,
    "month": 0,
    "dayOfWeek": 0,
    "nextRunTime": "2019-08-24T14:15:22Z",
    "isDSTAdjusted": true,
    "version": {
      "rowVersion": 0
    }
  },
  "parentItem": null,
  "childScheduleItems": [],
  "settings": {
    "schedulerSettingsId": 0,
    "scheduleItemId": 0,
    "parentSettingsID": 0,
    "emailOnFailure": true,
    "emailOnSuccess": true,
    "stopOnFailure": true,
    "stopToolOnTimeout": true,
    "isGlobal": true,
    "overrideChildSettings": true,
    "successEmails": [
      "string"
    ],
    "failEmails": [
      "string"
    ],
    "externalToolTimeout": 0,
    "parentSettings": null,
    "enableRetries": true,
    "retries": 0,
    "interval": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "version": {
    "rowVersion": 0
  },
  "previousName": "string",
  "runInParallel": true,
  "externalItemID": "string",
  "ptzId": "string"
}
{"id":0,"name":"string","scheduleItemType":"Folder","order":0,"lastRun":"2019-08-24T14:15:22Z","lastRunStatus":"Success","activation":"Enabled","nextRun":"2019-08-24T14:15:22Z","parent":0,"scheduledTime":{"id":0,"scheduleItemId":0,"minute":0,"hour":0,"dayOfMonth":0,"month":0,"dayOfWeek":0,"nextRunTime":"2019-08-24T14:15:22Z","isDSTAdjusted":true,"version":{"rowVersion":0}},"parentItem":null,"childScheduleItems":[],"settings":{"schedulerSettingsId":0,"scheduleItemId":0,"parentSettingsID":0,"emailOnFailure":true,"emailOnSuccess":true,"stopOnFailure":true,"stopToolOnTimeout":true,"isGlobal":true,"overrideChildSettings":true,"successEmails":["string"],"failEmails":["string"],"externalToolTimeout":0,"parentSettings":null,"enableRetries":true,"retries":0,"interval":0,"version":{"rowVersion":0}},"version":{"rowVersion":0},"previousName":"string","runInParallel":true,"externalItemID":"string","ptzId":"string"}

Get a schedule item’s settings.

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

404

Not Found

Global settings were not found.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/globalschedulersettings", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/globalschedulersettings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/globalschedulersettings',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/globalschedulersettings', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/globalschedulersettings',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "schedulerSettingsId": 0,
  "scheduleItemId": 0,
  "parentSettingsID": 0,
  "emailOnFailure": true,
  "emailOnSuccess": true,
  "stopOnFailure": true,
  "stopToolOnTimeout": true,
  "isGlobal": true,
  "overrideChildSettings": true,
  "successEmails": [
    "string"
  ],
  "failEmails": [
    "string"
  ],
  "externalToolTimeout": 0,
  "parentSettings": null,
  "enableRetries": true,
  "retries": 0,
  "interval": 0,
  "version": {
    "rowVersion": 0
  }
}
{"schedulerSettingsId":0,"scheduleItemId":0,"parentSettingsID":0,"emailOnFailure":true,"emailOnSuccess":true,"stopOnFailure":true,"stopToolOnTimeout":true,"isGlobal":true,"overrideChildSettings":true,"successEmails":["string"],"failEmails":["string"],"externalToolTimeout":0,"parentSettings":null,"enableRetries":true,"retries":0,"interval":0,"version":{"rowVersion":0}}

Create or update schedule settings.

Body parameter

{
  "schedulerSettingsId": 0,
  "scheduleItemId": 0,
  "parentSettingsID": 0,
  "emailOnFailure": true,
  "emailOnSuccess": true,
  "stopOnFailure": true,
  "stopToolOnTimeout": true,
  "isGlobal": true,
  "overrideChildSettings": true,
  "successEmails": [
    "string"
  ],
  "failEmails": [
    "string"
  ],
  "externalToolTimeout": 0,
  "parentSettings": null,
  "enableRetries": true,
  "retries": 0,
  "interval": 0,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

ID of the schedule item

body

body

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

false

none

» schedulerSettingsId

body

integer(int32)

false

none

» scheduleItemId

body

integer(int32)¦null

false

none

» parentSettingsID

body

integer(int32)¦null

false

none

» emailOnFailure

body

boolean

false

none

» emailOnSuccess

body

boolean

false

none

» stopOnFailure

body

boolean

false

none

» stopToolOnTimeout

body

boolean

false

none

» isGlobal

body

boolean

false

none

» overrideChildSettings

body

boolean

false

none

» successEmails

body

[string]¦null

false

none

» failEmails

body

[string]¦null

false

none

» externalToolTimeout

body

integer(int32)

false

none

» parentSettings

body

any

false

none

» enableRetries

body

boolean

false

none

» retries

body

integer(int32)¦null

false

none

» interval

body

integer(int32)¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/scheduleitem/{id}/settings", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/scheduleitem/{id}/settings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "schedulerSettingsId": 0,
  "scheduleItemId": 0,
  "parentSettingsID": 0,
  "emailOnFailure": true,
  "emailOnSuccess": true,
  "stopOnFailure": true,
  "stopToolOnTimeout": true,
  "isGlobal": true,
  "overrideChildSettings": true,
  "successEmails": [
    "string"
  ],
  "failEmails": [
    "string"
  ],
  "externalToolTimeout": 0,
  "parentSettings": null,
  "enableRetries": true,
  "retries": 0,
  "interval": 0,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/scheduleitem/{id}/settings',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/scheduleitem/{id}/settings', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/scheduleitem/{id}/settings',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "schedulerSettingsId": 0,
  "scheduleItemId": 0,
  "parentSettingsID": 0,
  "emailOnFailure": true,
  "emailOnSuccess": true,
  "stopOnFailure": true,
  "stopToolOnTimeout": true,
  "isGlobal": true,
  "overrideChildSettings": true,
  "successEmails": [
    "string"
  ],
  "failEmails": [
    "string"
  ],
  "externalToolTimeout": 0,
  "parentSettings": null,
  "enableRetries": true,
  "retries": 0,
  "interval": 0,
  "version": {
    "rowVersion": 0
  }
}
{"schedulerSettingsId":0,"scheduleItemId":0,"parentSettingsID":0,"emailOnFailure":true,"emailOnSuccess":true,"stopOnFailure":true,"stopToolOnTimeout":true,"isGlobal":true,"overrideChildSettings":true,"successEmails":["string"],"failEmails":["string"],"externalToolTimeout":0,"parentSettings":null,"enableRetries":true,"retries":0,"interval":0,"version":{"rowVersion":0}}

SchedulerProcessesControllerV1_DeleteSettings

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Delete a scheduler item’s settings

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/scheduleitem/{id}/settings", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/scheduleitem/{id}/settings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/scheduleitem/{id}/settings',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/scheduleitem/{id}/settings')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/scheduleitem/{id}/settings',
  params: {
  }

p JSON.parse(result)

Update schedule settings.

Body parameter

{
  "schedulerSettingsId": 0,
  "scheduleItemId": 0,
  "parentSettingsID": 0,
  "emailOnFailure": true,
  "emailOnSuccess": true,
  "stopOnFailure": true,
  "stopToolOnTimeout": true,
  "isGlobal": true,
  "overrideChildSettings": true,
  "successEmails": [
    "string"
  ],
  "failEmails": [
    "string"
  ],
  "externalToolTimeout": 0,
  "parentSettings": null,
  "enableRetries": true,
  "retries": 0,
  "interval": 0,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

false

none

» schedulerSettingsId

body

integer(int32)

false

none

» scheduleItemId

body

integer(int32)¦null

false

none

» parentSettingsID

body

integer(int32)¦null

false

none

» emailOnFailure

body

boolean

false

none

» emailOnSuccess

body

boolean

false

none

» stopOnFailure

body

boolean

false

none

» stopToolOnTimeout

body

boolean

false

none

» isGlobal

body

boolean

false

none

» overrideChildSettings

body

boolean

false

none

» successEmails

body

[string]¦null

false

none

» failEmails

body

[string]¦null

false

none

» externalToolTimeout

body

integer(int32)

false

none

» parentSettings

body

any

false

none

» enableRetries

body

boolean

false

none

» retries

body

integer(int32)¦null

false

none

» interval

body

integer(int32)¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/globalschedulersettings", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/globalschedulersettings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "schedulerSettingsId": 0,
  "scheduleItemId": 0,
  "parentSettingsID": 0,
  "emailOnFailure": true,
  "emailOnSuccess": true,
  "stopOnFailure": true,
  "stopToolOnTimeout": true,
  "isGlobal": true,
  "overrideChildSettings": true,
  "successEmails": [
    "string"
  ],
  "failEmails": [
    "string"
  ],
  "externalToolTimeout": 0,
  "parentSettings": null,
  "enableRetries": true,
  "retries": 0,
  "interval": 0,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/globalschedulersettings',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/globalschedulersettings', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/globalschedulersettings',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "schedulerSettingsId": 0,
  "scheduleItemId": 0,
  "parentSettingsID": 0,
  "emailOnFailure": true,
  "emailOnSuccess": true,
  "stopOnFailure": true,
  "stopToolOnTimeout": true,
  "isGlobal": true,
  "overrideChildSettings": true,
  "successEmails": [
    "string"
  ],
  "failEmails": [
    "string"
  ],
  "externalToolTimeout": 0,
  "parentSettings": null,
  "enableRetries": true,
  "retries": 0,
  "interval": 0,
  "version": {
    "rowVersion": 0
  }
}
{"schedulerSettingsId":0,"scheduleItemId":0,"parentSettingsID":0,"emailOnFailure":true,"emailOnSuccess":true,"stopOnFailure":true,"stopToolOnTimeout":true,"isGlobal":true,"overrideChildSettings":true,"successEmails":["string"],"failEmails":["string"],"externalToolTimeout":0,"parentSettings":null,"enableRetries":true,"retries":0,"interval":0,"version":{"rowVersion":0}}

This method is only called by ScheduleRunner.RecoverMissedTask() to send the skipped task email and log into the audit table.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

SchedulerRunner call to email and log skipped items

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/{id}/scheduleitemskipped", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/{id}/scheduleitemskipped");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/rpc/{id}/scheduleitemskipped',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/v1/rpc/{id}/scheduleitemskipped')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/v1/rpc/{id}/scheduleitemskipped',
  params: {
  }

p JSON.parse(result)

This method is called by Schedule Service to log into the Scheduler log table.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

type

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

SchedulerRunner call to add scheduler log for an item

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/scheduleitem/{id}/logerror/{type}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/scheduleitem/{id}/logerror/{type}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/scheduleitem/{id}/logerror/{type}',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/v1/scheduleitem/{id}/logerror/{type}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/v1/scheduleitem/{id}/logerror/{type}',
  params: {
  }

p JSON.parse(result)

SchedulerProcessesControllerV1_GetScheduleItemWorkflowExpiry

Responses

Status

Meaning

Description

Schema

200

OK

Get workflow items that are going to expire

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Scheduler.ScheduleItemWorkflowExpiryDTO]

false

none

none

» nextRunTime

string(date-time)

false

none

none

» tokenID

integer(int32)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/scheduleitemworkflowexpiry", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/scheduleitemworkflowexpiry");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/scheduleitemworkflowexpiry',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/scheduleitemworkflowexpiry', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/scheduleitemworkflowexpiry',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "nextRunTime": "2019-08-24T14:15:22Z",
    "tokenID": 0
  }
]
[{"nextRunTime":"2019-08-24T14:15:22Z","tokenID":0}]

SchedulerProcessesControllerV1_HandleScheduleItemWorkflowExpiry

Parameters

Name

In

Type

Required

Description

tokenID

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Process a expired action node

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/scheduleitemworkflowexpiry/{tokenID}/expire", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/scheduleitemworkflowexpiry/{tokenID}/expire");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/rpc/scheduleitemworkflowexpiry/{tokenID}/expire',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/v1/rpc/scheduleitemworkflowexpiry/{tokenID}/expire')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/v1/rpc/scheduleitemworkflowexpiry/{tokenID}/expire',
  params: {
  }

p JSON.parse(result)

SchedulerProcessesControllerV1_HandleScheduleItemPublicationExpiry

Responses

Status

Meaning

Description

Schema

200

OK

Check SFTP server for expired pdf publications

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/scheduleitempublicationexpiry/expire", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/scheduleitempublicationexpiry/expire");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/rpc/scheduleitempublicationexpiry/expire',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/v1/rpc/scheduleitempublicationexpiry/expire')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/v1/rpc/scheduleitempublicationexpiry/expire',
  params: {
  }

p JSON.parse(result)

StarSchema

Get all star schemas.

Responses

Status

Meaning

Description

Schema

200

OK

Get all star schemas

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.StarSchema.StarSchemaDefinitionDTO]

false

none

none

» name

string¦null

false

none

none

» fact

string¦null

false

none

none

» columnMap

object¦null

false

none

none

»» additionalProperties

string¦null

false

none

none

» factColumns

[Varicent.RESTAPI.v1.DTOs.StarSchema.FactColumnDTO]¦null

false

none

none

»» name

string¦null

false

none

none

»» sourceTable

string¦null

false

none

none

»» joiningColumn

string¦null

false

none

none

» dataStoreID

integer(int32)

false

none

none

» sourceTableDimMap

object¦null

false

none

none

»» additionalProperties

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/starschema", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/starschema");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/starschema',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/starschema', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/starschema',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "name": "string",
    "fact": "string",
    "columnMap": {
      "property1": "string",
      "property2": "string"
    },
    "factColumns": [
      {}
    ],
    "dataStoreID": 0,
    "sourceTableDimMap": {
      "property1": "string",
      "property2": "string"
    }
  }
]
[{"name":"string","fact":"string","columnMap":{"property1":"string","property2":"string"},"factColumns":[{}],"dataStoreID":0,"sourceTableDimMap":{"property1":"string","property2":"string"}}]

Create a new star schema.

Json object container necessary parameters (name, cultureCode, dataStoreID) used to create a new star schema.

Body parameter

null

json-object-container-necessary-parameters-(name,-culturecode,-datastoreid)-used-to-create-a-new-star-schema. -parameters">Parameters

Name

In

Type

Required

Description

body

body

any

false

none

json-object-container-necessary-parameters-(name,-culturecode,-datastoreid)-used-to-create-a-new-star-schema. -responses">Responses

Status

Meaning

Description

Schema

200

OK

Create new star schema

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/starschema", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/starschema");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = 'null';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/starschema',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/starschema', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/starschema',
  params: {
  }, headers: headers

p JSON.parse(result)

Get star schema by name.

Parameters

Name

In

Type

Required

Description

name

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get star schema by name

Varicent.RESTAPI.v1.DTOs.StarSchema.StarSchemaDefinitionDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/starschema/{name}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/starschema/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/starschema/{name}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/starschema/{name}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/starschema/{name}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "name": "string",
  "fact": "string",
  "columnMap": {
    "property1": "string",
    "property2": "string"
  },
  "factColumns": [
    {
      "name": "string",
      "sourceTable": "string",
      "joiningColumn": "string"
    }
  ],
  "dataStoreID": 0,
  "sourceTableDimMap": {
    "property1": "string",
    "property2": "string"
  }
}
{"name":"string","fact":"string","columnMap":{"property1":"string","property2":"string"},"factColumns":[{"name":"string","sourceTable":"string","joiningColumn":"string"}],"dataStoreID":0,"sourceTableDimMap":{"property1":"string","property2":"string"}}

Delete a star schema by name.

Parameters

Name

In

Type

Required

Description

name

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Delete star schema by name

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/starschema/{name}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/starschema/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/starschema/{name}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/starschema/{name}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/starschema/{name}',
  params: {
  }

p JSON.parse(result)

Get star schema table preview data.

Parameters

Name

In

Type

Required

Description

table

path

string

true

none

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

filter

query

string

false

####Supported operations

fields

query

string

false

Comma delimited list of fields to display. Used to limit the output results to selected columns.

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

Any column

fields: Comma delimited list of fields to display. Used to limit the output results to selected columns.

Defaults to all available fields.

Examples

fields=PayeeID_

Responses

Status

Meaning

Description

Schema

200

OK

Get star schema table preview data

Varicent.RESTAPI.v1.DTOs.ResultSetDTOVaricent.RESTAPI.v1.DTOs.ResultSetDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/starschema/{table}/preview", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/starschema/{table}/preview");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/starschema/{table}/preview',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/starschema/{table}/preview', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/starschema/{table}/preview',
  params: {
  }, headers: headers

p JSON.parse(result)

User

SYSTEM CALL: Get all admin users with passwords.

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.VaricentUserDTO]

false

none

none

» changePassAtNextLogin

boolean

false

none

none

» createdAt

string(date-time)

false

none

none

» disabled

boolean

false

none

none

» encryptionVersion

string

false

none

none

» hasVersion

boolean

false

none

none

» id

string¦null

false

none

none

» lastPasswordExpireMail

string(date-time)¦null

false

none

none

» lastPasswordExpirePrompt

string(date-time)¦null

false

none

none

» email

string¦null

false

none

none

» name

string¦null

false

none

none

» nbFailedLogOnAttempts

integer(int32)

false

none

none

» password

string¦null

false

none

none

» passwordLastChanged

string(date-time)

false

none

none

» roleDefinition

Varicent.RESTAPI.v1.DTOs.RoleDefinitionDTO

false

none

none

»» id

integer(int32)

false

none

none

»» name

string¦null

false

none

none

»» displayName

string¦null

false

none

none

»» permissions

[Varicent.RESTAPI.v1.DTOs.RolePermissionDTO]¦null

false

none

none

»»» path

string¦null

false

none

none

»»» name

string¦null

false

none

none

»» permissionPaths

[string]¦null

false

none

none

»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»» rowVersion

integer(int64)

false

none

none

» salt

string¦null

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

encryptionVersion

Version1

encryptionVersion

Version2

encryptionVersion

Version3

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/userswithpassword", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/userswithpassword");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/userswithpassword',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/userswithpassword', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/userswithpassword',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "changePassAtNextLogin": true,
    "createdAt": "2019-08-24T14:15:22Z",
    "disabled": true,
    "encryptionVersion": "Version1",
    "hasVersion": true,
    "id": "string",
    "lastPasswordExpireMail": "2019-08-24T14:15:22Z",
    "lastPasswordExpirePrompt": "2019-08-24T14:15:22Z",
    "email": "string",
    "name": "string",
    "nbFailedLogOnAttempts": 0,
    "password": "string",
    "passwordLastChanged": "2019-08-24T14:15:22Z",
    "roleDefinition": {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "permissions": [],
      "permissionPaths": [],
      "version": {}
    },
    "salt": "string",
    "version": {
      "rowVersion": 0
    }
  }
]
[{"changePassAtNextLogin":true,"createdAt":"2019-08-24T14:15:22Z","disabled":true,"encryptionVersion":"Version1","hasVersion":true,"id":"string","lastPasswordExpireMail":"2019-08-24T14:15:22Z","lastPasswordExpirePrompt":"2019-08-24T14:15:22Z","email":"string","name":"string","nbFailedLogOnAttempts":0,"password":"string","passwordLastChanged":"2019-08-24T14:15:22Z","roleDefinition":{"id":0,"name":"string","displayName":"string","permissions":[],"permissionPaths":[],"version":{}},"salt":"string","version":{"rowVersion":0}}]

Get all admin users.

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.AdminUserDTO]

false

none

none

» id

string¦null

false

none

none

» name

string¦null

false

none

none

» email

string¦null

false

none

none

» role

string¦null

false

none

none

» createdAt

string(date-time)

false

none

none

» disabled

boolean

false

none

none

» isVaricentUser

boolean

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/users", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/users',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/users', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/users',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": "string",
    "name": "string",
    "email": "string",
    "role": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "disabled": true,
    "isVaricentUser": true,
    "version": {
      "rowVersion": 0
    }
  }
]
[{"id":"string","name":"string","email":"string","role":"string","createdAt":"2019-08-24T14:15:22Z","disabled":true,"isVaricentUser":true,"version":{"rowVersion":0}}]

Add a log to audit log of the user being added

Body parameter

{
  "id": "string",
  "role": {
    "id": 0,
    "name": "string",
    "displayName": "string",
    "permissions": [
      {}
    ],
    "permissionPaths": [
      "string"
    ],
    "version": {
      "rowVersion": 0
    }
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "disabled": true
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.UserDTO

false

none

» id

body

string¦null

false

none

» role

body

Varicent.RESTAPI.v1.DTOs.RoleDefinitionDTO

false

none

»» id

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» displayName

body

string¦null

false

none

»» permissions

body

[Varicent.RESTAPI.v1.DTOs.RolePermissionDTO]¦null

false

none

»»» path

body

string¦null

false

none

»»» name

body

string¦null

false

none

»» permissionPaths

body

[string]¦null

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» rowVersion

body

integer(int64)

false

none

» createdAt

body

string(date-time)

false

none

» disabled

body

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/users/logadminadd", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/users/logadminadd");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": "string",
  "role": {
    "id": 0,
    "name": "string",
    "displayName": "string",
    "permissions": [
      {}
    ],
    "permissionPaths": [
      "string"
    ],
    "version": {
      "rowVersion": 0
    }
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "disabled": true
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/users/logadminadd',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/users/logadminadd', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/users/logadminadd',
  params: {
  }, headers: headers

p JSON.parse(result)

Add a log to audit log of the user being deleted

Body parameter

{
  "id": "string",
  "role": {
    "id": 0,
    "name": "string",
    "displayName": "string",
    "permissions": [
      {}
    ],
    "permissionPaths": [
      "string"
    ],
    "version": {
      "rowVersion": 0
    }
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "disabled": true
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.UserDTO

false

none

» id

body

string¦null

false

none

» role

body

Varicent.RESTAPI.v1.DTOs.RoleDefinitionDTO

false

none

»» id

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» displayName

body

string¦null

false

none

»» permissions

body

[Varicent.RESTAPI.v1.DTOs.RolePermissionDTO]¦null

false

none

»»» path

body

string¦null

false

none

»»» name

body

string¦null

false

none

»» permissionPaths

body

[string]¦null

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» rowVersion

body

integer(int64)

false

none

» createdAt

body

string(date-time)

false

none

» disabled

body

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/users/logadmindelete", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/users/logadmindelete");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": "string",
  "role": {
    "id": 0,
    "name": "string",
    "displayName": "string",
    "permissions": [
      {}
    ],
    "permissionPaths": [
      "string"
    ],
    "version": {
      "rowVersion": 0
    }
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "disabled": true
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/users/logadmindelete',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/users/logadmindelete', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/users/logadmindelete',
  params: {
  }, headers: headers

p JSON.parse(result)

Get the current user’s list of permissions.

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/permissions/currentPermissions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/permissions/currentPermissions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/permissions/currentPermissions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/permissions/currentPermissions', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/permissions/currentPermissions',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  "string"
]
["string"]

Get a given admin user’s list of permissions.

Parameters

Name

In

Type

Required

Description

id

path

string

true

User ID of the user to get the permissions of

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.RolePermissionDTO]

false

none

none

» path

string¦null

false

none

none

» name

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/users/{id}/permissions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/users/{id}/permissions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/users/{id}/permissions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/users/{id}/permissions', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/users/{id}/permissions',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "path": "string",
    "name": "string"
  }
]
[{"path":"string","name":"string"}]

Update an admin user’s role.

Body parameter

{
  "id": 0,
  "name": "string",
  "displayName": "string",
  "permissions": [
    {
      "path": "string",
      "name": "string"
    }
  ],
  "permissionPaths": [
    "string"
  ],
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

id

path

string

true

none

isNew

query

boolean

false

none

body

body

Varicent.RESTAPI.v1.DTOs.RoleDefinitionDTO

false

none

» id

body

integer(int32)

false

none

» name

body

string¦null

false

none

» displayName

body

string¦null

false

none

» permissions

body

[Varicent.RESTAPI.v1.DTOs.RolePermissionDTO]¦null

false

none

»» path

body

string¦null

false

none

»» name

body

string¦null

false

none

» permissionPaths

body

[string]¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.UserDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/users/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/users/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "name": "string",
  "displayName": "string",
  "permissions": [
    {
      "path": "string",
      "name": "string"
    }
  ],
  "permissionPaths": [
    "string"
  ],
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/users/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/users/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/users/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": "string",
  "role": {
    "id": 0,
    "name": "string",
    "displayName": "string",
    "permissions": [
      {}
    ],
    "permissionPaths": [
      "string"
    ],
    "version": {
      "rowVersion": 0
    }
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "disabled": true
}
{"id":"string","role":{"id":0,"name":"string","displayName":"string","permissions":[{}],"permissionPaths":["string"],"version":{"rowVersion":0}},"createdAt":"2019-08-24T14:15:22Z","disabled":true}

UsersControllerV1_GetAllRoles

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.RoleDefinitionDTO]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» displayName

string¦null

false

none

none

» permissions

[Varicent.RESTAPI.v1.DTOs.RolePermissionDTO]¦null

false

none

none

»» path

string¦null

false

none

none

»» name

string¦null

false

none

none

» permissionPaths

[string]¦null

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/roles", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/roles");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/roles',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/roles', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/roles',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "name": "string",
    "displayName": "string",
    "permissions": [
      {}
    ],
    "permissionPaths": [
      "string"
    ],
    "version": {
      "rowVersion": 0
    }
  }
]
[{"id":0,"name":"string","displayName":"string","permissions":[{}],"permissionPaths":["string"],"version":{"rowVersion":0}}]

UsersControllerV1_PostRole

Body parameter

{
  "id": 0,
  "name": "string",
  "displayName": "string",
  "permissions": [
    {
      "path": "string",
      "name": "string"
    }
  ],
  "permissionPaths": [
    "string"
  ],
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.RoleDefinitionDTO

false

none

» id

body

integer(int32)

false

none

» name

body

string¦null

false

none

» displayName

body

string¦null

false

none

» permissions

body

[Varicent.RESTAPI.v1.DTOs.RolePermissionDTO]¦null

false

none

»» path

body

string¦null

false

none

»» name

body

string¦null

false

none

» permissionPaths

body

[string]¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.RoleDefinitionDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/roles", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/roles");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "name": "string",
  "displayName": "string",
  "permissions": [
    {
      "path": "string",
      "name": "string"
    }
  ],
  "permissionPaths": [
    "string"
  ],
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/roles',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/roles', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/roles',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "displayName": "string",
  "permissions": [
    {
      "path": "string",
      "name": "string"
    }
  ],
  "permissionPaths": [
    "string"
  ],
  "version": {
    "rowVersion": 0
  }
}
{"id":0,"name":"string","displayName":"string","permissions":[{"path":"string","name":"string"}],"permissionPaths":["string"],"version":{"rowVersion":0}}

UsersControllerV1_GetRole

Parameters

Name

In

Type

Required

Description

id

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.RoleDefinitionDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/roles/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/roles/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/roles/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/roles/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/roles/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "displayName": "string",
  "permissions": [
    {
      "path": "string",
      "name": "string"
    }
  ],
  "permissionPaths": [
    "string"
  ],
  "version": {
    "rowVersion": 0
  }
}
{"id":0,"name":"string","displayName":"string","permissions":[{"path":"string","name":"string"}],"permissionPaths":["string"],"version":{"rowVersion":0}}

UsersControllerV1_DeleteRole

Parameters

Name

In

Type

Required

Description

id

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/roles/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/roles/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/roles/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/roles/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/roles/{id}',
  params: {
  }

p JSON.parse(result)

UsersControllerV1_PutRole

Body parameter

{
  "id": 0,
  "name": "string",
  "displayName": "string",
  "permissions": [
    {
      "path": "string",
      "name": "string"
    }
  ],
  "permissionPaths": [
    "string"
  ],
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

id

path

string

true

none

body

body

Varicent.RESTAPI.v1.DTOs.RoleDefinitionDTO

false

none

» id

body

integer(int32)

false

none

» name

body

string¦null

false

none

» displayName

body

string¦null

false

none

» permissions

body

[Varicent.RESTAPI.v1.DTOs.RolePermissionDTO]¦null

false

none

»» path

body

string¦null

false

none

»» name

body

string¦null

false

none

» permissionPaths

body

[string]¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.RoleDefinitionDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/roles/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/roles/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "name": "string",
  "displayName": "string",
  "permissions": [
    {
      "path": "string",
      "name": "string"
    }
  ],
  "permissionPaths": [
    "string"
  ],
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/roles/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/roles/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/roles/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "displayName": "string",
  "permissions": [
    {
      "path": "string",
      "name": "string"
    }
  ],
  "permissionPaths": [
    "string"
  ],
  "version": {
    "rowVersion": 0
  }
}
{"id":0,"name":"string","displayName":"string","permissions":[{"path":"string","name":"string"}],"permissionPaths":["string"],"version":{"rowVersion":0}}

UsersControllerV1_GetAllPermissions

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.RolePermissionDTO]

false

none

none

» path

string¦null

false

none

none

» name

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/permissions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/permissions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/permissions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/permissions', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/permissions',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "path": "string",
    "name": "string"
  }
]
[{"path":"string","name":"string"}]

UsersControllerV1_GetAllRoleNames

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.RoleDefinitionNameDTO]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» displayName

string¦null

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/permissions/rolenames", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/permissions/rolenames");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/permissions/rolenames',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/permissions/rolenames', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/permissions/rolenames',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "name": "string",
    "displayName": "string",
    "version": {
      "rowVersion": 0
    }
  }
]
[{"id":0,"name":"string","displayName":"string","version":{"rowVersion":0}}]

UsersControllerV1_GetPayeeTypes

Parameters

Name

In

Type

Required

Description

type

path

string

true

none

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

filter

query

string

false

####Supported operations

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

Any column

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» Unmapped

[Varicent.RESTAPI.v1.DTOs.PayeeNameDTO]

false

none

none

»» name

string¦null

false

none

none

»» id

string¦null

false

none

none

» Transactional

[Varicent.RESTAPI.v1.DTOs.PayeeNameDTO]

false

none

none

» NonTransactional

[Varicent.RESTAPI.v1.DTOs.PayeeNameDTO]

false

none

none

» Inactive

[Varicent.RESTAPI.v1.DTOs.PayeeNameDTO]

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/payeetypes/{type}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payeetypes/{type}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/payeetypes/{type}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/payeetypes/{type}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/payeetypes/{type}',
  params: {
  }, headers: headers

p JSON.parse(result)

Get list of payees from a given query and payee type

Body parameter

{
  "limit": 0,
  "offset": 0,
  "timeout": 0,
  "retrieveFromDataServer": "QUERY_SQL",
  "exportFileFormat": "Excel"
}

Parameters

Name

In

Type

Required

Description

type

path

string

true

none

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

fields

query

string

false

Comma delimited list of fields to display. Used to limit the output results to selected columns.

unique

query

boolean

false

Boolean value to select only unique values. Default value is false.

filter

query

string

false

####Supported operations

body

body

Varicent.RESTAPI.v1.DTOs.RunQueryDTO

false

none

» limit

body

integer(int32)

false

none

» offset

body

integer(int32)

false

none

» timeout

body

integer(int32)

false

none

» retrieveFromDataServer

body

string

false

none

» exportFileFormat

body

string

false

none

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

fields: Comma delimited list of fields to display. Used to limit the output results to selected columns.

Defaults to all available fields.

Examples

fields=PayeeID_

unique: Boolean value to select only unique values. Default value is false. When enabled, must specify exactly one column field.

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

Any column

Enumerated Values

Parameter

Value

» retrieveFromDataServer

QUERY_SQL

» retrieveFromDataServer

QUERY_SPARK

» retrieveFromDataServer

QUERY_PRESTO

» exportFileFormat

Excel

» exportFileFormat

MSCRM

» exportFileFormat

Pdf

» exportFileFormat

Salesforce

» exportFileFormat

Text

» exportFileFormat

COS

» exportFileFormat

Zip

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/payeetypes/transfer/{type}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payeetypes/transfer/{type}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "limit": 0,
  "offset": 0,
  "timeout": 0,
  "retrieveFromDataServer": "QUERY_SQL",
  "exportFileFormat": "Excel"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/payeetypes/transfer/{type}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/payeetypes/transfer/{type}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/payeetypes/transfer/{type}',
  params: {
  }, headers: headers

p JSON.parse(result)

UsersControllerV1_PostPayeeTypesTransfer

Body parameter

{
  "from": "string",
  "to": "string",
  "query": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "deltaAdd": [
    "string"
  ],
  "deltaDelete": [
    "string"
  ]
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.PayeeTypeTransferDTO

false

none

» from

body

string¦null

false

none

» to

body

string¦null

false

none

» query

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»» alias

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» table

body

string¦null

false

none

»»»» customSelect

body

string¦null

false

none

»»»» dataType

body

string

false

none

»»»» type

body

string

false

none

»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»» expressionType

body

string

false

none

»»»»»» cases

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» arguments

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»» constraintType

body

string

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» condition

body

any

false

none

»»»»»»»» trueValue

body

any

false

none

»»»»»»»» falseValue

body

any

false

none

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»» constraints

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» literalRight

body

any

false

none

»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» right

body

any

false

none

»»»»»»» expressionLeft

body

any

false

none

»»»»»»» expressionRight

body

any

false

none

»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»» like

body

string¦null

false

none

»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»» trueValue

body

any

false

none

»»»»»» falseValue

body

any

false

none

»»»»»» isDate

body

boolean

false

none

»»»»»» literalType

body

string

false

none

»»»»»» value

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»» m_namespace

body

string¦null

false

none

»»»»» name

body

string¦null

false

none

»»»» query

body

any

false

none

»»»» alias

body

string¦null

false

none

»»»» sourceType

body

string

false

none

»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» joinType

body

string

false

none

»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» constraintType

body

string

false

none

»»»»» op

body

string¦null

false

none

»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» caseSensitive

body

boolean

false

none

»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isPreciseDecimal

body

boolean

false

none

»»»»» like

body

string¦null

false

none

»»»»» escapeWildcards

body

boolean

false

none

»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»» table

body

string¦null

false

none

»»»»» queryDefinitionRight

body

any

false

none

»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» direction

body

string

false

none

»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» distinct

body

boolean

false

none

»»» unionWith

body

any

false

none

»»» exceptWith

body

any

false

none

»» sourceNames

body

object¦null

false

none

»»» additionalProperties

body

string¦null

false

none

» deltaAdd

body

[string]¦null

false

none

» deltaDelete

body

[string]¦null

false

none

Enumerated Values

Parameter

Value

»»»» dataType

Int

»»»» dataType

Decimal

»»»» dataType

DateTime

»»»» dataType

None

»»»» dataType

String

»»»» type

SelectAll

»»»» type

SelectItem

»»»» type

SelectLiteral

»»»» type

SelectCustom

»»»» type

SelectExpression

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» expressionType

caseExpression

»»»»»» expressionType

dataField

»»»»»» expressionType

function

»»»»»» expressionType

ifExpression

»»»»»» expressionType

literal

»»»»»»» constraintType

clause

»»»»»»» constraintType

constraint

»»»»»»» constraintType

expressionConstraint

»»»»»»» constraintType

likeConstraint

»»»»»»» constraintType

rowVersionConstraint

»»»»»»» constraintType

subQueryConstraint

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»» literalType

Integer

»»»»»» literalType

Decimal

»»»»»» literalType

Date

»»»»»» literalType

DateTime

»»»»»» literalType

String

»»»»»» literalType

Float

»»»»»» literalType

Long

»»»»»» literalType

Null

»»»»»» literalType

Parameter

»»»»»» literalType

Guid

»»»»»» literalType

SystemUtcTime

»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» sourceType

Table

»»»» sourceType

Query

»»»» joinType

Inner

»»»» joinType

Left

»»»» joinType

Right

»»»» joinType

Cross

»»»» joinType

CrossApply

»»»» joinType

OuterApply

»»»»» constraintType

clause

»»»»» constraintType

constraint

»»»»» constraintType

expressionConstraint

»»»»» constraintType

likeConstraint

»»»»» constraintType

rowVersionConstraint

»»»»» constraintType

subQueryConstraint

»»»» direction

Ascending

»»»» direction

Descending

»»»» direction

AscendingNullsFirst

»»»» direction

DescendingNullsLast

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/payeetypes/transfer", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payeetypes/transfer");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "from": "string",
  "to": "string",
  "query": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "deltaAdd": [
    "string"
  ],
  "deltaDelete": [
    "string"
  ]
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/payeetypes/transfer',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/payeetypes/transfer', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/payeetypes/transfer',
  params: {
  }, headers: headers

p JSON.parse(result)

UsersControllerV1_PutPayeeTypes

Body parameter

{
  "payeeID": "string",
  "from": "string",
  "to": "string"
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.PayeeTypeMoveDTO

false

none

» payeeID

body

string¦null

false

none

» from

body

string¦null

false

none

» to

body

string¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» Unmapped

[Varicent.RESTAPI.v1.DTOs.PayeeNameDTO]

false

none

none

»» name

string¦null

false

none

none

»» id

string¦null

false

none

none

» Transactional

[Varicent.RESTAPI.v1.DTOs.PayeeNameDTO]

false

none

none

» NonTransactional

[Varicent.RESTAPI.v1.DTOs.PayeeNameDTO]

false

none

none

» Inactive

[Varicent.RESTAPI.v1.DTOs.PayeeNameDTO]

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/payeetypes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payeetypes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "payeeID": "string",
  "from": "string",
  "to": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/payeetypes',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/payeetypes', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/payeetypes',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "Unmapped": [
    {
      "name": "string",
      "id": "string"
    }
  ],
  "Transactional": [
    {
      "name": "string",
      "id": "string"
    }
  ],
  "NonTransactional": [
    {
      "name": "string",
      "id": "string"
    }
  ],
  "Inactive": [
    {
      "name": "string",
      "id": "string"
    }
  ]
}
{"Unmapped":[{"name":"string","id":"string"}],"Transactional":[{"name":"string","id":"string"}],"NonTransactional":[{"name":"string","id":"string"}],"Inactive":[{"name":"string","id":"string"}]}

Get all admin users with tenant service notification emails.

Body parameter

{
  "swimlaneId": 0,
  "queryDTO": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "limit": 0,
    "offset": 0,
    "timeout": 0,
    "retrieveFromDataServer": "QUERY_SQL",
    "exportFileFormat": "Excel"
  },
  "restrictQuery": true
}

Parameters

Name

In

Type

Required

Description

offset

query

integer(int32)

false

none

limit

query

integer(int32)

false

none

filter

query

string

false

none

fields

query

string

false

none

unique

query

boolean

false

none

body

body

RESTAPI.v1.DTOs.BPM.BPMGetSelectedPayeesDTO

false

none

» swimlaneId

body

integer(int32)¦null

false

none

» queryDTO

body

Varicent.RESTAPI.v1.DTOs.RunQueryDefinitionDTO

false

none

»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»» alias

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» table

body

string¦null

false

none

»»»» customSelect

body

string¦null

false

none

»»»» dataType

body

string

false

none

»»»» type

body

string

false

none

»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»» expressionType

body

string

false

none

»»»»»» cases

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» arguments

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»» constraintType

body

string

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» condition

body

any

false

none

»»»»»»»» trueValue

body

any

false

none

»»»»»»»» falseValue

body

any

false

none

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»» constraints

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» literalRight

body

any

false

none

»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» right

body

any

false

none

»»»»»»» expressionLeft

body

any

false

none

»»»»»»» expressionRight

body

any

false

none

»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»» like

body

string¦null

false

none

»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»» trueValue

body

any

false

none

»»»»»» falseValue

body

any

false

none

»»»»»» isDate

body

boolean

false

none

»»»»»» literalType

body

string

false

none

»»»»»» value

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»» m_namespace

body

string¦null

false

none

»»»»» name

body

string¦null

false

none

»»»» query

body

any

false

none

»»»» alias

body

string¦null

false

none

»»»» sourceType

body

string

false

none

»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» joinType

body

string

false

none

»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» constraintType

body

string

false

none

»»»»» op

body

string¦null

false

none

»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» caseSensitive

body

boolean

false

none

»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isPreciseDecimal

body

boolean

false

none

»»»»» like

body

string¦null

false

none

»»»»» escapeWildcards

body

boolean

false

none

»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»» table

body

string¦null

false

none

»»»»» queryDefinitionRight

body

any

false

none

»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» direction

body

string

false

none

»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» distinct

body

boolean

false

none

»»» unionWith

body

any

false

none

»»» exceptWith

body

any

false

none

»» limit

body

integer(int32)

false

none

»» offset

body

integer(int32)

false

none

»» timeout

body

integer(int32)

false

none

»» retrieveFromDataServer

body

string

false

none

»» exportFileFormat

body

string

false

none

» restrictQuery

body

boolean

false

none

Enumerated Values

Parameter

Value

»»»» dataType

Int

»»»» dataType

Decimal

»»»» dataType

DateTime

»»»» dataType

None

»»»» dataType

String

»»»» type

SelectAll

»»»» type

SelectItem

»»»» type

SelectLiteral

»»»» type

SelectCustom

»»»» type

SelectExpression

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» expressionType

caseExpression

»»»»»» expressionType

dataField

»»»»»» expressionType

function

»»»»»» expressionType

ifExpression

»»»»»» expressionType

literal

»»»»»»» constraintType

clause

»»»»»»» constraintType

constraint

»»»»»»» constraintType

expressionConstraint

»»»»»»» constraintType

likeConstraint

»»»»»»» constraintType

rowVersionConstraint

»»»»»»» constraintType

subQueryConstraint

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»» literalType

Integer

»»»»»» literalType

Decimal

»»»»»» literalType

Date

»»»»»» literalType

DateTime

»»»»»» literalType

String

»»»»»» literalType

Float

»»»»»» literalType

Long

»»»»»» literalType

Null

»»»»»» literalType

Parameter

»»»»»» literalType

Guid

»»»»»» literalType

SystemUtcTime

»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» sourceType

Table

»»»» sourceType

Query

»»»» joinType

Inner

»»»» joinType

Left

»»»» joinType

Right

»»»» joinType

Cross

»»»» joinType

CrossApply

»»»» joinType

OuterApply

»»»»» constraintType

clause

»»»»» constraintType

constraint

»»»»» constraintType

expressionConstraint

»»»»» constraintType

likeConstraint

»»»»» constraintType

rowVersionConstraint

»»»»» constraintType

subQueryConstraint

»»»» direction

Ascending

»»»» direction

Descending

»»»» direction

AscendingNullsFirst

»»»» direction

DescendingNullsLast

»» retrieveFromDataServer

QUERY_SQL

»» retrieveFromDataServer

QUERY_SPARK

»» retrieveFromDataServer

QUERY_PRESTO

»» exportFileFormat

Excel

»» exportFileFormat

MSCRM

»» exportFileFormat

Pdf

»» exportFileFormat

Salesforce

»» exportFileFormat

Text

»» exportFileFormat

COS

»» exportFileFormat

Zip

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.ResultSetDTO]

false

none

none

» columnDefinitions

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

none

»» name

string¦null

false

none

none

»» type

string

false

none

none

»» isKey

boolean

false

none

none

»» nullable

boolean

false

none

none

»» values

string¦null

false

none

none

»» lockedPeriod

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

none

»»» start

string(date-time)

false

none

none

»»» end

string(date-time)

false

none

none

»» referencedCol

string¦null

false

none

none

»» picklistFilter

string¦null

false

none

none

»» displayName

string¦null

false

none

none

»» isELTPeriod

boolean¦null

false

none

none

» data

[any]¦null

false

none

none

» columnSourceMap

object¦null

false

none

none

»» additionalProperties

string¦null

false

none

none

» isDataSynced

boolean¦null

false

none

none

» hierarchyMetadata

RESTAPI.v1.DTOs.Hierarchy.HierarchyMetadataDTO

false

none

none

»» tableName

string¦null

false

none

none

»» idColumnName

string¦null

false

none

none

»» parentColumnName

string¦null

false

none

none

Enumerated Values

Property

Value

type

String

type

LongString

type

MaxString

type

Date

type

DateTime

type

Decimal

type

Int

type

Long

type

Float

type

BLOB

type

Identity

type

CLOB

type

RowVersion

type

UID

type

VarCharMax

type

Boolean

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/users/enabled", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/users/enabled");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "swimlaneId": 0,
  "queryDTO": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "limit": 0,
    "offset": 0,
    "timeout": 0,
    "retrieveFromDataServer": "QUERY_SQL",
    "exportFileFormat": "Excel"
  },
  "restrictQuery": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/users/enabled',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/users/enabled', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/users/enabled',
  params: {
  }, headers: headers

p JSON.parse(result)

UsersControllerV2_GetAll

Parameters

Name

In

Type

Required

Description

tenantAdminUsersOnly

query

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v2.DTOs.AdminUserDTO]

false

none

none

» id

string¦null

false

none

none

» email

string¦null

false

none

none

» name

string¦null

false

none

none

» models

[string]¦null

false

none

none

» role

string¦null

false

none

none

» createdAt

string(date-time)

false

none

none

» elearningEmail

string¦null

false

none

none

» ssoNameId

string¦null

false

none

none

» useNativeLogin

boolean

false

none

none

» disabled

boolean

false

none

none

» locked

boolean

false

none

none

» hasApiKey

boolean

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v2/users", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v2/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v2/users',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v2/users', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v2/users',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": "string",
    "email": "string",
    "name": "string",
    "models": [
      "string"
    ],
    "role": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "elearningEmail": "string",
    "ssoNameId": "string",
    "useNativeLogin": true,
    "disabled": true,
    "locked": true,
    "hasApiKey": true
  }
]
[{"id":"string","email":"string","name":"string","models":["string"],"role":"string","createdAt":"2019-08-24T14:15:22Z","elearningEmail":"string","ssoNameId":"string","useNativeLogin":true,"disabled":true,"locked":true,"hasApiKey":true}]

Web Form

Get web form names.

Parameters

Name

In

Type

Required

Description

filter

query

string

false

####Supported operations

Detailed descriptions

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

name

Responses

Status

Meaning

Description

Schema

200

OK

Get all Web Forms, may be filtered by name prefix

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.WebFormNameDTO]

false

none

none

» isFavorite

boolean

false

none

none

» name

string¦null

false

none

none

» id

string¦null

false

none

none

» workflowObjectId

integer(int32)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/webforms", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webforms");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webforms',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/webforms', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/webforms',
  params: {
  }, headers: headers

p JSON.parse(result)

WebFormsControllerV1_Post

Body parameter

{
  "webForm": {
    "id": 0,
    "elementId": 0,
    "name": "string",
    "javaScript": "string",
    "protected": true,
    "filterFirst": true,
    "numRows": 0,
    "numColumns": 0,
    "exportFilter": 0,
    "elements": [
      {}
    ],
    "spans": [
      {}
    ],
    "workflowObjectId": 0,
    "element": {},
    "version": {
      "rowVersion": 0
    }
  },
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Composer.ComposerWebFormElementDTO

false

none

» webForm

body

Varicent.RESTAPI.v1.DTOs.WebFormDefinitionDTO

false

none

»» id

body

integer(int32)

false

none

»» elementId

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» javaScript

body

string¦null

false

none

»» protected

body

boolean

false

none

»» filterFirst

body

boolean

false

none

»» numRows

body

integer(int32)

false

none

»» numColumns

body

integer(int32)

false

none

»» exportFilter

body

integer(int32)

false

none

»» elements

body

[Varicent.RESTAPI.v1.DTOs.WebFormElementDTO]¦null

false

none

»»» row

body

integer(int32)

false

none

»»» column

body

integer(int32)

false

none

»»» type

body

string

false

none

»»» name

body

string¦null

false

none

»»» location

body

string¦null

false

none

»»» resourceType

body

string¦null

false

none

»»» timeId

body

string¦null

false

none

»»» text

body

string¦null

false

none

»»» style

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»» alignment

body

string

false

none

»»»» backColor

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»»»» a

body

integer(int32)

false

none

»»»»» b

body

integer(int32)

false

none

»»»»» g

body

integer(int32)

false

none

»»»»» r

body

integer(int32)

false

none

»»»» font

body

Varicent.RESTAPI.v1.DTOs.FontDefinitionDTO

false

none

»»»»» family

body

string¦null

false

none

»»»»» size

body

number(float)

false

none

»»»»» unit

body

string¦null

false

none

»»»»» bold

body

boolean

false

none

»»»»» italic

body

boolean

false

none

»»»»» underline

body

boolean

false

none

»»»»» strikeout

body

boolean

false

none

»»»» foreColor

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»» definition

body

Varicent.RESTAPI.v1.DTOs.TableDefinitionDTO

false

none

»»»» table

body

Varicent.RESTAPI.v1.DTOs.CustomTableDTO

false

none

»»»»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»» rowVersion

body

integer(int64)

false

none

»»»»» name

body

string¦null

false

none

»»»»» tableType

body

string

false

none

»»»»» effectiveDated

body

boolean

false

none

»»»»» workflowObjectID

body

integer(int32)

false

none

»»»»» hierarchyMetadata

body

RESTAPI.v1.DTOs.Hierarchy.HierarchyMetadataDTO

false

none

»»»»»» tableName

body

string¦null

false

none

»»»»»» idColumnName

body

string¦null

false

none

»»»»»» parentColumnName

body

string¦null

false

none

»»»»» lastUpdatedTracking

body

boolean¦null

false

none

»»»» columns

body

[Varicent.RESTAPI.v1.DTOs.ColumnDefinitionDTO]¦null

false

none

»»»»» column

body

Varicent.RESTAPI.v1.DTOs.CustomColumnDTO

false

none

»»»»»» name

body

string¦null

false

none

»»»»»» type

body

string

false

none

»»»»»» referencedTable

body

string¦null

false

none

»»»»»» referencedName

body

string¦null

false

none

»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»»»»»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»»»»»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»»»»»»» alias

body

string¦null

false

none

»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»» customSelect

body

string¦null

false

none

»»»»»»»»» dataType

body

string

false

none

»»»»»»»»» type

body

string

false

none

»»»»»»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»»»»»» constraintType

body

string

false

none

»»»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»»»» condition

body

any

false

none

»»»»»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»»»»»» literalType

body

string

false

none

»»»»»»»»»»»»» value

body

any

false

none

»»»»»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»»»»»» constraints

body

array¦null

false

none

»»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»»» literalRight

body

any

false

none

»»»»»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»»»» right

body

any

false

none

»»»»»»»»»»»» expressionLeft

body

any

false

none

»»»»»»»»»»»» expressionRight

body

any

false

none

»»»»»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»»»»»» like

body

string¦null

false

none

»»»»»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»»»» literalType

body

string

false

none

»»»»»»»»»»» value

body

any

false

none

»»»»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»»» literalType

body

string

false

none

»»»»»»»»»» value

body

any

false

none

»»»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»»»»»»» m_namespace

body

string¦null

false

none

»»»»»»»»»» name

body

string¦null

false

none

»»»»»»»»» query

body

any

false

none

»»»»»»»»» alias

body

string¦null

false

none

»»»»»»»»» sourceType

body

string

false

none

»»»»»»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»»»»» joinType

body

string

false

none

»»»»»»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»»»»»» constraintType

body

string

false

none

»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»»»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»»»» like

body

string¦null

false

none

»»»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»» direction

body

string

false

none

»»»»»»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»» column

body

string¦null

false

none

»»»»»»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»»»» distinct

body

boolean

false

none

»»»»»»»» unionWith

body

any

false

none

»»»»»»»» exceptWith

body

any

false

none

»»»»»»» sourceNames

body

object¦null

false

none

»»»»»»»» additionalProperties

body

string¦null

false

none

»»»»»» pickListParams

body

[Varicent.RESTAPI.v1.DTOs.PickListParamDTO]¦null

false

none

»»»»»»» joinAlias

body

string¦null

false

none

»»»»»»» joinColumn

body

string¦null

false

none

»»»»»»» op

body

string

false

none

»»»»»» isKey

body

boolean

false

none

»»»»» isRemovable

body

boolean

false

none

»»»»» isNullable

body

boolean

false

none

»»»»» referencedColumn

body

string¦null

false

none

»»»» time

body

Varicent.RESTAPI.v1.DTOs.TableTimeDTO

false

none

»»»»» timeId

body

string¦null

false

none

»»»»» dateColumn

body

string¦null

false

none

»»»»» lockedOn

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»»»»» min

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»»»»» max

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»»» tableDefinition

body

Varicent.RESTAPI.v1.DTOs.TableDefinitionDTO

false

none

»»» rules

body

[Varicent.RESTAPI.v1.DTOs.InputRuleDTO]¦null

false

none

»»»» id

body

integer(int32)

false

none

»»»» elementId

body

integer(int32)

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» operatorType

body

string

false

none

»»»» valueType

body

string

false

none

»»»» value

body

any

false

none

»»» columnOptions

body

[Varicent.RESTAPI.v1.DTOs.ColumnOptionsDTO]¦null

false

none

»»»» index

body

integer(int32)

false

none

»»»» width

body

integer(int32)

false

none

»»»» isRequired

body

boolean

false

none

»»» mainTable

body

Varicent.RESTAPI.v1.DTOs.TableDefinitionDTO

false

none

»»» sourceDefinition

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»» filters

body

[Varicent.RESTAPI.v1.DTOs.WebFormFilterDTO]¦null

false

none

»»»» filterId

body

integer(int32)

false

none

»»»» name

body

string¦null

false

none

»»»» sourceTable

body

string¦null

false

none

»»»» sourceColumn

body

string¦null

false

none

»»»» type

body

string

false

none

»»»» op

body

string

false

none

»»»» display

body

string

false

none

»»»» definition

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»»» systemType

body

string¦null

false

none

»»»» filterValueColumn

body

string¦null

false

none

»»»» filterNameColumn

body

string¦null

false

none

»»»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» editableColumns

body

[Varicent.RESTAPI.v1.DTOs.EditableColumnDTO]¦null

false

none

»»»» column

body

Varicent.RESTAPI.v1.DTOs.DataItemDTO

false

none

»»»»» path

body

RESTAPI.v1.DTOs.DataPathDTO

false

none

»»»»»» path

body

[string]¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» alias

body

string¦null

false

none

»»»» index

body

integer(int32)

false

none

»»»» table

body

string¦null

false

none

»»» links

body

[Varicent.RESTAPI.v1.DTOs.LinkDTO]¦null

false

none

»»»» document

body

string¦null

false

none

»»»» openInNewWindow

body

boolean

false

none

»»»» parameters

body

object¦null

false

none

»»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.LinkParameterValueDTO

false

none

»»»»»» dataType

body

string

false

none

»»»»»» source

body

string¦null

false

none

»»»»»» type

body

string

false

none

»»»»»» value

body

string¦null

false

none

»»»» reportId

body

integer(int32)¦null

false

none

»»»» targetId

body

integer(int32)

false

none

»»»» targetType

body

string

false

none

»»»» webFormId

body

integer(int32)¦null

false

none

»»»» webTabId

body

integer(int32)¦null

false

none

»»» webFormSource

body

any

false

none

»»» data

body

any

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»» op

body

string¦null

false

none

»»» displayFormat

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»»» scale

body

integer(int32)

false

none

»»»» style

body

string

false

none

»»» value

body

any

false

none

»»» result

body

any

false

none

»»» link

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»» spans

body

[Varicent.RESTAPI.v1.DTOs.CellSpanDTO]¦null

false

none

»»» row

body

integer(int32)

false

none

»»» columnStart

body

integer(int32)

false

none

»»» columnEnd

body

integer(int32)

false

none

»» workflowObjectId

body

integer(int32)

false

none

»» element

body

Varicent.RESTAPI.v1.DTOs.IExpandableResourceDTO

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

» elementId

body

integer(int32)

false

none

» parentBlockId

body

integer(int32)¦null

false

none

» bounds

body

System.Drawing.RectangleF

false

none

»» location

body

System.Drawing.PointF

false

none

»»» isEmpty

body

boolean

false

none

»»» x

body

number(float)

false

none

»»» y

body

number(float)

false

none

»» size

body

string

false

none

»» x

body

number(float)

false

none

»» y

body

number(float)

false

none

»» width

body

number(float)

false

none

»» height

body

number(float)

false

none

»» left

body

number(float)

false

none

»» top

body

number(float)

false

none

»» right

body

number(float)

false

none

»» bottom

body

number(float)

false

none

»» isEmpty

body

boolean

false

none

» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

» name

body

string¦null

false

none

» parentBlock

body

Varicent.RESTAPI.v1.DTOs.Composer.ExpandableBlockElementDTO

false

none

»» id

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» href

body

string¦null

false

none

» isVisible

body

boolean

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

»»» type

WebFormAdmin

»»» type

WebFormResource

»»» type

WebFormSink

»»» type

WebFormSource

»»» type

WebFormSourceData

»»» type

WebFormValue

»»» type

WebFormValueData

»»» type

WebFormText

»»» resourceType

Image

»»» resourceType

Link

»»»» alignment

Justify

»»»» alignment

Left

»»»» alignment

Center

»»»» alignment

Right

»»»»» tableType

System

»»»»» tableType

Dimension

»»»»» tableType

Structural

»»»»» tableType

Lookup

»»»»» tableType

Data

»»»»» tableType

View

»»»»» tableType

Custom

»»»»» tableType

StarSchema

»»»»» tableType

ExportTable

»»»»» tableType

CreditingRule

»»»»» tableType

AssignTable

»»»»» tableType

PlcmCustomTable

»»»»» tableType

PlcmStructuralTable

»»»»» tableType

PlcmTable

»»»»» tableType

DataSource

»»»»» tableType

Cached

»»»»» tableType

MaterializedView

»»»»»» type

Text

»»»»»» type

Date

»»»»»» type

List

»»»»»» type

Numeric

»»»»»» type

Email

»»»»»» type

Url

»»»»»» type

Comment

»»»»»» type

DateTime

»»»»»»»»» dataType

Int

»»»»»»»»» dataType

Decimal

»»»»»»»»» dataType

DateTime

»»»»»»»»» dataType

None

»»»»»»»»» dataType

String

»»»»»»»»» type

SelectAll

»»»»»»»»» type

SelectItem

»»»»»»»»» type

SelectLiteral

»»»»»»»»» type

SelectCustom

»»»»»»»»» type

SelectExpression

»»»»»»»»»» expressionType

caseExpression

»»»»»»»»»» expressionType

dataField

»»»»»»»»»» expressionType

function

»»»»»»»»»» expressionType

ifExpression

»»»»»»»»»» expressionType

literal

»»»»»»»»»»» expressionType

caseExpression

»»»»»»»»»»» expressionType

dataField

»»»»»»»»»»» expressionType

function

»»»»»»»»»»» expressionType

ifExpression

»»»»»»»»»»» expressionType

literal

»»»»»»»»»»»» constraintType

clause

»»»»»»»»»»»» constraintType

constraint

»»»»»»»»»»»» constraintType

expressionConstraint

»»»»»»»»»»»» constraintType

likeConstraint

»»»»»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»»»»»» constraintType

subQueryConstraint

»»»»»»»»»»»»» expressionType

caseExpression

»»»»»»»»»»»»» expressionType

dataField

»»»»»»»»»»»»» expressionType

function

»»»»»»»»»»»»» expressionType

ifExpression

»»»»»»»»»»»»» expressionType

literal

»»»»»»»»»»»»» literalType

Integer

»»»»»»»»»»»»» literalType

Decimal

»»»»»»»»»»»»» literalType

Date

»»»»»»»»»»»»» literalType

DateTime

»»»»»»»»»»»»» literalType

String

»»»»»»»»»»»»» literalType

Float

»»»»»»»»»»»»» literalType

Long

»»»»»»»»»»»»» literalType

Null

»»»»»»»»»»»»» literalType

Parameter

»»»»»»»»»»»»» literalType

Guid

»»»»»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»»»»»» literalType

Boolean

»»»»»»»»»»» literalType

Integer

»»»»»»»»»»» literalType

Decimal

»»»»»»»»»»» literalType

Date

»»»»»»»»»»» literalType

DateTime

»»»»»»»»»»» literalType

String

»»»»»»»»»»» literalType

Float

»»»»»»»»»»» literalType

Long

»»»»»»»»»»» literalType

Null

»»»»»»»»»»» literalType

Parameter

»»»»»»»»»»» literalType

Guid

»»»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»»»» literalType

Boolean

»»»»»»»»»» literalType

Integer

»»»»»»»»»» literalType

Decimal

»»»»»»»»»» literalType

Date

»»»»»»»»»» literalType

DateTime

»»»»»»»»»» literalType

String

»»»»»»»»»» literalType

Float

»»»»»»»»»» literalType

Long

»»»»»»»»»» literalType

Null

»»»»»»»»»» literalType

Parameter

»»»»»»»»»» literalType

Guid

»»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»»» literalType

Boolean

»»»»»»»»» sourceType

Table

»»»»»»»»» sourceType

Query

»»»»»»»»» joinType

Inner

»»»»»»»»» joinType

Left

»»»»»»»»» joinType

Right

»»»»»»»»» joinType

Cross

»»»»»»»»» joinType

CrossApply

»»»»»»»»» joinType

OuterApply

»»»»»»»»»» constraintType

clause

»»»»»»»»»» constraintType

constraint

»»»»»»»»»» constraintType

expressionConstraint

»»»»»»»»»» constraintType

likeConstraint

»»»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»»»» constraintType

subQueryConstraint

»»»»»»»»» direction

Ascending

»»»»»»»»» direction

Descending

»»»»»»»»» direction

AscendingNullsFirst

»»»»»»»»» direction

DescendingNullsLast

»»»»»»» op

LessThan

»»»»»»» op

LessThanEquals

»»»»»»» op

Equals

»»»»»»» op

NotEquals

»»»»»»» op

GreaterThan

»»»»»»» op

GreaterThanEquals

»»»»»»» op

IsNull

»»»»»»» op

IsNotNull

»»»»»»» op

In

»»»»»»» op

NotIn

»»»» operatorType

LessThan

»»»» operatorType

LessThanEquals

»»»» operatorType

Equals

»»»» operatorType

NotEquals

»»»» operatorType

GreaterThan

»»»» operatorType

GreaterThanEquals

»»»» operatorType

IsNull

»»»» operatorType

IsNotNull

»»»» valueType

String

»»»» valueType

Numeric

»»»» valueType

Date

»»»» valueType

Field

»»»» type

Simple

»»»» type

Workflow

»»»» type

Custom

»»»» op

Equals

»»»» op

LessThan

»»»» op

LessThanEquals

»»»» op

GreaterThan

»»»» op

GreaterThanEquals

»»»» display

Select

»»»» display

Field

»»»»»» dataType

Report

»»»»»» dataType

Form

»»»»»» dataType

String

»»»»»» dataType

DateTime

»»»»»» dataType

Decimal

»»»»»» dataType

Integer

»»»»»» type

Scalar

»»»»»» type

RowValue

»»»»»» type

Constant

»»»» targetType

WebReport

»»»» targetType

WebForm

»»»» targetType

URL

»»» op

Sum

»»» op

Avg

»»» op

Count

»»» op

Max

»»» op

Min

»»»» style

Number

»»»» style

Percent

»»»» style

Dollars

»»»» style

FrenchCanadianDollars

»»»» style

Pounds

»»»» style

Euro

»»»» style

Yen

»»»» style

Yuan

»»»» style

Rand

»»»» style

BrazilianReal

»»»» style

Rupee

»»»» style

SingaporeanDollar

»»»» style

AustralianDollar

»»»» style

Won

Responses

Status

Meaning

Description

Schema

200

OK

Create a new Web Form

Varicent.RESTAPI.v1.DTOs.Composer.ComposerWebFormElementDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/webforms", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webforms");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "webForm": {
    "id": 0,
    "elementId": 0,
    "name": "string",
    "javaScript": "string",
    "protected": true,
    "filterFirst": true,
    "numRows": 0,
    "numColumns": 0,
    "exportFilter": 0,
    "elements": [
      {}
    ],
    "spans": [
      {}
    ],
    "workflowObjectId": 0,
    "element": {},
    "version": {
      "rowVersion": 0
    }
  },
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webforms',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/webforms', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/webforms',
  params: {
  }, headers: headers

p JSON.parse(result)

WebFormsControllerV1_Get

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

expand

query

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Get Web Form by id

Varicent.RESTAPI.v1.DTOs.WebFormDefinitionDTO

404

Not Found

Web Form does not exist

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/webforms/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webforms/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webforms/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/webforms/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/webforms/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "elementId": 0,
  "name": "string",
  "javaScript": "string",
  "protected": true,
  "filterFirst": true,
  "numRows": 0,
  "numColumns": 0,
  "exportFilter": 0,
  "elements": [
    {
      "row": 0,
      "column": 0,
      "type": "WebFormAdmin",
      "name": "string",
      "location": "string",
      "resourceType": "Image",
      "timeId": "string",
      "text": "string",
      "style": {},
      "definition": {},
      "tableDefinition": {},
      "rules": [],
      "columnOptions": [],
      "mainTable": {},
      "sourceDefinition": {},
      "filters": [],
      "editableColumns": [],
      "links": [],
      "webFormSource": null,
      "data": null,
      "source": {},
      "op": "Sum",
      "displayFormat": {},
      "value": null,
      "result": null,
      "link": {}
    }
  ],
  "spans": [
    {
      "row": 0,
      "columnStart": 0,
      "columnEnd": 0
    }
  ],
  "workflowObjectId": 0,
  "element": {},
  "version": {
    "rowVersion": 0
  }
}
{"id":0,"elementId":0,"name":"string","javaScript":"string","protected":true,"filterFirst":true,"numRows":0,"numColumns":0,"exportFilter":0,"elements":[{"row":0,"column":0,"type":"WebFormAdmin","name":"string","location":"string","resourceType":"Image","timeId":"string","text":"string","style":{},"definition":{},"tableDefinition":{},"rules":[],"columnOptions":[],"mainTable":{},"sourceDefinition":{},"filters":[],"editableColumns":[],"links":[],"webFormSource":null,"data":null,"source":{},"op":"Sum","displayFormat":{},"value":null,"result":null,"link":{}}],"spans":[{"row":0,"columnStart":0,"columnEnd":0}],"workflowObjectId":0,"element":{},"version":{"rowVersion":0}}

WebFormsControllerV1_Delete

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Delete Web Form by ID

integer

404

Not Found

Web Form does not exist

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/webforms/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webforms/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webforms/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('http://localhost:8080/api/v1/webforms/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.delete 'http://localhost:8080/api/v1/webforms/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
0
0

WebFormsControllerV1_Put

Body parameter

{
  "id": 0,
  "elementId": 0,
  "name": "string",
  "javaScript": "string",
  "protected": true,
  "filterFirst": true,
  "numRows": 0,
  "numColumns": 0,
  "exportFilter": 0,
  "elements": [
    {
      "row": 0,
      "column": 0,
      "type": "WebFormAdmin",
      "name": "string",
      "location": "string",
      "resourceType": "Image",
      "timeId": "string",
      "text": "string",
      "style": {},
      "definition": {},
      "tableDefinition": {},
      "rules": [],
      "columnOptions": [],
      "mainTable": {},
      "sourceDefinition": {},
      "filters": [],
      "editableColumns": [],
      "links": [],
      "webFormSource": null,
      "source": {},
      "op": "Sum",
      "displayFormat": {},
      "value": null,
      "link": {}
    }
  ],
  "spans": [
    {
      "row": 0,
      "columnStart": 0,
      "columnEnd": 0
    }
  ],
  "workflowObjectId": 0,
  "element": {},
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.WebFormDefinitionDTO

false

none

» id

body

integer(int32)

false

none

» elementId

body

integer(int32)

false

none

» name

body

string¦null

false

none

» javaScript

body

string¦null

false

none

» protected

body

boolean

false

none

» filterFirst

body

boolean

false

none

» numRows

body

integer(int32)

false

none

» numColumns

body

integer(int32)

false

none

» exportFilter

body

integer(int32)

false

none

» elements

body

[Varicent.RESTAPI.v1.DTOs.WebFormElementDTO]¦null

false

none

»» row

body

integer(int32)

false

none

»» column

body

integer(int32)

false

none

»» type

body

string

false

none

»» name

body

string¦null

false

none

»» location

body

string¦null

false

none

»» resourceType

body

string¦null

false

none

»» timeId

body

string¦null

false

none

»» text

body

string¦null

false

none

»» style

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»» alignment

body

string

false

none

»»» backColor

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»»» a

body

integer(int32)

false

none

»»»» b

body

integer(int32)

false

none

»»»» g

body

integer(int32)

false

none

»»»» r

body

integer(int32)

false

none

»»» font

body

Varicent.RESTAPI.v1.DTOs.FontDefinitionDTO

false

none

»»»» family

body

string¦null

false

none

»»»» size

body

number(float)

false

none

»»»» unit

body

string¦null

false

none

»»»» bold

body

boolean

false

none

»»»» italic

body

boolean

false

none

»»»» underline

body

boolean

false

none

»»»» strikeout

body

boolean

false

none

»»» foreColor

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»» definition

body

Varicent.RESTAPI.v1.DTOs.TableDefinitionDTO

false

none

»»» table

body

Varicent.RESTAPI.v1.DTOs.CustomTableDTO

false

none

»»»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»» rowVersion

body

integer(int64)

false

none

»»»» name

body

string¦null

false

none

»»»» tableType

body

string

false

none

»»»» effectiveDated

body

boolean

false

none

»»»» workflowObjectID

body

integer(int32)

false

none

»»»» hierarchyMetadata

body

RESTAPI.v1.DTOs.Hierarchy.HierarchyMetadataDTO

false

none

»»»»» tableName

body

string¦null

false

none

»»»»» idColumnName

body

string¦null

false

none

»»»»» parentColumnName

body

string¦null

false

none

»»»» lastUpdatedTracking

body

boolean¦null

false

none

»»» columns

body

[Varicent.RESTAPI.v1.DTOs.ColumnDefinitionDTO]¦null

false

none

»»»» column

body

Varicent.RESTAPI.v1.DTOs.CustomColumnDTO

false

none

»»»»» name

body

string¦null

false

none

»»»»» type

body

string

false

none

»»»»» referencedTable

body

string¦null

false

none

»»»»» referencedName

body

string¦null

false

none

»»»»» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»»»»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»»»»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»»»»»» alias

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» customSelect

body

string¦null

false

none

»»»»»»»» dataType

body

string

false

none

»»»»»»»» type

body

string

false

none

»»»»»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»»»»» constraintType

body

string

false

none

»»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»»» condition

body

any

false

none

»»»»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»»»»» literalType

body

string

false

none

»»»»»»»»»»»» value

body

any

false

none

»»»»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»»»»» constraints

body

array¦null

false

none

»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»» literalRight

body

any

false

none

»»»»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»»» right

body

any

false

none

»»»»»»»»»»» expressionLeft

body

any

false

none

»»»»»»»»»»» expressionRight

body

any

false

none

»»»»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»»»»» like

body

string¦null

false

none

»»»»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»»» literalType

body

string

false

none

»»»»»»»»»» value

body

any

false

none

»»»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»» literalType

body

string

false

none

»»»»»»»»» value

body

any

false

none

»»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»»»»»» m_namespace

body

string¦null

false

none

»»»»»»»»» name

body

string¦null

false

none

»»»»»»»» query

body

any

false

none

»»»»»»»» alias

body

string¦null

false

none

»»»»»»»» sourceType

body

string

false

none

»»»»»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»»»» joinType

body

string

false

none

»»»»»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»»»»» constraintType

body

string

false

none

»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»»» like

body

string¦null

false

none

»»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» direction

body

string

false

none

»»»»»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»»» distinct

body

boolean

false

none

»»»»»»» unionWith

body

any

false

none

»»»»»»» exceptWith

body

any

false

none

»»»»»» sourceNames

body

object¦null

false

none

»»»»»»» additionalProperties

body

string¦null

false

none

»»»»» pickListParams

body

[Varicent.RESTAPI.v1.DTOs.PickListParamDTO]¦null

false

none

»»»»»» joinAlias

body

string¦null

false

none

»»»»»» joinColumn

body

string¦null

false

none

»»»»»» op

body

string

false

none

»»»»» isKey

body

boolean

false

none

»»»» isRemovable

body

boolean

false

none

»»»» isNullable

body

boolean

false

none

»»»» referencedColumn

body

string¦null

false

none

»»» time

body

Varicent.RESTAPI.v1.DTOs.TableTimeDTO

false

none

»»»» timeId

body

string¦null

false

none

»»»» dateColumn

body

string¦null

false

none

»»»» lockedOn

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»»»» min

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»»»» max

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»» tableDefinition

body

Varicent.RESTAPI.v1.DTOs.TableDefinitionDTO

false

none

»» rules

body

[Varicent.RESTAPI.v1.DTOs.InputRuleDTO]¦null

false

none

»»» id

body

integer(int32)

false

none

»»» elementId

body

integer(int32)

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» operatorType

body

string

false

none

»»» valueType

body

string

false

none

»»» value

body

any

false

none

»» columnOptions

body

[Varicent.RESTAPI.v1.DTOs.ColumnOptionsDTO]¦null

false

none

»»» index

body

integer(int32)

false

none

»»» width

body

integer(int32)

false

none

»»» isRequired

body

boolean

false

none

»» mainTable

body

Varicent.RESTAPI.v1.DTOs.TableDefinitionDTO

false

none

»» sourceDefinition

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»» filters

body

[Varicent.RESTAPI.v1.DTOs.WebFormFilterDTO]¦null

false

none

»»» filterId

body

integer(int32)

false

none

»»» name

body

string¦null

false

none

»»» sourceTable

body

string¦null

false

none

»»» sourceColumn

body

string¦null

false

none

»»» type

body

string

false

none

»»» op

body

string

false

none

»»» display

body

string

false

none

»»» definition

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»» systemType

body

string¦null

false

none

»»» filterValueColumn

body

string¦null

false

none

»»» filterNameColumn

body

string¦null

false

none

»»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» editableColumns

body

[Varicent.RESTAPI.v1.DTOs.EditableColumnDTO]¦null

false

none

»»» column

body

Varicent.RESTAPI.v1.DTOs.DataItemDTO

false

none

»»»» path

body

RESTAPI.v1.DTOs.DataPathDTO

false

none

»»»»» path

body

[string]¦null

false

none

»»»» column

body

string¦null

false

none

»»»» alias

body

string¦null

false

none

»»» index

body

integer(int32)

false

none

»»» table

body

string¦null

false

none

»» links

body

[Varicent.RESTAPI.v1.DTOs.LinkDTO]¦null

false

none

»»» document

body

string¦null

false

none

»»» openInNewWindow

body

boolean

false

none

»»» parameters

body

object¦null

false

none

»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.LinkParameterValueDTO

false

none

»»»»» dataType

body

string

false

none

»»»»» source

body

string¦null

false

none

»»»»» type

body

string

false

none

»»»»» value

body

string¦null

false

none

»»» reportId

body

integer(int32)¦null

false

none

»»» targetId

body

integer(int32)

false

none

»»» targetType

body

string

false

none

»»» webFormId

body

integer(int32)¦null

false

none

»»» webTabId

body

integer(int32)¦null

false

none

»» webFormSource

body

any

false

none

»» data

body

any

false

none

»» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»» op

body

string¦null

false

none

»» displayFormat

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»» scale

body

integer(int32)

false

none

»»» style

body

string

false

none

»» value

body

any

false

none

»» result

body

any

false

none

»» link

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

» spans

body

[Varicent.RESTAPI.v1.DTOs.CellSpanDTO]¦null

false

none

»» row

body

integer(int32)

false

none

»» columnStart

body

integer(int32)

false

none

»» columnEnd

body

integer(int32)

false

none

» workflowObjectId

body

integer(int32)

false

none

» element

body

Varicent.RESTAPI.v1.DTOs.IExpandableResourceDTO

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

»» type

WebFormAdmin

»» type

WebFormResource

»» type

WebFormSink

»» type

WebFormSource

»» type

WebFormSourceData

»» type

WebFormValue

»» type

WebFormValueData

»» type

WebFormText

»» resourceType

Image

»» resourceType

Link

»»» alignment

Justify

»»» alignment

Left

»»» alignment

Center

»»» alignment

Right

»»»» tableType

System

»»»» tableType

Dimension

»»»» tableType

Structural

»»»» tableType

Lookup

»»»» tableType

Data

»»»» tableType

View

»»»» tableType

Custom

»»»» tableType

StarSchema

»»»» tableType

ExportTable

»»»» tableType

CreditingRule

»»»» tableType

AssignTable

»»»» tableType

PlcmCustomTable

»»»» tableType

PlcmStructuralTable

»»»» tableType

PlcmTable

»»»» tableType

DataSource

»»»» tableType

Cached

»»»» tableType

MaterializedView

»»»»» type

Text

»»»»» type

Date

»»»»» type

List

»»»»» type

Numeric

»»»»» type

Email

»»»»» type

Url

»»»»» type

Comment

»»»»» type

DateTime

»»»»»»»» dataType

Int

»»»»»»»» dataType

Decimal

»»»»»»»» dataType

DateTime

»»»»»»»» dataType

None

»»»»»»»» dataType

String

»»»»»»»» type

SelectAll

»»»»»»»» type

SelectItem

»»»»»»»» type

SelectLiteral

»»»»»»»» type

SelectCustom

»»»»»»»» type

SelectExpression

»»»»»»»»» expressionType

caseExpression

»»»»»»»»» expressionType

dataField

»»»»»»»»» expressionType

function

»»»»»»»»» expressionType

ifExpression

»»»»»»»»» expressionType

literal

»»»»»»»»»» expressionType

caseExpression

»»»»»»»»»» expressionType

dataField

»»»»»»»»»» expressionType

function

»»»»»»»»»» expressionType

ifExpression

»»»»»»»»»» expressionType

literal

»»»»»»»»»»» constraintType

clause

»»»»»»»»»»» constraintType

constraint

»»»»»»»»»»» constraintType

expressionConstraint

»»»»»»»»»»» constraintType

likeConstraint

»»»»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»»»»» constraintType

subQueryConstraint

»»»»»»»»»»»» expressionType

caseExpression

»»»»»»»»»»»» expressionType

dataField

»»»»»»»»»»»» expressionType

function

»»»»»»»»»»»» expressionType

ifExpression

»»»»»»»»»»»» expressionType

literal

»»»»»»»»»»»» literalType

Integer

»»»»»»»»»»»» literalType

Decimal

»»»»»»»»»»»» literalType

Date

»»»»»»»»»»»» literalType

DateTime

»»»»»»»»»»»» literalType

String

»»»»»»»»»»»» literalType

Float

»»»»»»»»»»»» literalType

Long

»»»»»»»»»»»» literalType

Null

»»»»»»»»»»»» literalType

Parameter

»»»»»»»»»»»» literalType

Guid

»»»»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»»»»» literalType

Boolean

»»»»»»»»»» literalType

Integer

»»»»»»»»»» literalType

Decimal

»»»»»»»»»» literalType

Date

»»»»»»»»»» literalType

DateTime

»»»»»»»»»» literalType

String

»»»»»»»»»» literalType

Float

»»»»»»»»»» literalType

Long

»»»»»»»»»» literalType

Null

»»»»»»»»»» literalType

Parameter

»»»»»»»»»» literalType

Guid

»»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»»» literalType

Boolean

»»»»»»»»» literalType

Integer

»»»»»»»»» literalType

Decimal

»»»»»»»»» literalType

Date

»»»»»»»»» literalType

DateTime

»»»»»»»»» literalType

String

»»»»»»»»» literalType

Float

»»»»»»»»» literalType

Long

»»»»»»»»» literalType

Null

»»»»»»»»» literalType

Parameter

»»»»»»»»» literalType

Guid

»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»» literalType

Boolean

»»»»»»»» sourceType

Table

»»»»»»»» sourceType

Query

»»»»»»»» joinType

Inner

»»»»»»»» joinType

Left

»»»»»»»» joinType

Right

»»»»»»»» joinType

Cross

»»»»»»»» joinType

CrossApply

»»»»»»»» joinType

OuterApply

»»»»»»»»» constraintType

clause

»»»»»»»»» constraintType

constraint

»»»»»»»»» constraintType

expressionConstraint

»»»»»»»»» constraintType

likeConstraint

»»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»»» constraintType

subQueryConstraint

»»»»»»»» direction

Ascending

»»»»»»»» direction

Descending

»»»»»»»» direction

AscendingNullsFirst

»»»»»»»» direction

DescendingNullsLast

»»»»»» op

LessThan

»»»»»» op

LessThanEquals

»»»»»» op

Equals

»»»»»» op

NotEquals

»»»»»» op

GreaterThan

»»»»»» op

GreaterThanEquals

»»»»»» op

IsNull

»»»»»» op

IsNotNull

»»»»»» op

In

»»»»»» op

NotIn

»»» operatorType

LessThan

»»» operatorType

LessThanEquals

»»» operatorType

Equals

»»» operatorType

NotEquals

»»» operatorType

GreaterThan

»»» operatorType

GreaterThanEquals

»»» operatorType

IsNull

»»» operatorType

IsNotNull

»»» valueType

String

»»» valueType

Numeric

»»» valueType

Date

»»» valueType

Field

»»» type

Simple

»»» type

Workflow

»»» type

Custom

»»» op

Equals

»»» op

LessThan

»»» op

LessThanEquals

»»» op

GreaterThan

»»» op

GreaterThanEquals

»»» display

Select

»»» display

Field

»»»»» dataType

Report

»»»»» dataType

Form

»»»»» dataType

String

»»»»» dataType

DateTime

»»»»» dataType

Decimal

»»»»» dataType

Integer

»»»»» type

Scalar

»»»»» type

RowValue

»»»»» type

Constant

»»» targetType

WebReport

»»» targetType

WebForm

»»» targetType

URL

»» op

Sum

»» op

Avg

»» op

Count

»» op

Max

»» op

Min

»»» style

Number

»»» style

Percent

»»» style

Dollars

»»» style

FrenchCanadianDollars

»»» style

Pounds

»»» style

Euro

»»» style

Yen

»»» style

Yuan

»»» style

Rand

»»» style

BrazilianReal

»»» style

Rupee

»»» style

SingaporeanDollar

»»» style

AustralianDollar

»»» style

Won

Responses

Status

Meaning

Description

Schema

200

OK

Update Web Form

Varicent.RESTAPI.v1.DTOs.WebFormDefinitionDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/webforms/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webforms/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "elementId": 0,
  "name": "string",
  "javaScript": "string",
  "protected": true,
  "filterFirst": true,
  "numRows": 0,
  "numColumns": 0,
  "exportFilter": 0,
  "elements": [
    {
      "row": 0,
      "column": 0,
      "type": "WebFormAdmin",
      "name": "string",
      "location": "string",
      "resourceType": "Image",
      "timeId": "string",
      "text": "string",
      "style": {},
      "definition": {},
      "tableDefinition": {},
      "rules": [],
      "columnOptions": [],
      "mainTable": {},
      "sourceDefinition": {},
      "filters": [],
      "editableColumns": [],
      "links": [],
      "webFormSource": null,
      "source": {},
      "op": "Sum",
      "displayFormat": {},
      "value": null,
      "link": {}
    }
  ],
  "spans": [
    {
      "row": 0,
      "columnStart": 0,
      "columnEnd": 0
    }
  ],
  "workflowObjectId": 0,
  "element": {},
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webforms/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/webforms/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/webforms/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

WebFormsControllerV1_GetDependencies

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

dependencies for the given web form

RESTAPI.v1.DTOs.DependencyInfoDTO

404

Not Found

Web Form does not exist

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/webforms/{id}/dependents", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webforms/{id}/dependents");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webforms/{id}/dependents',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/webforms/{id}/dependents', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/webforms/{id}/dependents',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "dependencies": {
    "Calendars": [
      {}
    ],
    "StarSchemas": [
      {}
    ],
    "Calculations": [
      {}
    ],
    "SavedImports": [
      {}
    ],
    "InputForms": [
      {}
    ],
    "TaskGroup": [
      {}
    ],
    "Plans": [
      {}
    ],
    "TailoredReports": [
      {}
    ],
    "Publications": [
      {}
    ],
    "PayeeGroups": [
      {}
    ],
    "Payees": [
      {}
    ],
    "Blocks": [
      {}
    ],
    "Ports": [
      {}
    ],
    "WebForms": [
      {}
    ],
    "WebFormFilters": [
      {}
    ],
    "WorkflowGroups": [
      {}
    ],
    "WebTab": [
      {}
    ],
    "Transformations": [
      {}
    ],
    "WebFormValidationRules": [
      {}
    ],
    "DataStores": [
      {}
    ],
    "BPMWorkflow": [
      {}
    ],
    "BPMSwimLane": [
      {}
    ],
    "BPMNode": [
      {}
    ],
    "BPMComponent": [
      {}
    ],
    "Views": [
      {}
    ],
    "Tables": [
      {}
    ],
    "PresenterReports": [
      {}
    ],
    "PickList": [
      {}
    ],
    "WebEditRestriction": [
      {}
    ],
    "PresenterReportDataSources": [
      {}
    ],
    "PresenterReportValueSources": [
      {}
    ],
    "PresenterReportRowFormSources": [
      {}
    ],
    "ScenarioWorkspace": [
      {}
    ],
    "Scheduler": [
      {}
    ],
    "RapidReport": [
      {}
    ],
    "DDE": [
      {}
    ],
    "Hierarchy": [
      {}
    ],
    "PresenterFlex": [
      {}
    ],
    "AdaptiveForms": [
      {}
    ],
    "ReportDataModelSource": [
      {}
    ],
    "PlanComponentSource": [
      {}
    ],
    "PlanBuilderCalculation": [
      {}
    ],
    "PlanBuilderItem": [
      {}
    ]
  }
}
{"dependencies":{"Calendars":[{}],"StarSchemas":[{}],"Calculations":[{}],"SavedImports":[{}],"InputForms":[{}],"TaskGroup":[{}],"Plans":[{}],"TailoredReports":[{}],"Publications":[{}],"PayeeGroups":[{}],"Payees":[{}],"Blocks":[{}],"Ports":[{}],"WebForms":[{}],"WebFormFilters":[{}],"WorkflowGroups":[{}],"WebTab":[{}],"Transformations":[{}],"WebFormValidationRules":[{}],"DataStores":[{}],"BPMWorkflow":[{}],"BPMSwimLane":[{}],"BPMNode":[{}],"BPMComponent":[{}],"Views":[{}],"Tables":[{}],"PresenterReports":[{}],"PickList":[{}],"WebEditRestriction":[{}],"PresenterReportDataSources":[{}],"PresenterReportValueSources":[{}],"PresenterReportRowFormSources":[{}],"ScenarioWorkspace":[{}],"Scheduler":[{}],"RapidReport":[{}],"DDE":[{}],"Hierarchy":[{}],"PresenterFlex":[{}],"AdaptiveForms":[{}],"ReportDataModelSource":[{}],"PlanComponentSource":[{}],"PlanBuilderCalculation":[{}],"PlanBuilderItem":[{}]}}

Get web form filters.

Parameters

Name

In

Type

Required

Description

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

filter

query

string

false

####Supported operations

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

filtertype (single or list by equal matching)

Responses

Status

Meaning

Description

Schema

200

OK

Get web form filters for rowviewer

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.ResultSetDTO]

false

none

none

» columnDefinitions

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

none

»» name

string¦null

false

none

none

»» type

string

false

none

none

»» isKey

boolean

false

none

none

»» nullable

boolean

false

none

none

»» values

string¦null

false

none

none

»» lockedPeriod

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

none

»»» start

string(date-time)

false

none

none

»»» end

string(date-time)

false

none

none

»» referencedCol

string¦null

false

none

none

»» picklistFilter

string¦null

false

none

none

»» displayName

string¦null

false

none

none

»» isELTPeriod

boolean¦null

false

none

none

» data

[any]¦null

false

none

none

» columnSourceMap

object¦null

false

none

none

»» additionalProperties

string¦null

false

none

none

» isDataSynced

boolean¦null

false

none

none

» hierarchyMetadata

RESTAPI.v1.DTOs.Hierarchy.HierarchyMetadataDTO

false

none

none

»» tableName

string¦null

false

none

none

»» idColumnName

string¦null

false

none

none

»» parentColumnName

string¦null

false

none

none

Enumerated Values

Property

Value

type

String

type

LongString

type

MaxString

type

Date

type

DateTime

type

Decimal

type

Int

type

Long

type

Float

type

BLOB

type

Identity

type

CLOB

type

RowVersion

type

UID

type

VarCharMax

type

Boolean

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/webformsfilters/rowviewer", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webformsfilters/rowviewer");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webformsfilters/rowviewer',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/webformsfilters/rowviewer', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/webformsfilters/rowviewer',
  params: {
  }, headers: headers

p JSON.parse(result)

WebFormsControllerV1_PostFilter

Body parameter

{
  "filterId": 0,
  "name": "string",
  "sourceTable": "string",
  "sourceColumn": "string",
  "type": "Simple",
  "op": "Equals",
  "display": "Select",
  "definition": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "systemType": "string",
  "filterValueColumn": "string",
  "filterNameColumn": "string",
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.WebFormFilterDTO

false

none

» filterId

body

integer(int32)

false

none

» name

body

string¦null

false

none

» sourceTable

body

string¦null

false

none

» sourceColumn

body

string¦null

false

none

» type

body

string

false

none

» op

body

string

false

none

» display

body

string

false

none

» definition

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»» alias

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» table

body

string¦null

false

none

»»»» customSelect

body

string¦null

false

none

»»»» dataType

body

string

false

none

»»»» type

body

string

false

none

»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»» expressionType

body

string

false

none

»»»»»» cases

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» arguments

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»» constraintType

body

string

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» condition

body

any

false

none

»»»»»»»» trueValue

body

any

false

none

»»»»»»»» falseValue

body

any

false

none

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»» constraints

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» literalRight

body

any

false

none

»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» right

body

any

false

none

»»»»»»» expressionLeft

body

any

false

none

»»»»»»» expressionRight

body

any

false

none

»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»» like

body

string¦null

false

none

»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»» trueValue

body

any

false

none

»»»»»» falseValue

body

any

false

none

»»»»»» isDate

body

boolean

false

none

»»»»»» literalType

body

string

false

none

»»»»»» value

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»» m_namespace

body

string¦null

false

none

»»»»» name

body

string¦null

false

none

»»»» query

body

any

false

none

»»»» alias

body

string¦null

false

none

»»»» sourceType

body

string

false

none

»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» joinType

body

string

false

none

»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» constraintType

body

string

false

none

»»»»» op

body

string¦null

false

none

»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» caseSensitive

body

boolean

false

none

»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isPreciseDecimal

body

boolean

false

none

»»»»» like

body

string¦null

false

none

»»»»» escapeWildcards

body

boolean

false

none

»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»» table

body

string¦null

false

none

»»»»» queryDefinitionRight

body

any

false

none

»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» direction

body

string

false

none

»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» distinct

body

boolean

false

none

»»» unionWith

body

any

false

none

»»» exceptWith

body

any

false

none

»» sourceNames

body

object¦null

false

none

»»» additionalProperties

body

string¦null

false

none

» systemType

body

string¦null

false

none

» filterValueColumn

body

string¦null

false

none

» filterNameColumn

body

string¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

» type

Simple

» type

Workflow

» type

Custom

» op

Equals

» op

LessThan

» op

LessThanEquals

» op

GreaterThan

» op

GreaterThanEquals

» display

Select

» display

Field

»»»» dataType

Int

»»»» dataType

Decimal

»»»» dataType

DateTime

»»»» dataType

None

»»»» dataType

String

»»»» type

SelectAll

»»»» type

SelectItem

»»»» type

SelectLiteral

»»»» type

SelectCustom

»»»» type

SelectExpression

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» expressionType

caseExpression

»»»»»» expressionType

dataField

»»»»»» expressionType

function

»»»»»» expressionType

ifExpression

»»»»»» expressionType

literal

»»»»»»» constraintType

clause

»»»»»»» constraintType

constraint

»»»»»»» constraintType

expressionConstraint

»»»»»»» constraintType

likeConstraint

»»»»»»» constraintType

rowVersionConstraint

»»»»»»» constraintType

subQueryConstraint

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»» literalType

Integer

»»»»»» literalType

Decimal

»»»»»» literalType

Date

»»»»»» literalType

DateTime

»»»»»» literalType

String

»»»»»» literalType

Float

»»»»»» literalType

Long

»»»»»» literalType

Null

»»»»»» literalType

Parameter

»»»»»» literalType

Guid

»»»»»» literalType

SystemUtcTime

»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» sourceType

Table

»»»» sourceType

Query

»»»» joinType

Inner

»»»» joinType

Left

»»»» joinType

Right

»»»» joinType

Cross

»»»» joinType

CrossApply

»»»» joinType

OuterApply

»»»»» constraintType

clause

»»»»» constraintType

constraint

»»»»» constraintType

expressionConstraint

»»»»» constraintType

likeConstraint

»»»»» constraintType

rowVersionConstraint

»»»»» constraintType

subQueryConstraint

»»»» direction

Ascending

»»»» direction

Descending

»»»» direction

AscendingNullsFirst

»»»» direction

DescendingNullsLast

Responses

Status

Meaning

Description

Schema

200

OK

Create a new web form filter

Varicent.RESTAPI.v1.DTOs.WebFormFilterDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/webformsfilters", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webformsfilters");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "filterId": 0,
  "name": "string",
  "sourceTable": "string",
  "sourceColumn": "string",
  "type": "Simple",
  "op": "Equals",
  "display": "Select",
  "definition": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "systemType": "string",
  "filterValueColumn": "string",
  "filterNameColumn": "string",
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webformsfilters',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/webformsfilters', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/webformsfilters',
  params: {
  }, headers: headers

p JSON.parse(result)

Get web form filters.

ID of the webform that uses the filters

id-of-the-webform-that-uses-the-filters-parameters">Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

id-of-the-webform-that-uses-the-filters-responses">Responses

Status

Meaning

Description

Schema

200

OK

Get filters for a specific webform

Inline

id-of-the-webform-that-uses-the-filters-responseschema">Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.WebFormFilterDTO]

false

none

none

» filterId

integer(int32)

false

none

none

» name

string¦null

false

none

none

» sourceTable

string¦null

false

none

none

» sourceColumn

string¦null

false

none

none

» type

string

false

none

none

» op

string

false

none

none

» display

string

false

none

none

» definition

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

»» query

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

»»» selectItems

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

none

»»»» alias

string¦null

false

none

none

»»»» column

string¦null

false

none

none

»»»» table

string¦null

false

none

none

»»»» customSelect

string¦null

false

none

none

»»»» dataType

string

false

none

none

»»»» type

string

false

none

none

»»»» value

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»» expressionType

string

false

none

none

»»»»» cases

array¦null

false

none

none

»»»»»» anonymous

any

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» column

string¦null

false

none

none

»»»»» op

string¦null

false

none

none

»»»»» arguments

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

none

[DTO version of IExpression]

»»»»»» expressionType

string

false

none

none

»»»»»» cases

array¦null

false

none

none

»»»»»»» anonymous

any

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» column

string¦null

false

none

none

»»»»»» op

string¦null

false

none

none

»»»»»» arguments

array¦null

false

none

none

»»»»»»» anonymous

any

false

none

none

»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»»» constraintType

string

false

none

none

»»»»»»» op

string¦null

false

none

none

»»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»» expressionType

string

false

none

none

»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» table

string¦null

false

none

none

»»»»»»»» column

string¦null

false

none

none

»»»»»»»» op

string¦null

false

none

none

»»»»»»»» arguments

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» condition

any

false

none

none

»»»»»»»» trueValue

any

false

none

none

»»»»»»»» falseValue

any

false

none

none

»»»»»»»» isDate

boolean

false

none

none

»»»»»»»» literalType

string

false

none

none

»»»»»»»» value

any

false

none

none

»»»»»»» caseSensitive

boolean

false

none

none

»»»»»»» constraints

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»»» literalRight

any

false

none

none

»»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»» right

any

false

none

none

»»»»»»» expressionLeft

any

false

none

none

»»»»»»» expressionRight

any

false

none

none

»»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»»» like

string¦null

false

none

none

»»»»»»» escapeWildcards

boolean

false

none

none

»»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»»» rowVersion

integer(int64)

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» queryDefinitionRight

any

false

none

none

»»»»»» trueValue

any

false

none

none

»»»»»» falseValue

any

false

none

none

»»»»»» isDate

boolean

false

none

none

»»»»»» literalType

string

false

none

none

»»»»»» value

any

false

none

none

»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»» trueValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» falseValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» isDate

boolean

false

none

none

»»»»» literalType

string

false

none

none

»»»»» value

any

false

none

none

»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»» namespaceTable

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

none

»»»»» m_namespace

string¦null

false

none

none

»»»»» name

string¦null

false

none

none

»»»» query

any

false

none

none

»»»» alias

string¦null

false

none

none

»»»» sourceType

string

false

none

none

»»» joins

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

none

»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»» joinType

string

false

none

none

»»»» onClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»» constraintType

string

false

none

none

»»»»» op

string¦null

false

none

none

»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»» caseSensitive

boolean

false

none

none

»»»»» constraints

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

none

[DTO version of IConstraint]

»»»»» literalRight

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»» right

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» expressionLeft

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» expressionRight

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» isPreciseDecimal

boolean

false

none

none

»»»»» like

string¦null

false

none

none

»»»»» escapeWildcards

boolean

false

none

none

»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» queryDefinitionRight

any

false

none

none

»»» whereClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»» order

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

none

»»»» table

string¦null

false

none

none

»»»» column

string¦null

false

none

none

»»»» direction

string

false

none

none

»»» group

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

none

»»»» table

string¦null

false

none

none

»»»» column

string¦null

false

none

none

»»» havingClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»» distinct

boolean

false

none

none

»»» unionWith

any

false

none

none

»»» exceptWith

any

false

none

none

»» sourceNames

object¦null

false

none

none

»»» additionalProperties

string¦null

false

none

none

» systemType

string¦null

false

none

none

» filterValueColumn

string¦null

false

none

none

» filterNameColumn

string¦null

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

type

Simple

type

Workflow

type

Custom

op

Equals

op

LessThan

op

LessThanEquals

op

GreaterThan

op

GreaterThanEquals

display

Select

display

Field

dataType

Int

dataType

Decimal

dataType

DateTime

dataType

None

dataType

String

type

SelectAll

type

SelectItem

type

SelectLiteral

type

SelectCustom

type

SelectExpression

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

sourceType

Table

sourceType

Query

joinType

Inner

joinType

Left

joinType

Right

joinType

Cross

joinType

CrossApply

joinType

OuterApply

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

direction

Ascending

direction

Descending

direction

AscendingNullsFirst

direction

DescendingNullsLast

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/webforms/{id}/filters", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webforms/{id}/filters");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webforms/{id}/filters',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/webforms/{id}/filters', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/webforms/{id}/filters',
  params: {
  }, headers: headers

p JSON.parse(result)

Deletes a web form filter.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

ID of the filter to delete

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/webformsfilters/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webformsfilters/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/webformsfilters/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/webformsfilters/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/webformsfilters/{id}',
  params: {
  }

p JSON.parse(result)

WebFormsControllerV1_PutFilter

Body parameter

{
  "filterId": 0,
  "name": "string",
  "sourceTable": "string",
  "sourceColumn": "string",
  "type": "Simple",
  "op": "Equals",
  "display": "Select",
  "definition": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "systemType": "string",
  "filterValueColumn": "string",
  "filterNameColumn": "string",
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.WebFormFilterDTO

false

none

» filterId

body

integer(int32)

false

none

» name

body

string¦null

false

none

» sourceTable

body

string¦null

false

none

» sourceColumn

body

string¦null

false

none

» type

body

string

false

none

» op

body

string

false

none

» display

body

string

false

none

» definition

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»» alias

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» table

body

string¦null

false

none

»»»» customSelect

body

string¦null

false

none

»»»» dataType

body

string

false

none

»»»» type

body

string

false

none

»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»» expressionType

body

string

false

none

»»»»»» cases

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» arguments

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»» constraintType

body

string

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» condition

body

any

false

none

»»»»»»»» trueValue

body

any

false

none

»»»»»»»» falseValue

body

any

false

none

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»» constraints

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» literalRight

body

any

false

none

»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» right

body

any

false

none

»»»»»»» expressionLeft

body

any

false

none

»»»»»»» expressionRight

body

any

false

none

»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»» like

body

string¦null

false

none

»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»» trueValue

body

any

false

none

»»»»»» falseValue

body

any

false

none

»»»»»» isDate

body

boolean

false

none

»»»»»» literalType

body

string

false

none

»»»»»» value

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»» m_namespace

body

string¦null

false

none

»»»»» name

body

string¦null

false

none

»»»» query

body

any

false

none

»»»» alias

body

string¦null

false

none

»»»» sourceType

body

string

false

none

»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» joinType

body

string

false

none

»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» constraintType

body

string

false

none

»»»»» op

body

string¦null

false

none

»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» caseSensitive

body

boolean

false

none

»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isPreciseDecimal

body

boolean

false

none

»»»»» like

body

string¦null

false

none

»»»»» escapeWildcards

body

boolean

false

none

»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»» table

body

string¦null

false

none

»»»»» queryDefinitionRight

body

any

false

none

»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» direction

body

string

false

none

»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» distinct

body

boolean

false

none

»»» unionWith

body

any

false

none

»»» exceptWith

body

any

false

none

»» sourceNames

body

object¦null

false

none

»»» additionalProperties

body

string¦null

false

none

» systemType

body

string¦null

false

none

» filterValueColumn

body

string¦null

false

none

» filterNameColumn

body

string¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

» type

Simple

» type

Workflow

» type

Custom

» op

Equals

» op

LessThan

» op

LessThanEquals

» op

GreaterThan

» op

GreaterThanEquals

» display

Select

» display

Field

»»»» dataType

Int

»»»» dataType

Decimal

»»»» dataType

DateTime

»»»» dataType

None

»»»» dataType

String

»»»» type

SelectAll

»»»» type

SelectItem

»»»» type

SelectLiteral

»»»» type

SelectCustom

»»»» type

SelectExpression

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» expressionType

caseExpression

»»»»»» expressionType

dataField

»»»»»» expressionType

function

»»»»»» expressionType

ifExpression

»»»»»» expressionType

literal

»»»»»»» constraintType

clause

»»»»»»» constraintType

constraint

»»»»»»» constraintType

expressionConstraint

»»»»»»» constraintType

likeConstraint

»»»»»»» constraintType

rowVersionConstraint

»»»»»»» constraintType

subQueryConstraint

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»» literalType

Integer

»»»»»» literalType

Decimal

»»»»»» literalType

Date

»»»»»» literalType

DateTime

»»»»»» literalType

String

»»»»»» literalType

Float

»»»»»» literalType

Long

»»»»»» literalType

Null

»»»»»» literalType

Parameter

»»»»»» literalType

Guid

»»»»»» literalType

SystemUtcTime

»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» sourceType

Table

»»»» sourceType

Query

»»»» joinType

Inner

»»»» joinType

Left

»»»» joinType

Right

»»»» joinType

Cross

»»»» joinType

CrossApply

»»»» joinType

OuterApply

»»»»» constraintType

clause

»»»»» constraintType

constraint

»»»»» constraintType

expressionConstraint

»»»»» constraintType

likeConstraint

»»»»» constraintType

rowVersionConstraint

»»»»» constraintType

subQueryConstraint

»»»» direction

Ascending

»»»» direction

Descending

»»»» direction

AscendingNullsFirst

»»»» direction

DescendingNullsLast

Responses

Status

Meaning

Description

Schema

200

OK

Update Web Form Filter

Varicent.RESTAPI.v1.DTOs.WebFormFilterDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/webformsfilters/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webformsfilters/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "filterId": 0,
  "name": "string",
  "sourceTable": "string",
  "sourceColumn": "string",
  "type": "Simple",
  "op": "Equals",
  "display": "Select",
  "definition": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "systemType": "string",
  "filterValueColumn": "string",
  "filterNameColumn": "string",
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webformsfilters/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/webformsfilters/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/webformsfilters/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

Get web form filter sources.

Responses

Status

Meaning

Description

Schema

200

OK

Get web form filter sources

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

Varicent.RESTAPI.v1.DTOs.FullTableSchemaDTO

false

none

none

»» columns

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

none

»»» name

string¦null

false

none

none

»»» type

string

false

none

none

»»» isKey

boolean

false

none

none

»»» nullable

boolean

false

none

none

»»» values

string¦null

false

none

none

»»» lockedPeriod

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

none

»»»» start

string(date-time)

false

none

none

»»»» end

string(date-time)

false

none

none

»»» referencedCol

string¦null

false

none

none

»»» picklistFilter

string¦null

false

none

none

»»» displayName

string¦null

false

none

none

»»» isELTPeriod

boolean¦null

false

none

none

»» table

string¦null

false

none

none

»» name

string¦null

false

none

none

»» referencedSources

[string]¦null

false

none

none

»» referencedTimes

[Varicent.RESTAPI.v1.DTOs.FrequencyDTO]¦null

false

none

none

»»» levelId

string¦null

false

none

none

»»» timeId

string¦null

false

none

none

»» referencedSourcesDictionary

object¦null

false

none

none

»»» additionalProperties

string

false

none

none

»» referencedTimesDictionary

object¦null

false

none

none

»»» additionalProperties

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

none

Enumerated Values

Property

Value

type

String

type

LongString

type

MaxString

type

Date

type

DateTime

type

Decimal

type

Int

type

Long

type

Float

type

BLOB

type

Identity

type

CLOB

type

RowVersion

type

UID

type

VarCharMax

type

Boolean

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/webformsfilters/sources", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webformsfilters/sources");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webformsfilters/sources',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/webformsfilters/sources', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/webformsfilters/sources',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "property1": {
    "columns": [
      {}
    ],
    "table": "string",
    "name": "string",
    "referencedSources": [
      "string"
    ],
    "referencedTimes": [
      {}
    ],
    "referencedSourcesDictionary": {
      "property1": "string",
      "property2": "string"
    },
    "referencedTimesDictionary": {
      "property1": {},
      "property2": {}
    }
  },
  "property2": {
    "columns": [
      {}
    ],
    "table": "string",
    "name": "string",
    "referencedSources": [
      "string"
    ],
    "referencedTimes": [
      {}
    ],
    "referencedSourcesDictionary": {
      "property1": "string",
      "property2": "string"
    },
    "referencedTimesDictionary": {
      "property1": {},
      "property2": {}
    }
  }
}
{"property1":{"columns":[{}],"table":"string","name":"string","referencedSources":["string"],"referencedTimes":[{}],"referencedSourcesDictionary":{"property1":"string","property2":"string"},"referencedTimesDictionary":{"property1":{},"property2":{}}},"property2":{"columns":[{}],"table":"string","name":"string","referencedSources":["string"],"referencedTimes":[{}],"referencedSourcesDictionary":{"property1":"string","property2":"string"},"referencedTimesDictionary":{"property1":{},"property2":{}}}}

Get web form filter values.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

ID of the filter

portalAccessGroupId

query

integer(int32)

false

ID of the portal access group

Responses

Status

Meaning

Description

Schema

200

OK

Get web form filter values

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/webformsfilters/{id}/values", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webformsfilters/{id}/values");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webformsfilters/{id}/values',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/webformsfilters/{id}/values', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/webformsfilters/{id}/values',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "property1": "string",
  "property2": "string"
}
{"property1":"string","property2":"string"}

Get web form configuration.

Responses

Status

Meaning

Description

Schema

200

OK

Get web form filter sources

RESTAPI.v1.DTOs.ConfigValueDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/webformsconfig", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webformsconfig");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webformsconfig',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/webformsconfig', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/webformsconfig',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "key": "string",
  "value": null,
  "version": {
    "rowVersion": 0
  }
}
{"key":"string","value":null,"version":{"rowVersion":0}}

Preview a web form filter.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

ID of the web form to preview

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/webforms/{id}/preview", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webforms/{id}/preview");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/webforms/{id}/preview',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.get('http://localhost:8080/api/v1/webforms/{id}/preview')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.get 'http://localhost:8080/api/v1/webforms/{id}/preview',
  params: {
  }

p JSON.parse(result)

WebFormsControllerV1_DeleteJWTCookie

Parameters

Name

In

Type

Required

Description

cookiePath

query

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/payee/webform/deleteJWTCookie", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payee/webform/deleteJWTCookie");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/payee/webform/deleteJWTCookie',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/payee/webform/deleteJWTCookie')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/payee/webform/deleteJWTCookie',
  params: {
  }

p JSON.parse(result)

WebFormsControllerV1_GetName

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get Web Form Name by id

string

404

Not Found

Web Form Name does not exist

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/payee/webformname/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payee/webformname/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/payee/webformname/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/payee/webformname/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/payee/webformname/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
"string"
"string"

Web Report

Gets all data grid templates.

Parameters

Name

In

Type

Required

Description

filter

query

string

false

####Supported operations

orderBy

query

string

false

####Description

Detailed descriptions

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

name

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

id, name

Responses

Status

Meaning

Description

Schema

200

OK

Published files returned.

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.DataGridTemplateDTO]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» headerStyle

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

none

»» alignment

string

false

none

none

»» backColor

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

none

»»» a

integer(int32)

false

none

none

»»» b

integer(int32)

false

none

none

»»» g

integer(int32)

false

none

none

»»» r

integer(int32)

false

none

none

»» font

Varicent.RESTAPI.v1.DTOs.FontDefinitionDTO

false

none

none

»»» family

string¦null

false

none

none

»»» size

number(float)

false

none

none

»»» unit

string¦null

false

none

none

»»» bold

boolean

false

none

none

»»» italic

boolean

false

none

none

»»» underline

boolean

false

none

none

»»» strikeout

boolean

false

none

none

»» foreColor

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

none

» evenRowStyle

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

none

» oddRowStyle

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

none

» computedRowStyle

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

none

» sectionStyle

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

none

» allowAlternateRowStyle

boolean

false

none

none

» isHeaderVerticalAlignmentBottom

boolean

false

none

none

» showGridLines

boolean

false

none

none

» suppressHeader

boolean

false

none

none

» showSectionHeader

boolean

false

none

none

» isDefaultTemplate

boolean

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

Enumerated Values

Property

Value

alignment

Justify

alignment

Left

alignment

Center

alignment

Right

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/datagridtemplates", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/datagridtemplates");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/datagridtemplates',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/datagridtemplates', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/datagridtemplates',
  params: {
  }, headers: headers

p JSON.parse(result)

Creates a new data grid template.

Body parameter

{
  "id": 0,
  "name": "string",
  "headerStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "evenRowStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "oddRowStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "computedRowStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "sectionStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "allowAlternateRowStyle": true,
  "isHeaderVerticalAlignmentBottom": true,
  "showGridLines": true,
  "suppressHeader": true,
  "showSectionHeader": true,
  "isDefaultTemplate": true,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.DataGridTemplateDTO

false

none

» id

body

integer(int32)

false

none

» name

body

string¦null

false

none

» headerStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»» alignment

body

string

false

none

»» backColor

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»» a

body

integer(int32)

false

none

»»» b

body

integer(int32)

false

none

»»» g

body

integer(int32)

false

none

»»» r

body

integer(int32)

false

none

»» font

body

Varicent.RESTAPI.v1.DTOs.FontDefinitionDTO

false

none

»»» family

body

string¦null

false

none

»»» size

body

number(float)

false

none

»»» unit

body

string¦null

false

none

»»» bold

body

boolean

false

none

»»» italic

body

boolean

false

none

»»» underline

body

boolean

false

none

»»» strikeout

body

boolean

false

none

»» foreColor

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

» evenRowStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

» oddRowStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

» computedRowStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

» sectionStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

» allowAlternateRowStyle

body

boolean

false

none

» isHeaderVerticalAlignmentBottom

body

boolean

false

none

» showGridLines

body

boolean

false

none

» suppressHeader

body

boolean

false

none

» showSectionHeader

body

boolean

false

none

» isDefaultTemplate

body

boolean

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Enumerated Values

Parameter

Value

»» alignment

Justify

»» alignment

Left

»» alignment

Center

»» alignment

Right

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.DataGridTemplateDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/datagridtemplates", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/datagridtemplates");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "name": "string",
  "headerStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "evenRowStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "oddRowStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "computedRowStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "sectionStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "allowAlternateRowStyle": true,
  "isHeaderVerticalAlignmentBottom": true,
  "showGridLines": true,
  "suppressHeader": true,
  "showSectionHeader": true,
  "isDefaultTemplate": true,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/datagridtemplates',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/datagridtemplates', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/datagridtemplates',
  params: {
  }, headers: headers

p JSON.parse(result)

Updates the IsDefault status for the given data grid template ID.

There can be, at most, one default. So when set to true for the given template ID, the default status of all other templates are set to false.

Body parameter

{
  "item1": 0,
  "item2": true
}

Parameters

Name

In

Type

Required

Description

body

body

[System.Tuple2[System.Int32,System.Boolean]](#schemasystem.tuple2[system.int32,system.boolean])

false

none

» item1

body

integer(int32)

false

none

» item2

body

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Data grid template successfully updated

Varicent.RESTAPI.v1.DTOs.DataGridTemplateDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/datagridtemplates", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/datagridtemplates");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "item1": 0,
  "item2": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/datagridtemplates',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/datagridtemplates', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/datagridtemplates',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "headerStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "evenRowStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "oddRowStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "computedRowStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "sectionStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "allowAlternateRowStyle": true,
  "isHeaderVerticalAlignmentBottom": true,
  "showGridLines": true,
  "suppressHeader": true,
  "showSectionHeader": true,
  "isDefaultTemplate": true,
  "version": {
    "rowVersion": 0
  }
}
{"id":0,"name":"string","headerStyle":{"alignment":"Justify","backColor":{"a":0,"b":0,"g":0,"r":0},"font":{"family":"string","size":0.1,"unit":"string","bold":true,"italic":true,"underline":true,"strikeout":true},"foreColor":{"a":0,"b":0,"g":0,"r":0}},"evenRowStyle":{"alignment":"Justify","backColor":{"a":0,"b":0,"g":0,"r":0},"font":{"family":"string","size":0.1,"unit":"string","bold":true,"italic":true,"underline":true,"strikeout":true},"foreColor":{"a":0,"b":0,"g":0,"r":0}},"oddRowStyle":{"alignment":"Justify","backColor":{"a":0,"b":0,"g":0,"r":0},"font":{"family":"string","size":0.1,"unit":"string","bold":true,"italic":true,"underline":true,"strikeout":true},"foreColor":{"a":0,"b":0,"g":0,"r":0}},"computedRowStyle":{"alignment":"Justify","backColor":{"a":0,"b":0,"g":0,"r":0},"font":{"family":"string","size":0.1,"unit":"string","bold":true,"italic":true,"underline":true,"strikeout":true},"foreColor":{"a":0,"b":0,"g":0,"r":0}},"sectionStyle":{"alignment":"Justify","backColor":{"a":0,"b":0,"g":0,"r":0},"font":{"family":"string","size":0.1,"unit":"string","bold":true,"italic":true,"underline":true,"strikeout":true},"foreColor":{"a":0,"b":0,"g":0,"r":0}},"allowAlternateRowStyle":true,"isHeaderVerticalAlignmentBottom":true,"showGridLines":true,"suppressHeader":true,"showSectionHeader":true,"isDefaultTemplate":true,"version":{"rowVersion":0}}

Gets a data grid template with a given ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.DataGridTemplateDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/datagridtemplates/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/datagridtemplates/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/datagridtemplates/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/datagridtemplates/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/datagridtemplates/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "headerStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "evenRowStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "oddRowStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "computedRowStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "sectionStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "allowAlternateRowStyle": true,
  "isHeaderVerticalAlignmentBottom": true,
  "showGridLines": true,
  "suppressHeader": true,
  "showSectionHeader": true,
  "isDefaultTemplate": true,
  "version": {
    "rowVersion": 0
  }
}
{"id":0,"name":"string","headerStyle":{"alignment":"Justify","backColor":{"a":0,"b":0,"g":0,"r":0},"font":{"family":"string","size":0.1,"unit":"string","bold":true,"italic":true,"underline":true,"strikeout":true},"foreColor":{"a":0,"b":0,"g":0,"r":0}},"evenRowStyle":{"alignment":"Justify","backColor":{"a":0,"b":0,"g":0,"r":0},"font":{"family":"string","size":0.1,"unit":"string","bold":true,"italic":true,"underline":true,"strikeout":true},"foreColor":{"a":0,"b":0,"g":0,"r":0}},"oddRowStyle":{"alignment":"Justify","backColor":{"a":0,"b":0,"g":0,"r":0},"font":{"family":"string","size":0.1,"unit":"string","bold":true,"italic":true,"underline":true,"strikeout":true},"foreColor":{"a":0,"b":0,"g":0,"r":0}},"computedRowStyle":{"alignment":"Justify","backColor":{"a":0,"b":0,"g":0,"r":0},"font":{"family":"string","size":0.1,"unit":"string","bold":true,"italic":true,"underline":true,"strikeout":true},"foreColor":{"a":0,"b":0,"g":0,"r":0}},"sectionStyle":{"alignment":"Justify","backColor":{"a":0,"b":0,"g":0,"r":0},"font":{"family":"string","size":0.1,"unit":"string","bold":true,"italic":true,"underline":true,"strikeout":true},"foreColor":{"a":0,"b":0,"g":0,"r":0}},"allowAlternateRowStyle":true,"isHeaderVerticalAlignmentBottom":true,"showGridLines":true,"suppressHeader":true,"showSectionHeader":true,"isDefaultTemplate":true,"version":{"rowVersion":0}}

Updates an existing data grid template.

Body parameter

{
  "id": 0,
  "name": "string",
  "headerStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "evenRowStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "oddRowStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "computedRowStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "sectionStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "allowAlternateRowStyle": true,
  "isHeaderVerticalAlignmentBottom": true,
  "showGridLines": true,
  "suppressHeader": true,
  "showSectionHeader": true,
  "isDefaultTemplate": true,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.DataGridTemplateDTO

false

none

» id

body

integer(int32)

false

none

» name

body

string¦null

false

none

» headerStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»» alignment

body

string

false

none

»» backColor

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»» a

body

integer(int32)

false

none

»»» b

body

integer(int32)

false

none

»»» g

body

integer(int32)

false

none

»»» r

body

integer(int32)

false

none

»» font

body

Varicent.RESTAPI.v1.DTOs.FontDefinitionDTO

false

none

»»» family

body

string¦null

false

none

»»» size

body

number(float)

false

none

»»» unit

body

string¦null

false

none

»»» bold

body

boolean

false

none

»»» italic

body

boolean

false

none

»»» underline

body

boolean

false

none

»»» strikeout

body

boolean

false

none

»» foreColor

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

» evenRowStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

» oddRowStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

» computedRowStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

» sectionStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

» allowAlternateRowStyle

body

boolean

false

none

» isHeaderVerticalAlignmentBottom

body

boolean

false

none

» showGridLines

body

boolean

false

none

» suppressHeader

body

boolean

false

none

» showSectionHeader

body

boolean

false

none

» isDefaultTemplate

body

boolean

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Enumerated Values

Parameter

Value

»» alignment

Justify

»» alignment

Left

»» alignment

Center

»» alignment

Right

Responses

Status

Meaning

Description

Schema

200

OK

Data grid template successfully created

Varicent.RESTAPI.v1.DTOs.DataGridTemplateDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/datagridtemplates/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/datagridtemplates/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "name": "string",
  "headerStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "evenRowStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "oddRowStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "computedRowStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "sectionStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "allowAlternateRowStyle": true,
  "isHeaderVerticalAlignmentBottom": true,
  "showGridLines": true,
  "suppressHeader": true,
  "showSectionHeader": true,
  "isDefaultTemplate": true,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/datagridtemplates/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/datagridtemplates/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/datagridtemplates/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

Deletes a data grid template with a given ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Data grid template successfully deleted

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/datagridtemplates/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/datagridtemplates/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/datagridtemplates/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/datagridtemplates/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/datagridtemplates/{id}',
  params: {
  }

p JSON.parse(result)

Gets all data grid names which have had the template applied

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

The id of the data grid template.

filter

query

string

false

The id of the data grid template.

Detailed descriptions

filter: The id of the data grid template. ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka in; userType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b], (a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

Responses

Status

Meaning

Description

Schema

200

OK

Get datagrids which the template has been applied to, filter supported

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.DataGridItemDTO]

false

none

none

» reportID

integer(int32)

false

none

none

» reportName

string¦null

false

none

none

» dataGridName

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/datagridtemplates/{id}/datagrids", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/datagridtemplates/{id}/datagrids");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/datagridtemplates/{id}/datagrids',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/datagridtemplates/{id}/datagrids', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/datagridtemplates/{id}/datagrids',
  params: {
  }, headers: headers

p JSON.parse(result)

Reapplies the template to the data grids which are passed in

Body parameter

[
  {
    "reportID": 0,
    "reportName": "string",
    "dataGridName": "string"
  }
]

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.DataGridItemDTO

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.DataGridItemDTO]

false

none

none

» reportID

integer(int32)

false

none

none

» reportName

string¦null

false

none

none

» dataGridName

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/datagridtemplates/{id}/reapply", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/datagridtemplates/{id}/reapply");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "reportID": 0,
    "reportName": "string",
    "dataGridName": "string"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/datagridtemplates/{id}/reapply',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/datagridtemplates/{id}/reapply', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/datagridtemplates/{id}/reapply',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "reportID": 0,
    "reportName": "string",
    "dataGridName": "string"
  }
]
[{"reportID":0,"reportName":"string","dataGridName":"string"}]

Get web report names.

Parameters

Name

In

Type

Required

Description

filter

query

string

false

####Supported operations

Detailed descriptions

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

name

Responses

Status

Meaning

Description

Schema

200

OK

Get all Web Reports (filter supported)

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.WebReportNameDTO]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» isFavorite

boolean

false

none

none

» workflowObjectId

integer(int32)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/webreports", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webreports");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webreports',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/webreports', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/webreports',
  params: {
  }, headers: headers

p JSON.parse(result)

WebReportsControllerV1_Post

Body parameter

{
  "webReportName": "string",
  "webReportDefinition": {
    "allowPdfExport": true,
    "showInquiry": true,
    "batchExportDetails": {
      "canBatchExport": true,
      "picklistRefParam": "string"
    },
    "background": {
      "color": {},
      "image": {},
      "imageAttachment": "Scroll",
      "imagePosition": "Absolute",
      "imageTile": "None",
      "webreportId": 0,
      "x": 0,
      "y": 0,
      "opacity": 0
    },
    "defaultStyle": {
      "color": {},
      "font": {}
    },
    "directlyAccessible": true,
    "frameLayout": {
      "horizontalAlign": "Left",
      "verticalAlign": "Top",
      "type": "Frame",
      "childHeightPercents": [],
      "childWidthPercents": [],
      "frames": [],
      "name": "string",
      "numColumns": 0,
      "numRows": 0,
      "display": {}
    },
    "isLayoutLocked": true,
    "name": "string",
    "pdfOptions": {
      "autoScale": true,
      "customScaleValue": 0.1,
      "footerText": "string",
      "includePageNumber": true,
      "portraitOrientation": true,
      "showTotalPageNumber": true,
      "tableViewportWidth": 0.1
    },
    "sources": [
      {}
    ],
    "trees": [
      {}
    ],
    "version": {
      "rowVersion": 0
    },
    "webReportId": 0,
    "workflowObjectId": 0,
    "element": {},
    "styleCategory": "string"
  },
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.WebReportElementDTO

false

none

» webReportName

body

string¦null

false

none

» webReportDefinition

body

Varicent.RESTAPI.v1.DTOs.WebReportDTO

false

none

»» allowPdfExport

body

boolean

false

none

»» showInquiry

body

boolean

false

none

»» batchExportDetails

body

Varicent.RESTAPI.v1.DTOs.WebReportBatchExportDetailsDTO

false

none

»»» canBatchExport

body

boolean

false

none

»»» picklistRefParam

body

string¦null

false

none

»» background

body

Varicent.RESTAPI.v1.DTOs.BackgroundDisplayDTO

false

none

»»» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»»» a

body

integer(int32)

false

none

»»»» b

body

integer(int32)

false

none

»»»» g

body

integer(int32)

false

none

»»»» r

body

integer(int32)

false

none

»»» image

body

Varicent.RESTAPI.v1.DTOs.ImageDisplayDTO

false

none

»»»» displayBorder

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»»» bottom

body

Varicent.RESTAPI.v1.DTOs.BorderDTO

false

none

»»»»»» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»»»»» width

body

number(float)

false

none

»»»»» left

body

Varicent.RESTAPI.v1.DTOs.BorderDTO

false

none

»»»»» right

body

Varicent.RESTAPI.v1.DTOs.BorderDTO

false

none

»»»»» top

body

Varicent.RESTAPI.v1.DTOs.BorderDTO

false

none

»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»»»» bottom

body

number(float)

false

none

»»»»» left

body

number(float)

false

none

»»»»» right

body

number(float)

false

none

»»»»» top

body

number(float)

false

none

»»»» gridType

body

string¦null

false

none

»»»» hoverText

body

string¦null

false

none

»»»» imageByteArray

body

string(byte)¦null

false

none

»»»» imageId

body

integer(int32)

false

none

»»»» imageLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»»» document

body

string¦null

false

none

»»»»» openInNewWindow

body

boolean

false

none

»»»»» parameters

body

object¦null

false

none

»»»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.LinkParameterValueDTO

false

none

»»»»»»» dataType

body

string

false

none

»»»»»»» source

body

string¦null

false

none

»»»»»»» type

body

string

false

none

»»»»»»» value

body

string¦null

false

none

»»»»» reportId

body

integer(int32)¦null

false

none

»»»»» targetId

body

integer(int32)

false

none

»»»»» targetType

body

string

false

none

»»»»» webFormId

body

integer(int32)¦null

false

none

»»»»» webTabId

body

integer(int32)¦null

false

none

»»»» imageType

body

string¦null

false

none

»»»» imageUrl

body

string¦null

false

none

»»»» expiryDate

body

string(date-time)¦null

false

none

»»»» cosObjectName

body

string¦null

false

none

»»»» name

body

string¦null

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DisplaySourceDTO

false

none

»»»»» name

body

string¦null

false

none

»»»» style

body

Varicent.RESTAPI.v1.DTOs.DataDisplayStyleDTO

false

none

»»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»» imageAttachment

body

string

false

none

»»» imagePosition

body

string

false

none

»»» imageTile

body

string

false

none

»»» webreportId

body

integer(int32)

false

none

»»» x

body

integer(int32)

false

none

»»» y

body

integer(int32)

false

none

»»» opacity

body

integer(int32)

false

none

»» defaultStyle

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»» font

body

Varicent.RESTAPI.v1.DTOs.FontDefinitionDTO

false

none

»»»» family

body

string¦null

false

none

»»»» size

body

number(float)

false

none

»»»» unit

body

string¦null

false

none

»»»» bold

body

boolean

false

none

»»»» italic

body

boolean

false

none

»»»» underline

body

boolean

false

none

»»»» strikeout

body

boolean

false

none

»» directlyAccessible

body

boolean

false

none

»» frameLayout

body

Varicent.RESTAPI.v1.DTOs.FrameableDTO

false

none

»»» horizontalAlign

body

string

false

none

»»» verticalAlign

body

string

false

none

»»» type

body

string

false

none

»»» childHeightPercents

body

[number]¦null

false

none

»»» childWidthPercents

body

[number]¦null

false

none

»»» frames

body

[array]¦null

false

none

»»»» anonymous

body

any

false

none

»»» name

body

string¦null

false

none

»»» numColumns

body

integer(int32)

false

none

»»» numRows

body

integer(int32)

false

none

»»» display

body

Varicent.RESTAPI.v1.DTOs.DataDisplayDTO

false

none

»»»» gridType

body

string¦null

false

none

»»»» name

body

string¦null

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DisplaySourceDTO

false

none

»»»» type

body

string

false

none

»»»» restrictSource

body

Varicent.RESTAPI.v1.DTOs.DisplaySourceDTO

false

none

»»»» restrictColumn

body

string¦null

false

none

»»»» style

body

Varicent.RESTAPI.v1.DTOs.DataDisplayStyleDTO

false

none

»»»» columnMap

body

object¦null

false

none

»»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.DataGridSourceColumnDTO

false

none

»»»»»» displayName

body

Varicent.RESTAPI.v1.DTOs.DataGridColumnDisplayNameDTO

false

none

»»»»»»» displayName

body

string¦null

false

none

»»»»»» dateFormat

body

Varicent.RESTAPI.v1.DTOs.PRDateFormatDTO

false

none

»»»»»»» style

body

string

false

none

»»»»»» pickListFilter

body

Varicent.RESTAPI.v1.DTOs.DataGridPicklistFilterDTO

false

none

»»»»»»» name

body

string¦null

false

none

»»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»»»»»»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»»»»»»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»»»»»»»» alias

body

string¦null

false

none

»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»» customSelect

body

string¦null

false

none

»»»»»»»»»» dataType

body

string

false

none

»»»»»»»»»» type

body

string

false

none

»»»»»»»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»»»»»»» constraintType

body

string

false

none

»»»»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»»»»» condition

body

any

false

none

»»»»»»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»»»»»»» literalType

body

string

false

none

»»»»»»»»»»»»»» value

body

any

false

none

»»»»»»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»»»»»»» constraints

body

array¦null

false

none

»»»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»»»» literalRight

body

any

false

none

»»»»»»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»»»»» right

body

any

false

none

»»»»»»»»»»»»» expressionLeft

body

any

false

none

»»»»»»»»»»»»» expressionRight

body

any

false

none

»»»»»»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»»»»»»» like

body

string¦null

false

none

»»»»»»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»»»»» literalType

body

string

false

none

»»»»»»»»»»»» value

body

any

false

none

»»»»»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»»»» literalType

body

string

false

none

»»»»»»»»»»» value

body

any

false

none

»»»»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»»»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»»»»»»»» m_namespace

body

string¦null

false

none

»»»»»»»»»»» name

body

string¦null

false

none

»»»»»»»»»» query

body

any

false

none

»»»»»»»»»» alias

body

string¦null

false

none

»»»»»»»»»» sourceType

body

string

false

none

»»»»»»»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»»»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»»»»»» joinType

body

string

false

none

»»»»»»»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»»»»»»» constraintType

body

string

false

none

»»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»»»»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»»»»» like

body

string¦null

false

none

»»»»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»»»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»»»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»» direction

body

string

false

none

»»»»»»»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»»»»» distinct

body

boolean

false

none

»»»»»»»»» unionWith

body

any

false

none

»»»»»»»»» exceptWith

body

any

false

none

»»»»»»»» sourceNames

body

object¦null

false

none

»»»»»»»»» additionalProperties

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»» defaultValue

body

string¦null

false

none

»»»»»» referencedFrequency

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»»»»»» levelId

body

string¦null

false

none

»»»»»»» timeId

body

string¦null

false

none

»»»»»» isEditable

body

boolean

false

none

»»»»»» picklistDisplayOptions

body

Varicent.RESTAPI.v1.DTOs.InputRowPicklistOptionsDTO

false

none

»»»»»»» description

body

string¦null

false

none

»»»»»»» order

body

string

false

none

»»»»»»» hideKey

body

boolean

false

none

»»»»»»» hideDescription

body

boolean

false

none

»»»»»»» sortById

body

boolean

false

none

»»»»»» order

body

integer(int32)

false

none

»»»»»» headerStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»»»» alignment

body

string

false

none

»»»»»»» backColor

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»»»»»» font

body

Varicent.RESTAPI.v1.DTOs.FontDefinitionDTO

false

none

»»»»»»» foreColor

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»»»»» formatRule

body

Varicent.RESTAPI.v1.DTOs.ConditionalFormatRuleDTO

false

none

»»»»»»» formats

body

[Varicent.RESTAPI.v1.DTOs.ConditionalFormatDTO]¦null

false

none

»»»»»»»» formula

body

string¦null

false

none

»»»»»»»» numericFormat

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»»»»»»»» scale

body

integer(int32)

false

none

»»»»»»»»» style

body

string

false

none

»»»»»»»» style

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»»» columnLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»»»» numericFormat

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»»»»» width

body

number(double)

false

none

»»»»»» initiallyShow

body

boolean

false

none

»»»»»» useRowTextAlignment

body

boolean

false

none

»»»»»» wrapText

body

boolean

false

none

»»»»»» maxWidth

body

integer(int32)

false

none

»»»»»» verticalAlignment

body

string

false

none

»»»» computedColumns

body

[Varicent.RESTAPI.v1.DTOs.DataGridComputedColumnDTO]¦null

false

none

»»»»» name

body

string¦null

false

none

»»»»» formula

body

string¦null

false

none

»»»»» order

body

integer(int32)

false

none

»»»»» headerStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» formatRule

body

Varicent.RESTAPI.v1.DTOs.ConditionalFormatRuleDTO

false

none

»»»»» columnLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»»» numericFormat

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»»»» width

body

number(double)

false

none

»»»»» initiallyShow

body

boolean

false

none

»»»»» useRowTextAlignment

body

boolean

false

none

»»»»» wrapText

body

boolean

false

none

»»»»» maxWidth

body

integer(int32)

false

none

»»»»» verticalAlignment

body

string

false

none

»»»» computedRow

body

object¦null

false

none

»»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.DataGridComputedRowCellDTO

false

none

»»»»»» columnDisplayName

body

string¦null

false

none

»»»»»» cellValue

body

string¦null

false

none

»»»»»» valueType

body

string

false

none

»»»»»» numericFormat

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»»» dataGridDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.DataGridDisplayStyleDTO

false

none

»»»»» headerStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» evenRowStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» oddRowStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» allowAlternateRowFont

body

boolean

false

none

»»»»» isHeaderVerticalAlignmentBottom

body

boolean

false

none

»»»»» computedRowStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» borderWidth

body

integer(int32)

false

none

»»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»»» dataGridInputRules

body

[Varicent.RESTAPI.v1.DTOs.DataGridInputRuleDTO]¦null

false

none

»»»»» id

body

integer(int32)

false

none

»»»»» dataGrid

body

string¦null

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» operatorType

body

string

false

none

»»»»» valueType

body

string

false

none

»»»»» value

body

any

false

none

»»»» dateFormat

body

Varicent.RESTAPI.v1.DTOs.PRDateFormatDTO

false

none

»»»» defaultPageSize

body

integer(int32)¦null

false

none

»»»» enableExportToExcel

body

boolean¦null

false

none

»»»» enableInquiryCopy

body

boolean¦null

false

none

»»»» enableShowHideColumns

body

boolean¦null

false

none

»»»» freezeTopRow

body

boolean¦null

false

none

»»»» hiddenColumnAliasMap

body

object¦null

false

none

»»»»» additionalProperties

body

string¦null

false

none

»»»» hiddenColumns

body

[Varicent.RESTAPI.v1.DTOs.DataGridHiddenColumnDTO]¦null

false

none

»»»»» order

body

integer(int32)

false

none

»»»»» name

body

string¦null

false

none

»»»»» type

body

string¦null

false

none

»»»» hiddenInputRowColumnMap

body

object¦null

false

none

»»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.DataGridSourceColumnDTO

false

none

»»»» inputRowAtTop

body

boolean¦null

false

none

»»»» isVertical

body

boolean¦null

false

none

»»»» numericStyle

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»»» paginated

body

boolean¦null

false

none

»»»» sections

body

[Varicent.RESTAPI.v1.DTOs.SectionDisplayDTO]¦null

false

none

»»»»» name

body

string¦null

false

none

»»»»» frequency

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»»»» sources

body

[Varicent.RESTAPI.v1.DTOs.SourceInfoDTO]¦null

false

none

»»»»»» columnMapping

body

object¦null

false

none

»»»»»»» additionalProperties

body

string¦null

false

none

»»»»»» valueColumn

body

string¦null

false

none

»»»»»» sourceName

body

string¦null

false

none

»»»»»» sectionStyle

body

Varicent.RESTAPI.v1.DTOs.ScalarDisplayStyleDTO

false

none

»»»»»»» style

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»»»»» format

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»»»»» dateFormat

body

Varicent.RESTAPI.v1.DTOs.PRDateFormatDTO

false

none

»»»»» sectionDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.ScalarDisplayStyleDTO

false

none

»»»» showOnlyInputRow

body

boolean¦null

false

none

»»»» showSectionHeader

body

boolean¦null

false

none

»»»» sortColumns

body

[Varicent.RESTAPI.v1.DTOs.DataGridSortColumnDTO]¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» sortDescending

body

boolean

false

none

»»»»» columnFrequency

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»»» suppressHeader

body

boolean¦null

false

none

»»»» hideRowBorders

body

boolean¦null

false

none

»»»» disableRowHighlighting

body

boolean¦null

false

none

»»»» suppressRepeatPartitionValues

body

boolean¦null

false

none

»»»» timeId

body

string¦null

false

none

»»»» validationRules

body

[Varicent.RESTAPI.v1.DTOs.WebReportValidationRuleDTO]¦null

false

none

»»»»» formula

body

string¦null

false

none

»»»»» errorMessage

body

string¦null

false

none

»»»» selectedTemplateId

body

integer(int32)¦null

false

none

»»»» columnWidths

body

[number]¦null

false

none

»»»» displays

body

[array]¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» fixedGridDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.FixedGridDisplayStyleDTO

false

none

»»»»» rowStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» borderWidth

body

integer(int32)

false

none

»»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»»» imageType

body

string¦null

false

none

»»»» imageLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»» imageId

body

integer(int32)¦null

false

none

»»»» imageByteArray

body

string(byte)¦null

false

none

»»»» hoverText

body

string¦null

false

none

»»»» imageUrl

body

string¦null

false

none

»»»» expiryDate

body

string(date-time)¦null

false

none

»»»» cosObjectName

body

string¦null

false

none

»»»» controlDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.ControlDisplayStyleDTO

false

none

»»»»» style

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»»» sortById

body

boolean¦null

false

none

»»»» sortAscending

body

boolean¦null

false

none

»»»» refParameter

body

string¦null

false

none

»»»» nameColumn

body

string¦null

false

none

»»»» idColumn

body

string¦null

false

none

»»»» hideValueForExport

body

boolean¦null

false

none

»»»» hideIdValues

body

boolean¦null

false

none

»»»» scalarDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.ScalarDisplayStyleDTO

false

none

»»»» scalarLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»» text

body

string¦null

false

none

»»»» documentId

body

integer(int32)¦null

false

none

»»»» buttonDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.ButtonDisplayStyleDTO

false

none

»»»»» style

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»»» cellStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»» agreementText

body

string¦null

false

none

»»»» format

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»»» conditionalFormatRule

body

Varicent.RESTAPI.v1.DTOs.ConditionalFormatRuleDTO

false

none

»»»» dateDisplayMode

body

string¦null

false

none

»»»» xAxisName

body

string¦null

false

none

»»»» yAxisName

body

string¦null

false

none

»»»» numberPrefix

body

string¦null

false

none

»»»» numberSuffix

body

string¦null

false

none

»»»» labelOrientation

body

string¦null

false

none

»»»» hideValues

body

boolean¦null

false

none

»»»» decimalSeparator

body

string¦null

false

none

»»»» thousandSeparator

body

string¦null

false

none

»»»» isPercentage

body

string¦null

false

none

»»»» numDecimals

body

string¦null

false

none

»»»» numberScaling

body

string¦null

false

none

»»»» showTitle

body

boolean¦null

false

none

»»»» yMinMax

body

boolean¦null

false

none

»»»» zMinMax

body

boolean¦null

false

none

»»»» yMin

body

string¦null

false

none

»»»» yMax

body

string¦null

false

none

»»»» zMin

body

string¦null

false

none

»»»» zMax

body

string¦null

false

none

»»»» dontTrimBarLabel

body

string¦null

false

none

»»»» defaultLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»» entityLinkMap

body

object¦null

false

none

»»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»» fusionSource

body

Varicent.RESTAPI.v1.DTOs.FusionSourceDTO

false

none

»»»»» type

body

string

false

none

»»»»» sorted

body

boolean

false

none

»»»»» descending

body

boolean

false

none

»»»»» sortedByName

body

boolean

false

none

»»»»» sourceName

body

string¦null

false

none

»»»»» chartLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»»» displayColumn

body

string¦null

false

none

»»»»» valueColumn

body

string¦null

false

none

»»»»» sourceAlias

body

string¦null

false

none

»»»»» sortingInfo

body

Varicent.RESTAPI.v1.DTOs.SortingInfoDTO

false

none

»»»»»» levelId

body

string¦null

false

none

»»»»»» sortDescending

body

boolean

false

none

»»»»»» timeId

body

string¦null

false

none

»»»»»» sortedByName

body

boolean

false

none

»»»»» xColumn

body

string¦null

false

none

»»»»» yColumn

body

string¦null

false

none

»»»»» zColumn

body

string¦null

false

none

»»»»» renderAs

body

string¦null

false

none

»»»»» isPrimaryAxis

body

boolean¦null

false

none

»»»»» entityColumn

body

string¦null

false

none

»»»»» sources

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» minValueSourceName

body

string¦null

false

none

»»»»» maxValueSourceName

body

string¦null

false

none

»»»»» currentValueSourceName

body

string¦null

false

none

»»»»» trendpointValueSourceName

body

string¦null

false

none

»»»» fusionStyles

body

Varicent.RESTAPI.v1.DTOs.FusionStyleSetDTO

false

none

»»»»» type

body

string

false

none

»»»»» title

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»»» xAxisName

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»»» yAxisName

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»»» xAxisValues

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»»» yAxisValues

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»»» legend

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»»» syAxisName

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»»» syAxisValues

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»»» labels

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»»» tickValues

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»»» pointerOrFill

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»» fusionTheme

body

string¦null

false

none

»»»» height

body

integer(int32)¦null

false

none

»»»» legendPosition

body

string¦null

false

none

»»»» mapDisplayType

body

string¦null

false

none

»»»» mapValueRanges

body

[Varicent.RESTAPI.v1.DTOs.ColorValueRangeDTO]¦null

false

none

»»»»» label

body

string¦null

false

none

»»»»» min

body

number(double)

false

none

»»»»» max

body

number(double)

false

none

»»»»» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»»» showLegend

body

boolean¦null

false

none

»»»» width

body

integer(int32)¦null

false

none

»»»» ssChartDisplayType

body

string¦null

false

none

»»»» chartLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»» customColors

body

[Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO]¦null

false

none

»»»» msChartDisplayType

body

string¦null

false

none

»»»» syAxisName

body

string¦null

false

none

»»»» syNumberPrefix

body

string¦null

false

none

»»»» syNumberSuffix

body

string¦null

false

none

»»»» hideSyValues

body

boolean¦null

false

none

»»»» centerValues

body

boolean¦null

false

none

»»»» syDecimalSeparator

body

string¦null

false

none

»»»» syThousandSeparator

body

string¦null

false

none

»»»» isSyPercentage

body

string¦null

false

none

»»»» syNumDecimals

body

string¦null

false

none

»»»» syNumberScaling

body

string¦null

false

none

»»»» lowerLimitDisplayName

body

string¦null

false

none

»»»» upperLimitDisplayName

body

string¦null

false

none

»»»» valueToolTip

body

string¦null

false

none

»»»» gaugeDisplayType

body

string¦null

false

none

»»»» link

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»» limitLabelFillColor

body

string¦null

false

none

»»»» gaugeValueRanges

body

[Varicent.RESTAPI.v1.DTOs.ColorValueRangeDTO]¦null

false

none

»»»» trendpoint

body

Varicent.RESTAPI.v1.DTOs.TrendpointDTO

false

none

»»»»» label

body

string¦null

false

none

»»»»» labelStyle

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»»» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»»» gaugeStartAngle

body

number(double)¦null

false

none

»»»» gaugeEndAngle

body

number(double)¦null

false

none

»»»» fillColor

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»»» status

body

string¦null

false

none

»»»» enableHeaders

body

boolean¦null

false

none

»»»» workflowLinkDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.WorkflowLinkDisplayStyleDTO

false

none

»»»»» headerStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» primaryStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» secondaryStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»»» columns

body

[string]¦null

false

none

»» isLayoutLocked

body

boolean

false

none

»» name

body

string¦null

false

none

»» pdfOptions

body

Varicent.RESTAPI.v1.DTOs.WebReportPdfOptionsDTO

false

none

»»» autoScale

body

boolean

false

none

»»» customScaleValue

body

number(double)

false

none

»»» footerText

body

string¦null

false

none

»»» includePageNumber

body

boolean

false

none

»»» portraitOrientation

body

boolean

false

none

»»» showTotalPageNumber

body

boolean

false

none

»»» tableViewportWidth

body

number(double)¦null

false

none

»» sources

body

[Varicent.RESTAPI.v1.DTOs.ReportSourceDTO]¦null

false

none

»»» dependencies

body

[string]¦null

false

none

»»» name

body

string¦null

false

none

»»» type

body

string

false

none

»»» scalarType

body

string¦null

false

none

»»» value

body

any

false

none

»»» column

body

string¦null

false

none

»»» keyValues

body

object¦null

false

none

»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.ReportVariableDTO

false

none

»»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» variableName

body

string¦null

false

none

»»»»» variableType

body

string

false

none

»»» table

body

string¦null

false

none

»»» expression

body

string¦null

false

none

»»» variables

body

[string]¦null

false

none

»»» required

body

boolean

false

none

»»» useWebUser

body

boolean

false

none

»»» isParameterValueScalar

body

boolean

false

none

»»» parameterValue

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»» parameterId

body

integer(int32)

false

none

»»» columnNames

body

[string]¦null

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»» formula

body

string¦null

false

none

»»» partitionColumns

body

[string]¦null

false

none

»»» timeEnd

body

string(date-time)

false

none

»»» timeFrequency

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»» timePartition

body

string¦null

false

none

»»» timeStart

body

string(date-time)

false

none

»»» newColumnName

body

string¦null

false

none

»»» keyColumns

body

[string]¦null

false

none

»»» newColumns

body

[string]¦null

false

none

»»» transposeColumn

body

string¦null

false

none

»» trees

body

[Varicent.RESTAPI.v1.DTOs.ReportTreeNodeDTO]¦null

false

none

»»» name

body

string¦null

false

none

»»» parent

body

string¦null

false

none

»»» parentNodeType

body

string¦null

false

none

»»» treeNodeType

body

string

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» webReportId

body

integer(int32)

false

none

»» workflowObjectId

body

integer(int32)

false

none

»» element

body

Varicent.RESTAPI.v1.DTOs.IExpandableResourceDTO

false

none

»» styleCategory

body

string¦null

false

none

» elementId

body

integer(int32)

false

none

» parentBlockId

body

integer(int32)¦null

false

none

» bounds

body

System.Drawing.RectangleF

false

none

»» location

body

System.Drawing.PointF

false

none

»»» isEmpty

body

boolean

false

none

»»» x

body

number(float)

false

none

»»» y

body

number(float)

false

none

»» size

body

string

false

none

»» x

body

number(float)

false

none

»» y

body

number(float)

false

none

»» width

body

number(float)

false

none

»» height

body

number(float)

false

none

»» left

body

number(float)

false

none

»» top

body

number(float)

false

none

»» right

body

number(float)

false

none

»» bottom

body

number(float)

false

none

»» isEmpty

body

boolean

false

none

» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

» name

body

string¦null

false

none

» parentBlock

body

Varicent.RESTAPI.v1.DTOs.Composer.ExpandableBlockElementDTO

false

none

»» id

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» href

body

string¦null

false

none

» isVisible

body

boolean

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

»»»»»»» dataType

Report

»»»»»»» dataType

Form

»»»»»»» dataType

String

»»»»»»» dataType

DateTime

»»»»»»» dataType

Decimal

»»»»»»» dataType

Integer

»»»»»»» type

Scalar

»»»»»»» type

RowValue

»»»»»»» type

Constant

»»»»» targetType

WebReport

»»»»» targetType

WebForm

»»»»» targetType

URL

»»» imageAttachment

Scroll

»»» imageAttachment

Fixed

»»» imagePosition

Absolute

»»» imagePosition

Percent

»»» imagePosition

LeftTop

»»» imagePosition

LeftCenter

»»» imagePosition

LeftBottom

»»» imagePosition

RightTop

»»» imagePosition

RightCenter

»»» imagePosition

RightBottom

»»» imagePosition

CenterTop

»»» imagePosition

CenterCenter

»»» imagePosition

CenterBottom

»»» imageTile

None

»»» imageTile

Vertical

»»» imageTile

Horizontal

»»» imageTile

Both

»»» horizontalAlign

Left

»»» horizontalAlign

Middle

»»» horizontalAlign

Right

»»» verticalAlign

Top

»»» verticalAlign

Middle

»»» verticalAlign

Bottom

»»» type

Frame

»»» type

Content

»»»» type

DataGridDisplay

»»»» type

FixedGridDisplay

»»»» type

ImageDisplay

»»»» type

MapDisplay

»»»» type

MultiSeriesChartDisplay

»»»» type

PickListControl

»»»» type

QuickTextDisplay

»»»» type

DocumentLinkDisplay

»»»» type

SingleSeriesChartDisplay

»»»» type

SubmitButtonDisplay

»»»» type

TextControl

»»»» type

SignatureControl

»»»» type

TextScalarDisplay

»»»» type

NumericScalarDisplay

»»»» type

DateScalarDisplay

»»»» type

CylinderGaugeDisplay

»»»» type

HLinearGaugeDisplay

»»»» type

AngularGaugeDisplay

»»»» type

WorkflowLinkControl

»»»»»»» style

Date

»»»»»»» style

DateTime

»»»»»»»»»» dataType

Int

»»»»»»»»»» dataType

Decimal

»»»»»»»»»» dataType

DateTime

»»»»»»»»»» dataType

None

»»»»»»»»»» dataType

String

»»»»»»»»»» type

SelectAll

»»»»»»»»»» type

SelectItem

»»»»»»»»»» type

SelectLiteral

»»»»»»»»»» type

SelectCustom

»»»»»»»»»» type

SelectExpression

»»»»»»»»»»» expressionType

caseExpression

»»»»»»»»»»» expressionType

dataField

»»»»»»»»»»» expressionType

function

»»»»»»»»»»» expressionType

ifExpression

»»»»»»»»»»» expressionType

literal

»»»»»»»»»»»» expressionType

caseExpression

»»»»»»»»»»»» expressionType

dataField

»»»»»»»»»»»» expressionType

function

»»»»»»»»»»»» expressionType

ifExpression

»»»»»»»»»»»» expressionType

literal

»»»»»»»»»»»»» constraintType

clause

»»»»»»»»»»»»» constraintType

constraint

»»»»»»»»»»»»» constraintType

expressionConstraint

»»»»»»»»»»»»» constraintType

likeConstraint

»»»»»»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»»»»»»» constraintType

subQueryConstraint

»»»»»»»»»»»»»» expressionType

caseExpression

»»»»»»»»»»»»»» expressionType

dataField

»»»»»»»»»»»»»» expressionType

function

»»»»»»»»»»»»»» expressionType

ifExpression

»»»»»»»»»»»»»» expressionType

literal

»»»»»»»»»»»»»» literalType

Integer

»»»»»»»»»»»»»» literalType

Decimal

»»»»»»»»»»»»»» literalType

Date

»»»»»»»»»»»»»» literalType

DateTime

»»»»»»»»»»»»»» literalType

String

»»»»»»»»»»»»»» literalType

Float

»»»»»»»»»»»»»» literalType

Long

»»»»»»»»»»»»»» literalType

Null

»»»»»»»»»»»»»» literalType

Parameter

»»»»»»»»»»»»»» literalType

Guid

»»»»»»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»»»»»»» literalType

Boolean

»»»»»»»»»»»» literalType

Integer

»»»»»»»»»»»» literalType

Decimal

»»»»»»»»»»»» literalType

Date

»»»»»»»»»»»» literalType

DateTime

»»»»»»»»»»»» literalType

String

»»»»»»»»»»»» literalType

Float

»»»»»»»»»»»» literalType

Long

»»»»»»»»»»»» literalType

Null

»»»»»»»»»»»» literalType

Parameter

»»»»»»»»»»»» literalType

Guid

»»»»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»»»»» literalType

Boolean

»»»»»»»»»»» literalType

Integer

»»»»»»»»»»» literalType

Decimal

»»»»»»»»»»» literalType

Date

»»»»»»»»»»» literalType

DateTime

»»»»»»»»»»» literalType

String

»»»»»»»»»»» literalType

Float

»»»»»»»»»»» literalType

Long

»»»»»»»»»»» literalType

Null

»»»»»»»»»»» literalType

Parameter

»»»»»»»»»»» literalType

Guid

»»»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»»»» literalType

Boolean

»»»»»»»»»» sourceType

Table

»»»»»»»»»» sourceType

Query

»»»»»»»»»» joinType

Inner

»»»»»»»»»» joinType

Left

»»»»»»»»»» joinType

Right

»»»»»»»»»» joinType

Cross

»»»»»»»»»» joinType

CrossApply

»»»»»»»»»» joinType

OuterApply

»»»»»»»»»»» constraintType

clause

»»»»»»»»»»» constraintType

constraint

»»»»»»»»»»» constraintType

expressionConstraint

»»»»»»»»»»» constraintType

likeConstraint

»»»»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»»»»» constraintType

subQueryConstraint

»»»»»»»»»» direction

Ascending

»»»»»»»»»» direction

Descending

»»»»»»»»»» direction

AscendingNullsFirst

»»»»»»»»»» direction

DescendingNullsLast

»»»»»»» order

Ascending

»»»»»»» order

Descending

»»»»»»» alignment

Justify

»»»»»»» alignment

Left

»»»»»»» alignment

Center

»»»»»»» alignment

Right

»»»»»»»»» style

Number

»»»»»»»»» style

Percent

»»»»»»»»» style

Dollars

»»»»»»»»» style

FrenchCanadianDollars

»»»»»»»»» style

Pounds

»»»»»»»»» style

Euro

»»»»»»»»» style

Yen

»»»»»»»»» style

Yuan

»»»»»»»»» style

Rand

»»»»»»»»» style

BrazilianReal

»»»»»»»»» style

Rupee

»»»»»»»»» style

SingaporeanDollar

»»»»»»»»» style

AustralianDollar

»»»»»»»»» style

Won

»»»»»» verticalAlignment

Top

»»»»»» verticalAlignment

Middle

»»»»»» verticalAlignment

Bottom

»»»»» verticalAlignment

Top

»»»»» verticalAlignment

Middle

»»»»» verticalAlignment

Bottom

»»»»»» valueType

Text

»»»»»» valueType

Formula

»»»»» operatorType

LessThan

»»»»» operatorType

LessThanEquals

»»»»» operatorType

Equals

»»»»» operatorType

NotEquals

»»»»» operatorType

GreaterThan

»»»»» operatorType

GreaterThanEquals

»»»»» operatorType

IsNull

»»»»» operatorType

IsNotNull

»»»»» valueType

String

»»»»» valueType

Numeric

»»»»» valueType

Date

»»»»» valueType

Field

»»»»» valueType

Scalar

»»»» dateDisplayMode

ShortDate

»»»» dateDisplayMode

LongDate

»»»» labelOrientation

Horizontal

»»»» labelOrientation

Vertical

»»»» labelOrientation

Slanted

»»»»» type

ComboSource

»»»»» type

DisplayValueSource

»»»»» type

DYComboSource

»»»»» type

MapSource

»»»»» type

MSComboSource

»»»»» type

MSDisplayValueSource

»»»»» type

MSDYComboSource

»»»»» type

MSXYSource

»»»»» type

MSXYZSource

»»»»» type

AngularGaugeSource

»»»»» type

HLinearGaugeSource

»»»»» type

CylinderGaugeSource

»»»»» type

XYSource

»»»»» type

XYZSource

»»»»» renderAs

Column

»»»»» renderAs

Area

»»»»» renderAs

Line

»»»»» type

SingleSeriesChartStyleSet

»»»»» type

MultiSeriesChartStyleSet

»»»»» type

MapStyleSet

»»»»» type

GaugeStyleSet

»»»» fusionTheme

Classic

»»»» fusionTheme

Solid

»»»» legendPosition

Bottom

»»»» legendPosition

Right

»»»» mapDisplayType

Afghanistan

»»»» mapDisplayType

Africa

»»»» mapDisplayType

Alabama

»»»» mapDisplayType

Alaska

»»»» mapDisplayType

Albania

»»»» mapDisplayType

Alberta

»»»» mapDisplayType

Algeria

»»»» mapDisplayType

Andorra

»»»» mapDisplayType

Angola

»»»» mapDisplayType

Antigua

»»»» mapDisplayType

Argentina

»»»» mapDisplayType

Arizona

»»»» mapDisplayType

Arkansas

»»»» mapDisplayType

Armenia

»»»» mapDisplayType

Asia

»»»» mapDisplayType

Asia3

»»»» mapDisplayType

AsiaGeorgia

»»»» mapDisplayType

Australia

»»»» mapDisplayType

Australia2

»»»» mapDisplayType

Austria

»»»» mapDisplayType

Azerbaijan

»»»» mapDisplayType

Bahamas

»»»» mapDisplayType

Bahrain

»»»» mapDisplayType

Bangladesh

»»»» mapDisplayType

Barbados

»»»» mapDisplayType

Belarus

»»»» mapDisplayType

Belgium

»»»» mapDisplayType

Belize

»»»» mapDisplayType

Benin

»»»» mapDisplayType

Bhutan

»»»» mapDisplayType

Bolivia

»»»» mapDisplayType

BosniaHerzegovina

»»»» mapDisplayType

Botswana

»»»» mapDisplayType

Brazil

»»»» mapDisplayType

BrazilRegion

»»»» mapDisplayType

BritishColumbia

»»»» mapDisplayType

Brunei

»»»» mapDisplayType

Bulgaria

»»»» mapDisplayType

BurkinaFaso

»»»» mapDisplayType

Burma

»»»» mapDisplayType

Burundi

»»»» mapDisplayType

California

»»»» mapDisplayType

Cambodia

»»»» mapDisplayType

Cameroon

»»»» mapDisplayType

Canada

»»»» mapDisplayType

CapeVerde

»»»» mapDisplayType

CaymanIslands

»»»» mapDisplayType

CentralAfricanRepublic

»»»» mapDisplayType

CentralAmerica

»»»» mapDisplayType

CentralAmerica2

»»»» mapDisplayType

CentralAmericawithCaribbean

»»»» mapDisplayType

CentralEuropeanRegion

»»»» mapDisplayType

Chad

»»»» mapDisplayType

Chile

»»»» mapDisplayType

China

»»»» mapDisplayType

China2

»»»» mapDisplayType

Colombia

»»»» mapDisplayType

Colorado

»»»» mapDisplayType

Comoros

»»»» mapDisplayType

Congo

»»»» mapDisplayType

Connecticut

»»»» mapDisplayType

CostaRica

»»»» mapDisplayType

CoteDivoire

»»»» mapDisplayType

Croatia

»»»» mapDisplayType

Cuba

»»»» mapDisplayType

Cyprus

»»»» mapDisplayType

Cyprus2

»»»» mapDisplayType

CzechRepublic

»»»» mapDisplayType

Delaware

»»»» mapDisplayType

DemocraticRepublicofCongo

»»»» mapDisplayType

Denmark

»»»» mapDisplayType

DenmarkRegion

»»»» mapDisplayType

DistrictofColumbia

»»»» mapDisplayType

Djibouti

»»»» mapDisplayType

Dominica

»»»» mapDisplayType

DominicanRepublic

»»»» mapDisplayType

EastEuropeanRegion

»»»» mapDisplayType

EastTimor

»»»» mapDisplayType

Ecuador

»»»» mapDisplayType

Egypt

»»»» mapDisplayType

ElSalvador

»»»» mapDisplayType

England

»»»» mapDisplayType

EnglandRegion

»»»» mapDisplayType

EquatorialGuinea

»»»» mapDisplayType

Eritrea

»»»» mapDisplayType

Estonia

»»»» mapDisplayType

Ethiopia

»»»» mapDisplayType

Europe

»»»» mapDisplayType

Europe2

»»»» mapDisplayType

EuropeRegion

»»»» mapDisplayType

Europewithcountries

»»»» mapDisplayType

FalklandIsland

»»»» mapDisplayType

Fiji

»»»» mapDisplayType

Finland

»»»» mapDisplayType

Florida

»»»» mapDisplayType

France

»»»» mapDisplayType

FranceDepartment

»»»» mapDisplayType

FrenchGuiana

»»»» mapDisplayType

Gabon

»»»» mapDisplayType

Gambia

»»»» mapDisplayType

Georgia

»»»» mapDisplayType

Germany

»»»» mapDisplayType

Ghana

»»»» mapDisplayType

Greece

»»»» mapDisplayType

Greenland

»»»» mapDisplayType

Grenada

»»»» mapDisplayType

Guatemala

»»»» mapDisplayType

Guinea

»»»» mapDisplayType

GuineaBissau

»»»» mapDisplayType

Guyana

»»»» mapDisplayType

Haiti

»»»» mapDisplayType

Hawaii

»»»» mapDisplayType

Honduras

»»»» mapDisplayType

HongKong

»»»» mapDisplayType

Hungary

»»»» mapDisplayType

HungaryRegions

»»»» mapDisplayType

Iceland

»»»» mapDisplayType

Idaho

»»»» mapDisplayType

Illinois

»»»» mapDisplayType

India

»»»» mapDisplayType

Indiana

»»»» mapDisplayType

Indonesia

»»»» mapDisplayType

Iowa

»»»» mapDisplayType

Iran

»»»» mapDisplayType

Iraq

»»»» mapDisplayType

Ireland

»»»» mapDisplayType

Israel

»»»» mapDisplayType

Italy

»»»» mapDisplayType

Jamaica

»»»» mapDisplayType

Japan

»»»» mapDisplayType

Jordan

»»»» mapDisplayType

Kansas

»»»» mapDisplayType

Kazakhstan

»»»» mapDisplayType

Kentucky

»»»» mapDisplayType

Kenya

»»»» mapDisplayType

Kiribati

»»»» mapDisplayType

KosovoDistricts

»»»» mapDisplayType

Kuwait

»»»» mapDisplayType

Kyrgyzstan

»»»» mapDisplayType

Laos

»»»» mapDisplayType

Latvia

»»»» mapDisplayType

Lebanon

»»»» mapDisplayType

Lesotho

»»»» mapDisplayType

Liberia

»»»» mapDisplayType

Libya

»»»» mapDisplayType

Liechtenstein

»»»» mapDisplayType

Lithuania

»»»» mapDisplayType

Louisiana

»»»» mapDisplayType

Luxembourg

»»»» mapDisplayType

Macau

»»»» mapDisplayType

Macedonia

»»»» mapDisplayType

Madagascar

»»»» mapDisplayType

MadagascarRegions

»»»» mapDisplayType

Maine

»»»» mapDisplayType

Malawi

»»»» mapDisplayType

Malaysia

»»»» mapDisplayType

Mali

»»»» mapDisplayType

Malta

»»»» mapDisplayType

Manitoba

»»»» mapDisplayType

MarshallIsland

»»»» mapDisplayType

Maryland

»»»» mapDisplayType

Massachusetts

»»»» mapDisplayType

Mauritania

»»»» mapDisplayType

Mauritius

»»»» mapDisplayType

Mexico

»»»» mapDisplayType

Michigan

»»»» mapDisplayType

Micronesia

»»»» mapDisplayType

MiddleEast

»»»» mapDisplayType

Minnesota

»»»» mapDisplayType

Mississippi

»»»» mapDisplayType

Missouri

»»»» mapDisplayType

Moldova

»»»» mapDisplayType

Monaco

»»»» mapDisplayType

Mongolia

»»»» mapDisplayType

Montana

»»»» mapDisplayType

Montenegro

»»»» mapDisplayType

Morocco

»»»» mapDisplayType

Mozambique

»»»» mapDisplayType

Namibia

»»»» mapDisplayType

Nauru

»»»» mapDisplayType

Nebraska

»»»» mapDisplayType

Nepal

»»»» mapDisplayType

Netherlands

»»»» mapDisplayType

Nevada

»»»» mapDisplayType

NewBrunswick

»»»» mapDisplayType

NewCaledonia

»»»» mapDisplayType

NewfoundlandandLabrador

»»»» mapDisplayType

NewHampshire

»»»» mapDisplayType

NewJersey

»»»» mapDisplayType

NewMexico

»»»» mapDisplayType

NewYork

»»»» mapDisplayType

NewZealand

»»»» mapDisplayType

Nicaragua

»»»» mapDisplayType

Niger

»»»» mapDisplayType

Nigeria

»»»» mapDisplayType

NorthAmerica

»»»» mapDisplayType

NorthAmericaWOCentral

»»»» mapDisplayType

NorthCarolina

»»»» mapDisplayType

NorthDakota

»»»» mapDisplayType

NorthEuropeanRegion

»»»» mapDisplayType

NorthernIreland

»»»» mapDisplayType

NorthKorea

»»»» mapDisplayType

NorthWestTerritories

»»»» mapDisplayType

Norway

»»»» mapDisplayType

NorwayRegion

»»»» mapDisplayType

NovaScotia

»»»» mapDisplayType

Nunavut

»»»» mapDisplayType

Oceania

»»»» mapDisplayType

Ohio

»»»» mapDisplayType

Oklahoma

»»»» mapDisplayType

Oman

»»»» mapDisplayType

Ontario

»»»» mapDisplayType

Oregon

»»»» mapDisplayType

Pakistan

»»»» mapDisplayType

Palau

»»»» mapDisplayType

Panama

»»»» mapDisplayType

PapuaNewGuinea

»»»» mapDisplayType

Paraguay

»»»» mapDisplayType

Pennsylvania

»»»» mapDisplayType

Peru

»»»» mapDisplayType

Philippines

»»»» mapDisplayType

Poland

»»»» mapDisplayType

PolandCounties

»»»» mapDisplayType

Portugal

»»»» mapDisplayType

PrinceEdwardIsland

»»»» mapDisplayType

PuertoRico

»»»» mapDisplayType

Qatar

»»»» mapDisplayType

Quebec

»»»» mapDisplayType

RhodeIsland

»»»» mapDisplayType

Romania

»»»» mapDisplayType

Russia

»»»» mapDisplayType

Rwanda

»»»» mapDisplayType

SaintKittsandNevis

»»»» mapDisplayType

SaintLucia

»»»» mapDisplayType

SaintVincentandtheGrenadines

»»»» mapDisplayType

Samoa

»»»» mapDisplayType

SanMarino

»»»» mapDisplayType

SaoTomeandPrincipe

»»»» mapDisplayType

Saskatchewan

»»»» mapDisplayType

SaudiArabia

»»»» mapDisplayType

Scotland

»»»» mapDisplayType

ScotlandRegion

»»»» mapDisplayType

Senegal

»»»» mapDisplayType

Serbia

»»»» mapDisplayType

SerbiaWoKosovo

»»»» mapDisplayType

Seychelles

»»»» mapDisplayType

SierraLeone

»»»» mapDisplayType

Singapore

»»»» mapDisplayType

Slovakia

»»»» mapDisplayType

Slovenia

»»»» mapDisplayType

SolomonIsland

»»»» mapDisplayType

Somalia

»»»» mapDisplayType

SouthAfrica

»»»» mapDisplayType

SouthAmerica

»»»» mapDisplayType

SouthCarolina

»»»» mapDisplayType

SouthDakota

»»»» mapDisplayType

SouthEuropeanRegion

»»»» mapDisplayType

SouthKorea

»»»» mapDisplayType

SouthSudan

»»»» mapDisplayType

Spain

»»»» mapDisplayType

SpainProvinces

»»»» mapDisplayType

SriLanka

»»»» mapDisplayType

Sudan

»»»» mapDisplayType

SudanWoSouthSudan

»»»» mapDisplayType

Suriname

»»»» mapDisplayType

Swaziland

»»»» mapDisplayType

Sweden

»»»» mapDisplayType

Switzerland

»»»» mapDisplayType

Syria

»»»» mapDisplayType

Taiwan

»»»» mapDisplayType

Tajikistan

»»»» mapDisplayType

Tanzania

»»»» mapDisplayType

Tennessee

»»»» mapDisplayType

Texas

»»»» mapDisplayType

Thailand

»»»» mapDisplayType

Tibet

»»»» mapDisplayType

Togo

»»»» mapDisplayType

Tonga

»»»» mapDisplayType

TrinidadandTobago

»»»» mapDisplayType

Tunisia

»»»» mapDisplayType

Turkey

»»»» mapDisplayType

Turkmenistan

»»»» mapDisplayType

Tuvalu

»»»» mapDisplayType

UAE

»»»» mapDisplayType

Uganda

»»»» mapDisplayType

UK

»»»» mapDisplayType

UK7

»»»» mapDisplayType

Ukraine

»»»» mapDisplayType

Uruguay

»»»» mapDisplayType

USA

»»»» mapDisplayType

USACentralRegion

»»»» mapDisplayType

USANorthEastRegion

»»»» mapDisplayType

USANorthWestRegion

»»»» mapDisplayType

USARegion

»»»» mapDisplayType

USASouthEastRegion

»»»» mapDisplayType

USASouthWestRegion

»»»» mapDisplayType

Utah

»»»» mapDisplayType

Uzbekistan

»»»» mapDisplayType

Vanuatu

»»»» mapDisplayType

VaticanCity

»»»» mapDisplayType

Venezuela

»»»» mapDisplayType

Vermont

»»»» mapDisplayType

Vietnam

»»»» mapDisplayType

Virginia

»»»» mapDisplayType

Wales

»»»» mapDisplayType

Washington

»»»» mapDisplayType

WesternSahara

»»»» mapDisplayType

WestEuropeanRegion

»»»» mapDisplayType

WestVirginia

»»»» mapDisplayType

Wisconsin

»»»» mapDisplayType

World

»»»» mapDisplayType

World8

»»»» mapDisplayType

World8WithAntarctica

»»»» mapDisplayType

WorldWithAntarctica

»»»» mapDisplayType

WorldwithCountries

»»»» mapDisplayType

Wyoming

»»»» mapDisplayType

Yemen

»»»» mapDisplayType

YukonTerritory

»»»» mapDisplayType

Zambia

»»»» mapDisplayType

Zimbabwe

»»»» ssChartDisplayType

Area2D

»»»» ssChartDisplayType

Bar2D

»»»» ssChartDisplayType

Column2D

»»»» ssChartDisplayType

Column3D

»»»» ssChartDisplayType

Doughnut2D

»»»» ssChartDisplayType

Doughnut3D

»»»» ssChartDisplayType

Funnel

»»»» ssChartDisplayType

Pyramid

»»»» ssChartDisplayType

Line

»»»» ssChartDisplayType

Pie2D

»»»» ssChartDisplayType

Pie3D

»»»» ssChartDisplayType

Spline

»»»» ssChartDisplayType

SplineArea

»»»» ssChartDisplayType

Waterfall2D

»»»» ssChartDisplayType

Kagi

»»»» msChartDisplayType

MSArea

»»»» msChartDisplayType

InverseMSArea

»»»» msChartDisplayType

ScrollArea2D

»»»» msChartDisplayType

MSBar2D

»»»» msChartDisplayType

MSColumn2D

»»»» msChartDisplayType

InverseMSColumn2D

»»»» msChartDisplayType

ScrollColumn2D

»»»» msChartDisplayType

LogMSColumn2D

»»»» msChartDisplayType

MSColumn3D

»»»» msChartDisplayType

MSLine

»»»» msChartDisplayType

InverseMSLine

»»»» msChartDisplayType

ScrollLine2D

»»»» msChartDisplayType

LogMSLine

»»»» msChartDisplayType

StackedArea2D

»»»» msChartDisplayType

StackedBar2D

»»»» msChartDisplayType

StackedBar3D

»»»» msChartDisplayType

StackedColumn2D

»»»» msChartDisplayType

ScrollStackedColumn2D

»»»» msChartDisplayType

StackedColumn3D

»»»» msChartDisplayType

MSSpline

»»»» msChartDisplayType

MSSplineArea

»»»» msChartDisplayType

Radar

»»»» msChartDisplayType

Scatter

»»»» msChartDisplayType

Bubble

»»»» msChartDisplayType

MSCombi2D

»»»» msChartDisplayType

MSCombi3D

»»»» msChartDisplayType

MSColumnLine3D

»»»» msChartDisplayType

MSCombiDY2D

»»»» msChartDisplayType

MSColumn3DLineDY

»»»» msChartDisplayType

StackedColumn3DLineDY

»»»» gaugeDisplayType

AngularGauge

»»»» gaugeDisplayType

Cylinder

»»»» gaugeDisplayType

HLinearGauge

»»»» status

Available

»»»» status

Pending

»»»» status

Closed

»»»» columns

WorkflowID

»»»» columns

WorkflowName

»»»» columns

WorkflowDescription

»»»» columns

ReportName

»»»» columns

WebReportID

»»»» columns

ActionName

»»»» columns

SubmittedBy

»»»» columns

SubmittedByName

»»»» columns

DateReceived

»»»» columns

TokenID

»»»» columns

Initiator

»»»» columns

InitiatorName

»»»» columns

DateOfInitiation

»»»» columns

DateOfCompletion

»»» type

AggregateTransformation

»»» type

ComputedColumn

»»» type

InputRowSource

»»» type

QuerySource

»»» type

TransposedSource

»»» type

StaticScalar

»»» type

ValueScalar

»»» type

ComputedScalar

»»» type

Parameter

»»»»» variableType

Literal

»»»»» variableType

Parameter

»»»»» variableType

Scalar

»»» treeNodeType

Folder

»»» treeNodeType

Source

»»» treeNodeType

ParameterRoot

»»» treeNodeType

ScalarRoot

»»» treeNodeType

SourceRoot

»»» treeNodeType

EditableSourceRoot

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.WebReportDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/webreports", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webreports");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "webReportName": "string",
  "webReportDefinition": {
    "allowPdfExport": true,
    "showInquiry": true,
    "batchExportDetails": {
      "canBatchExport": true,
      "picklistRefParam": "string"
    },
    "background": {
      "color": {},
      "image": {},
      "imageAttachment": "Scroll",
      "imagePosition": "Absolute",
      "imageTile": "None",
      "webreportId": 0,
      "x": 0,
      "y": 0,
      "opacity": 0
    },
    "defaultStyle": {
      "color": {},
      "font": {}
    },
    "directlyAccessible": true,
    "frameLayout": {
      "horizontalAlign": "Left",
      "verticalAlign": "Top",
      "type": "Frame",
      "childHeightPercents": [],
      "childWidthPercents": [],
      "frames": [],
      "name": "string",
      "numColumns": 0,
      "numRows": 0,
      "display": {}
    },
    "isLayoutLocked": true,
    "name": "string",
    "pdfOptions": {
      "autoScale": true,
      "customScaleValue": 0.1,
      "footerText": "string",
      "includePageNumber": true,
      "portraitOrientation": true,
      "showTotalPageNumber": true,
      "tableViewportWidth": 0.1
    },
    "sources": [
      {}
    ],
    "trees": [
      {}
    ],
    "version": {
      "rowVersion": 0
    },
    "webReportId": 0,
    "workflowObjectId": 0,
    "element": {},
    "styleCategory": "string"
  },
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webreports',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/webreports', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/webreports',
  params: {
  }, headers: headers

p JSON.parse(result)

Get a detailed web report.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Unique id of the web Report

expand

query

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.WebReportDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/webreports/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webreports/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webreports/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/webreports/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/webreports/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "allowPdfExport": true,
  "showInquiry": true,
  "batchExportDetails": {
    "canBatchExport": true,
    "picklistRefParam": "string"
  },
  "background": {
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "image": {
      "displayBorder": {},
      "displayPadding": {},
      "gridType": "string",
      "hoverText": "string",
      "imageByteArray": "string",
      "imageId": 0,
      "imageLink": {},
      "imageType": "string",
      "imageUrl": "string",
      "expiryDate": "2019-08-24T14:15:22Z",
      "cosObjectName": "string",
      "name": "string",
      "source": {},
      "style": {}
    },
    "imageAttachment": "Scroll",
    "imagePosition": "Absolute",
    "imageTile": "None",
    "webreportId": 0,
    "x": 0,
    "y": 0,
    "opacity": 0
  },
  "defaultStyle": {
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    }
  },
  "directlyAccessible": true,
  "frameLayout": {
    "horizontalAlign": "Left",
    "verticalAlign": "Top",
    "type": "Frame",
    "childHeightPercents": [
      0.1
    ],
    "childWidthPercents": [
      0.1
    ],
    "frames": [
      []
    ],
    "name": "string",
    "numColumns": 0,
    "numRows": 0,
    "display": {
      "gridType": "string",
      "name": "string",
      "source": {},
      "type": "DataGridDisplay",
      "restrictSource": {},
      "restrictColumn": "string",
      "style": {},
      "columnMap": {},
      "computedColumns": [],
      "computedRow": {},
      "dataGridDisplayStyle": {},
      "dataGridInputRules": [],
      "dateFormat": {},
      "defaultPageSize": 0,
      "enableExportToExcel": true,
      "enableInquiryCopy": true,
      "enableShowHideColumns": true,
      "freezeTopRow": true,
      "hiddenColumnAliasMap": {},
      "hiddenColumns": [],
      "hiddenInputRowColumnMap": {},
      "inputRowAtTop": true,
      "isVertical": true,
      "numericStyle": {},
      "paginated": true,
      "sections": [],
      "showOnlyInputRow": true,
      "showSectionHeader": true,
      "sortColumns": [],
      "suppressHeader": true,
      "hideRowBorders": true,
      "disableRowHighlighting": true,
      "suppressRepeatPartitionValues": true,
      "timeId": "string",
      "validationRules": [],
      "selectedTemplateId": 0,
      "columnWidths": [],
      "displays": [],
      "fixedGridDisplayStyle": {},
      "imageType": "string",
      "imageLink": {},
      "imageId": 0,
      "imageByteArray": "string",
      "hoverText": "string",
      "imageUrl": "string",
      "expiryDate": "2019-08-24T14:15:22Z",
      "cosObjectName": "string",
      "controlDisplayStyle": {},
      "sortById": true,
      "sortAscending": true,
      "refParameter": "string",
      "nameColumn": "string",
      "idColumn": "string",
      "hideValueForExport": true,
      "hideIdValues": true,
      "scalarDisplayStyle": {},
      "scalarLink": {},
      "text": "string",
      "documentId": 0,
      "buttonDisplayStyle": {},
      "cellStyle": {},
      "agreementText": "string",
      "format": {},
      "conditionalFormatRule": {},
      "dateDisplayMode": "ShortDate",
      "xAxisName": "string",
      "yAxisName": "string",
      "numberPrefix": "string",
      "numberSuffix": "string",
      "labelOrientation": "Horizontal",
      "hideValues": true,
      "decimalSeparator": "string",
      "thousandSeparator": "string",
      "isPercentage": "string",
      "numDecimals": "string",
      "numberScaling": "string",
      "showTitle": true,
      "yMinMax": true,
      "zMinMax": true,
      "yMin": "string",
      "yMax": "string",
      "zMin": "string",
      "zMax": "string",
      "dontTrimBarLabel": "string",
      "defaultLink": {},
      "entityLinkMap": {},
      "fusionSource": {},
      "fusionStyles": {},
      "fusionTheme": "Classic",
      "height": 0,
      "legendPosition": "Bottom",
      "mapDisplayType": "Afghanistan",
      "mapValueRanges": [],
      "showLegend": true,
      "width": 0,
      "ssChartDisplayType": "Area2D",
      "chartLink": {},
      "customColors": [],
      "msChartDisplayType": "MSArea",
      "syAxisName": "string",
      "syNumberPrefix": "string",
      "syNumberSuffix": "string",
      "hideSyValues": true,
      "centerValues": true,
      "syDecimalSeparator": "string",
      "syThousandSeparator": "string",
      "isSyPercentage": "string",
      "syNumDecimals": "string",
      "syNumberScaling": "string",
      "lowerLimitDisplayName": "string",
      "upperLimitDisplayName": "string",
      "valueToolTip": "string",
      "gaugeDisplayType": "AngularGauge",
      "link": {},
      "limitLabelFillColor": "string",
      "gaugeValueRanges": [],
      "trendpoint": {},
      "gaugeStartAngle": 0.1,
      "gaugeEndAngle": 0.1,
      "fillColor": {},
      "status": "Available",
      "enableHeaders": true,
      "workflowLinkDisplayStyle": {},
      "columns": []
    }
  },
  "isLayoutLocked": true,
  "name": "string",
  "pdfOptions": {
    "autoScale": true,
    "customScaleValue": 0.1,
    "footerText": "string",
    "includePageNumber": true,
    "portraitOrientation": true,
    "showTotalPageNumber": true,
    "tableViewportWidth": 0.1
  },
  "sources": [
    {
      "dependencies": [],
      "name": "string",
      "type": "AggregateTransformation",
      "scalarType": "string",
      "value": null,
      "column": "string",
      "keyValues": {},
      "table": "string",
      "expression": "string",
      "variables": [],
      "required": true,
      "useWebUser": true,
      "isParameterValueScalar": true,
      "parameterValue": {},
      "parameterId": 0,
      "columnNames": [],
      "source": {},
      "formula": "string",
      "partitionColumns": [],
      "timeEnd": "2019-08-24T14:15:22Z",
      "timeFrequency": {},
      "timePartition": "string",
      "timeStart": "2019-08-24T14:15:22Z",
      "newColumnName": "string",
      "keyColumns": [],
      "newColumns": [],
      "transposeColumn": "string"
    }
  ],
  "trees": [
    {
      "name": "string",
      "parent": "string",
      "parentNodeType": "string",
      "treeNodeType": "Folder"
    }
  ],
  "version": {
    "rowVersion": 0
  },
  "webReportId": 0,
  "workflowObjectId": 0,
  "element": {},
  "styleCategory": "string"
}
{"allowPdfExport":true,"showInquiry":true,"batchExportDetails":{"canBatchExport":true,"picklistRefParam":"string"},"background":{"color":{"a":0,"b":0,"g":0,"r":0},"image":{"displayBorder":{},"displayPadding":{},"gridType":"string","hoverText":"string","imageByteArray":"string","imageId":0,"imageLink":{},"imageType":"string","imageUrl":"string","expiryDate":"2019-08-24T14:15:22Z","cosObjectName":"string","name":"string","source":{},"style":{}},"imageAttachment":"Scroll","imagePosition":"Absolute","imageTile":"None","webreportId":0,"x":0,"y":0,"opacity":0},"defaultStyle":{"color":{"a":0,"b":0,"g":0,"r":0},"font":{"family":"string","size":0.1,"unit":"string","bold":true,"italic":true,"underline":true,"strikeout":true}},"directlyAccessible":true,"frameLayout":{"horizontalAlign":"Left","verticalAlign":"Top","type":"Frame","childHeightPercents":[0.1],"childWidthPercents":[0.1],"frames":[[]],"name":"string","numColumns":0,"numRows":0,"display":{"gridType":"string","name":"string","source":{},"type":"DataGridDisplay","restrictSource":{},"restrictColumn":"string","style":{},"columnMap":{},"computedColumns":[],"computedRow":{},"dataGridDisplayStyle":{},"dataGridInputRules":[],"dateFormat":{},"defaultPageSize":0,"enableExportToExcel":true,"enableInquiryCopy":true,"enableShowHideColumns":true,"freezeTopRow":true,"hiddenColumnAliasMap":{},"hiddenColumns":[],"hiddenInputRowColumnMap":{},"inputRowAtTop":true,"isVertical":true,"numericStyle":{},"paginated":true,"sections":[],"showOnlyInputRow":true,"showSectionHeader":true,"sortColumns":[],"suppressHeader":true,"hideRowBorders":true,"disableRowHighlighting":true,"suppressRepeatPartitionValues":true,"timeId":"string","validationRules":[],"selectedTemplateId":0,"columnWidths":[],"displays":[],"fixedGridDisplayStyle":{},"imageType":"string","imageLink":{},"imageId":0,"imageByteArray":"string","hoverText":"string","imageUrl":"string","expiryDate":"2019-08-24T14:15:22Z","cosObjectName":"string","controlDisplayStyle":{},"sortById":true,"sortAscending":true,"refParameter":"string","nameColumn":"string","idColumn":"string","hideValueForExport":true,"hideIdValues":true,"scalarDisplayStyle":{},"scalarLink":{},"text":"string","documentId":0,"buttonDisplayStyle":{},"cellStyle":{},"agreementText":"string","format":{},"conditionalFormatRule":{},"dateDisplayMode":"ShortDate","xAxisName":"string","yAxisName":"string","numberPrefix":"string","numberSuffix":"string","labelOrientation":"Horizontal","hideValues":true,"decimalSeparator":"string","thousandSeparator":"string","isPercentage":"string","numDecimals":"string","numberScaling":"string","showTitle":true,"yMinMax":true,"zMinMax":true,"yMin":"string","yMax":"string","zMin":"string","zMax":"string","dontTrimBarLabel":"string","defaultLink":{},"entityLinkMap":{},"fusionSource":{},"fusionStyles":{},"fusionTheme":"Classic","height":0,"legendPosition":"Bottom","mapDisplayType":"Afghanistan","mapValueRanges":[],"showLegend":true,"width":0,"ssChartDisplayType":"Area2D","chartLink":{},"customColors":[],"msChartDisplayType":"MSArea","syAxisName":"string","syNumberPrefix":"string","syNumberSuffix":"string","hideSyValues":true,"centerValues":true,"syDecimalSeparator":"string","syThousandSeparator":"string","isSyPercentage":"string","syNumDecimals":"string","syNumberScaling":"string","lowerLimitDisplayName":"string","upperLimitDisplayName":"string","valueToolTip":"string","gaugeDisplayType":"AngularGauge","link":{},"limitLabelFillColor":"string","gaugeValueRanges":[],"trendpoint":{},"gaugeStartAngle":0.1,"gaugeEndAngle":0.1,"fillColor":{},"status":"Available","enableHeaders":true,"workflowLinkDisplayStyle":{},"columns":[]}},"isLayoutLocked":true,"name":"string","pdfOptions":{"autoScale":true,"customScaleValue":0.1,"footerText":"string","includePageNumber":true,"portraitOrientation":true,"showTotalPageNumber":true,"tableViewportWidth":0.1},"sources":[{"dependencies":[],"name":"string","type":"AggregateTransformation","scalarType":"string","value":null,"column":"string","keyValues":{},"table":"string","expression":"string","variables":[],"required":true,"useWebUser":true,"isParameterValueScalar":true,"parameterValue":{},"parameterId":0,"columnNames":[],"source":{},"formula":"string","partitionColumns":[],"timeEnd":"2019-08-24T14:15:22Z","timeFrequency":{},"timePartition":"string","timeStart":"2019-08-24T14:15:22Z","newColumnName":"string","keyColumns":[],"newColumns":[],"transposeColumn":"string"}],"trees":[{"name":"string","parent":"string","parentNodeType":"string","treeNodeType":"Folder"}],"version":{"rowVersion":0},"webReportId":0,"workflowObjectId":0,"element":{},"styleCategory":"string"}

Patch a web report

Body parameter

{
  "allowPdfExport": true,
  "showInquiry": true,
  "batchExportDetails": {
    "canBatchExport": true,
    "picklistRefParam": "string"
  },
  "background": {
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "image": {
      "displayBorder": {},
      "displayPadding": {},
      "gridType": "string",
      "hoverText": "string",
      "imageByteArray": "string",
      "imageId": 0,
      "imageLink": {},
      "imageType": "string",
      "imageUrl": "string",
      "expiryDate": "2019-08-24T14:15:22Z",
      "cosObjectName": "string",
      "name": "string",
      "source": {},
      "style": {}
    },
    "imageAttachment": "Scroll",
    "imagePosition": "Absolute",
    "imageTile": "None",
    "webreportId": 0,
    "x": 0,
    "y": 0,
    "opacity": 0
  },
  "defaultStyle": {
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    }
  },
  "directlyAccessible": true,
  "frameLayout": {
    "horizontalAlign": "Left",
    "verticalAlign": "Top",
    "type": "Frame",
    "childHeightPercents": [
      0.1
    ],
    "childWidthPercents": [
      0.1
    ],
    "frames": [
      []
    ],
    "name": "string",
    "numColumns": 0,
    "numRows": 0,
    "display": {
      "gridType": "string",
      "name": "string",
      "source": {},
      "type": "DataGridDisplay",
      "restrictSource": {},
      "restrictColumn": "string",
      "style": {},
      "columnMap": {},
      "computedColumns": [],
      "computedRow": {},
      "dataGridDisplayStyle": {},
      "dataGridInputRules": [],
      "dateFormat": {},
      "defaultPageSize": 0,
      "enableExportToExcel": true,
      "enableInquiryCopy": true,
      "enableShowHideColumns": true,
      "freezeTopRow": true,
      "hiddenColumnAliasMap": {},
      "hiddenColumns": [],
      "hiddenInputRowColumnMap": {},
      "inputRowAtTop": true,
      "isVertical": true,
      "numericStyle": {},
      "paginated": true,
      "sections": [],
      "showOnlyInputRow": true,
      "showSectionHeader": true,
      "sortColumns": [],
      "suppressHeader": true,
      "hideRowBorders": true,
      "disableRowHighlighting": true,
      "suppressRepeatPartitionValues": true,
      "timeId": "string",
      "validationRules": [],
      "selectedTemplateId": 0,
      "columnWidths": [],
      "displays": [],
      "fixedGridDisplayStyle": {},
      "imageType": "string",
      "imageLink": {},
      "imageId": 0,
      "imageByteArray": "string",
      "hoverText": "string",
      "imageUrl": "string",
      "expiryDate": "2019-08-24T14:15:22Z",
      "cosObjectName": "string",
      "controlDisplayStyle": {},
      "sortById": true,
      "sortAscending": true,
      "refParameter": "string",
      "nameColumn": "string",
      "idColumn": "string",
      "hideValueForExport": true,
      "hideIdValues": true,
      "scalarDisplayStyle": {},
      "scalarLink": {},
      "text": "string",
      "documentId": 0,
      "buttonDisplayStyle": {},
      "cellStyle": {},
      "agreementText": "string",
      "format": {},
      "conditionalFormatRule": {},
      "dateDisplayMode": "ShortDate",
      "xAxisName": "string",
      "yAxisName": "string",
      "numberPrefix": "string",
      "numberSuffix": "string",
      "labelOrientation": "Horizontal",
      "hideValues": true,
      "decimalSeparator": "string",
      "thousandSeparator": "string",
      "isPercentage": "string",
      "numDecimals": "string",
      "numberScaling": "string",
      "showTitle": true,
      "yMinMax": true,
      "zMinMax": true,
      "yMin": "string",
      "yMax": "string",
      "zMin": "string",
      "zMax": "string",
      "dontTrimBarLabel": "string",
      "defaultLink": {},
      "entityLinkMap": {},
      "fusionSource": {},
      "fusionStyles": {},
      "fusionTheme": "Classic",
      "height": 0,
      "legendPosition": "Bottom",
      "mapDisplayType": "Afghanistan",
      "mapValueRanges": [],
      "showLegend": true,
      "width": 0,
      "ssChartDisplayType": "Area2D",
      "chartLink": {},
      "customColors": [],
      "msChartDisplayType": "MSArea",
      "syAxisName": "string",
      "syNumberPrefix": "string",
      "syNumberSuffix": "string",
      "hideSyValues": true,
      "centerValues": true,
      "syDecimalSeparator": "string",
      "syThousandSeparator": "string",
      "isSyPercentage": "string",
      "syNumDecimals": "string",
      "syNumberScaling": "string",
      "lowerLimitDisplayName": "string",
      "upperLimitDisplayName": "string",
      "valueToolTip": "string",
      "gaugeDisplayType": "AngularGauge",
      "link": {},
      "limitLabelFillColor": "string",
      "gaugeValueRanges": [],
      "trendpoint": {},
      "gaugeStartAngle": 0.1,
      "gaugeEndAngle": 0.1,
      "fillColor": {},
      "status": "Available",
      "enableHeaders": true,
      "workflowLinkDisplayStyle": {},
      "columns": []
    }
  },
  "isLayoutLocked": true,
  "name": "string",
  "pdfOptions": {
    "autoScale": true,
    "customScaleValue": 0.1,
    "footerText": "string",
    "includePageNumber": true,
    "portraitOrientation": true,
    "showTotalPageNumber": true,
    "tableViewportWidth": 0.1
  },
  "sources": [
    {
      "dependencies": [],
      "name": "string",
      "type": "AggregateTransformation",
      "scalarType": "string",
      "value": null,
      "column": "string",
      "keyValues": {},
      "table": "string",
      "expression": "string",
      "variables": [],
      "required": true,
      "useWebUser": true,
      "isParameterValueScalar": true,
      "parameterValue": {},
      "parameterId": 0,
      "columnNames": [],
      "source": {},
      "formula": "string",
      "partitionColumns": [],
      "timeEnd": "2019-08-24T14:15:22Z",
      "timeFrequency": {},
      "timePartition": "string",
      "timeStart": "2019-08-24T14:15:22Z",
      "newColumnName": "string",
      "keyColumns": [],
      "newColumns": [],
      "transposeColumn": "string"
    }
  ],
  "trees": [
    {
      "name": "string",
      "parent": "string",
      "parentNodeType": "string",
      "treeNodeType": "Folder"
    }
  ],
  "version": {
    "rowVersion": 0
  },
  "webReportId": 0,
  "workflowObjectId": 0,
  "element": {},
  "styleCategory": "string"
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.WebReportDTO

false

none

» allowPdfExport

body

boolean

false

none

» showInquiry

body

boolean

false

none

» batchExportDetails

body

Varicent.RESTAPI.v1.DTOs.WebReportBatchExportDetailsDTO

false

none

»» canBatchExport

body

boolean

false

none

»» picklistRefParam

body

string¦null

false

none

» background

body

Varicent.RESTAPI.v1.DTOs.BackgroundDisplayDTO

false

none

»» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»» a

body

integer(int32)

false

none

»»» b

body

integer(int32)

false

none

»»» g

body

integer(int32)

false

none

»»» r

body

integer(int32)

false

none

»» image

body

Varicent.RESTAPI.v1.DTOs.ImageDisplayDTO

false

none

»»» displayBorder

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»» bottom

body

Varicent.RESTAPI.v1.DTOs.BorderDTO

false

none

»»»»» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»»»» width

body

number(float)

false

none

»»»» left

body

Varicent.RESTAPI.v1.DTOs.BorderDTO

false

none

»»»» right

body

Varicent.RESTAPI.v1.DTOs.BorderDTO

false

none

»»»» top

body

Varicent.RESTAPI.v1.DTOs.BorderDTO

false

none

»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»»» bottom

body

number(float)

false

none

»»»» left

body

number(float)

false

none

»»»» right

body

number(float)

false

none

»»»» top

body

number(float)

false

none

»»» gridType

body

string¦null

false

none

»»» hoverText

body

string¦null

false

none

»»» imageByteArray

body

string(byte)¦null

false

none

»»» imageId

body

integer(int32)

false

none

»»» imageLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»» document

body

string¦null

false

none

»»»» openInNewWindow

body

boolean

false

none

»»»» parameters

body

object¦null

false

none

»»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.LinkParameterValueDTO

false

none

»»»»»» dataType

body

string

false

none

»»»»»» source

body

string¦null

false

none

»»»»»» type

body

string

false

none

»»»»»» value

body

string¦null

false

none

»»»» reportId

body

integer(int32)¦null

false

none

»»»» targetId

body

integer(int32)

false

none

»»»» targetType

body

string

false

none

»»»» webFormId

body

integer(int32)¦null

false

none

»»»» webTabId

body

integer(int32)¦null

false

none

»»» imageType

body

string¦null

false

none

»»» imageUrl

body

string¦null

false

none

»»» expiryDate

body

string(date-time)¦null

false

none

»»» cosObjectName

body

string¦null

false

none

»»» name

body

string¦null

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DisplaySourceDTO

false

none

»»»» name

body

string¦null

false

none

»»» style

body

Varicent.RESTAPI.v1.DTOs.DataDisplayStyleDTO

false

none

»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»» imageAttachment

body

string

false

none

»» imagePosition

body

string

false

none

»» imageTile

body

string

false

none

»» webreportId

body

integer(int32)

false

none

»» x

body

integer(int32)

false

none

»» y

body

integer(int32)

false

none

»» opacity

body

integer(int32)

false

none

» defaultStyle

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»» font

body

Varicent.RESTAPI.v1.DTOs.FontDefinitionDTO

false

none

»»» family

body

string¦null

false

none

»»» size

body

number(float)

false

none

»»» unit

body

string¦null

false

none

»»» bold

body

boolean

false

none

»»» italic

body

boolean

false

none

»»» underline

body

boolean

false

none

»»» strikeout

body

boolean

false

none

» directlyAccessible

body

boolean

false

none

» frameLayout

body

Varicent.RESTAPI.v1.DTOs.FrameableDTO

false

none

»» horizontalAlign

body

string

false

none

»» verticalAlign

body

string

false

none

»» type

body

string

false

none

»» childHeightPercents

body

[number]¦null

false

none

»» childWidthPercents

body

[number]¦null

false

none

»» frames

body

[array]¦null

false

none

»»» anonymous

body

any

false

none

»» name

body

string¦null

false

none

»» numColumns

body

integer(int32)

false

none

»» numRows

body

integer(int32)

false

none

»» display

body

Varicent.RESTAPI.v1.DTOs.DataDisplayDTO

false

none

»»» gridType

body

string¦null

false

none

»»» name

body

string¦null

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DisplaySourceDTO

false

none

»»» type

body

string

false

none

»»» restrictSource

body

Varicent.RESTAPI.v1.DTOs.DisplaySourceDTO

false

none

»»» restrictColumn

body

string¦null

false

none

»»» style

body

Varicent.RESTAPI.v1.DTOs.DataDisplayStyleDTO

false

none

»»» columnMap

body

object¦null

false

none

»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.DataGridSourceColumnDTO

false

none

»»»»» displayName

body

Varicent.RESTAPI.v1.DTOs.DataGridColumnDisplayNameDTO

false

none

»»»»»» displayName

body

string¦null

false

none

»»»»» dateFormat

body

Varicent.RESTAPI.v1.DTOs.PRDateFormatDTO

false

none

»»»»»» style

body

string

false

none

»»»»» pickListFilter

body

Varicent.RESTAPI.v1.DTOs.DataGridPicklistFilterDTO

false

none

»»»»»» name

body

string¦null

false

none

»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»»»»»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»»»»»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»»»»»»» alias

body

string¦null

false

none

»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»» customSelect

body

string¦null

false

none

»»»»»»»»» dataType

body

string

false

none

»»»»»»»»» type

body

string

false

none

»»»»»»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»»»»»» constraintType

body

string

false

none

»»»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»»»» condition

body

any

false

none

»»»»»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»»»»»» literalType

body

string

false

none

»»»»»»»»»»»»» value

body

any

false

none

»»»»»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»»»»»» constraints

body

array¦null

false

none

»»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»»» literalRight

body

any

false

none

»»»»»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»»»» right

body

any

false

none

»»»»»»»»»»»» expressionLeft

body

any

false

none

»»»»»»»»»»»» expressionRight

body

any

false

none

»»»»»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»»»»»» like

body

string¦null

false

none

»»»»»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»»»» literalType

body

string

false

none

»»»»»»»»»»» value

body

any

false

none

»»»»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»»» literalType

body

string

false

none

»»»»»»»»»» value

body

any

false

none

»»»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»»»»»»» m_namespace

body

string¦null

false

none

»»»»»»»»»» name

body

string¦null

false

none

»»»»»»»»» query

body

any

false

none

»»»»»»»»» alias

body

string¦null

false

none

»»»»»»»»» sourceType

body

string

false

none

»»»»»»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»»»»» joinType

body

string

false

none

»»»»»»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»»»»»» constraintType

body

string

false

none

»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»»»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»»»» like

body

string¦null

false

none

»»»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»» direction

body

string

false

none

»»»»»»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»» column

body

string¦null

false

none

»»»»»»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»»»» distinct

body

boolean

false

none

»»»»»»»» unionWith

body

any

false

none

»»»»»»»» exceptWith

body

any

false

none

»»»»»»» sourceNames

body

object¦null

false

none

»»»»»»»» additionalProperties

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»» defaultValue

body

string¦null

false

none

»»»»» referencedFrequency

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»»»»» levelId

body

string¦null

false

none

»»»»»» timeId

body

string¦null

false

none

»»»»» isEditable

body

boolean

false

none

»»»»» picklistDisplayOptions

body

Varicent.RESTAPI.v1.DTOs.InputRowPicklistOptionsDTO

false

none

»»»»»» description

body

string¦null

false

none

»»»»»» order

body

string

false

none

»»»»»» hideKey

body

boolean

false

none

»»»»»» hideDescription

body

boolean

false

none

»»»»»» sortById

body

boolean

false

none

»»»»» order

body

integer(int32)

false

none

»»»»» headerStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»»» alignment

body

string

false

none

»»»»»» backColor

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»»»»» font

body

Varicent.RESTAPI.v1.DTOs.FontDefinitionDTO

false

none

»»»»»» foreColor

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»»»» formatRule

body

Varicent.RESTAPI.v1.DTOs.ConditionalFormatRuleDTO

false

none

»»»»»» formats

body

[Varicent.RESTAPI.v1.DTOs.ConditionalFormatDTO]¦null

false

none

»»»»»»» formula

body

string¦null

false

none

»»»»»»» numericFormat

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»»»»»»» scale

body

integer(int32)

false

none

»»»»»»»» style

body

string

false

none

»»»»»»» style

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» columnLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»»» numericFormat

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»»»» width

body

number(double)

false

none

»»»»» initiallyShow

body

boolean

false

none

»»»»» useRowTextAlignment

body

boolean

false

none

»»»»» wrapText

body

boolean

false

none

»»»»» maxWidth

body

integer(int32)

false

none

»»»»» verticalAlignment

body

string

false

none

»»» computedColumns

body

[Varicent.RESTAPI.v1.DTOs.DataGridComputedColumnDTO]¦null

false

none

»»»» name

body

string¦null

false

none

»»»» formula

body

string¦null

false

none

»»»» order

body

integer(int32)

false

none

»»»» headerStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»» formatRule

body

Varicent.RESTAPI.v1.DTOs.ConditionalFormatRuleDTO

false

none

»»»» columnLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»» numericFormat

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»»» width

body

number(double)

false

none

»»»» initiallyShow

body

boolean

false

none

»»»» useRowTextAlignment

body

boolean

false

none

»»»» wrapText

body

boolean

false

none

»»»» maxWidth

body

integer(int32)

false

none

»»»» verticalAlignment

body

string

false

none

»»» computedRow

body

object¦null

false

none

»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.DataGridComputedRowCellDTO

false

none

»»»»» columnDisplayName

body

string¦null

false

none

»»»»» cellValue

body

string¦null

false

none

»»»»» valueType

body

string

false

none

»»»»» numericFormat

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»» dataGridDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.DataGridDisplayStyleDTO

false

none

»»»» headerStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»» evenRowStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»» oddRowStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»» allowAlternateRowFont

body

boolean

false

none

»»»» isHeaderVerticalAlignmentBottom

body

boolean

false

none

»»»» computedRowStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»» borderWidth

body

integer(int32)

false

none

»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»» dataGridInputRules

body

[Varicent.RESTAPI.v1.DTOs.DataGridInputRuleDTO]¦null

false

none

»»»» id

body

integer(int32)

false

none

»»»» dataGrid

body

string¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» operatorType

body

string

false

none

»»»» valueType

body

string

false

none

»»»» value

body

any

false

none

»»» dateFormat

body

Varicent.RESTAPI.v1.DTOs.PRDateFormatDTO

false

none

»»» defaultPageSize

body

integer(int32)¦null

false

none

»»» enableExportToExcel

body

boolean¦null

false

none

»»» enableInquiryCopy

body

boolean¦null

false

none

»»» enableShowHideColumns

body

boolean¦null

false

none

»»» freezeTopRow

body

boolean¦null

false

none

»»» hiddenColumnAliasMap

body

object¦null

false

none

»»»» additionalProperties

body

string¦null

false

none

»»» hiddenColumns

body

[Varicent.RESTAPI.v1.DTOs.DataGridHiddenColumnDTO]¦null

false

none

»»»» order

body

integer(int32)

false

none

»»»» name

body

string¦null

false

none

»»»» type

body

string¦null

false

none

»»» hiddenInputRowColumnMap

body

object¦null

false

none

»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.DataGridSourceColumnDTO

false

none

»»» inputRowAtTop

body

boolean¦null

false

none

»»» isVertical

body

boolean¦null

false

none

»»» numericStyle

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»» paginated

body

boolean¦null

false

none

»»» sections

body

[Varicent.RESTAPI.v1.DTOs.SectionDisplayDTO]¦null

false

none

»»»» name

body

string¦null

false

none

»»»» frequency

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»»» sources

body

[Varicent.RESTAPI.v1.DTOs.SourceInfoDTO]¦null

false

none

»»»»» columnMapping

body

object¦null

false

none

»»»»»» additionalProperties

body

string¦null

false

none

»»»»» valueColumn

body

string¦null

false

none

»»»»» sourceName

body

string¦null

false

none

»»»»» sectionStyle

body

Varicent.RESTAPI.v1.DTOs.ScalarDisplayStyleDTO

false

none

»»»»»» style

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»»»» format

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»»»» dateFormat

body

Varicent.RESTAPI.v1.DTOs.PRDateFormatDTO

false

none

»»»» sectionDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.ScalarDisplayStyleDTO

false

none

»»» showOnlyInputRow

body

boolean¦null

false

none

»»» showSectionHeader

body

boolean¦null

false

none

»»» sortColumns

body

[Varicent.RESTAPI.v1.DTOs.DataGridSortColumnDTO]¦null

false

none

»»»» column

body

string¦null

false

none

»»»» sortDescending

body

boolean

false

none

»»»» columnFrequency

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»» suppressHeader

body

boolean¦null

false

none

»»» hideRowBorders

body

boolean¦null

false

none

»»» disableRowHighlighting

body

boolean¦null

false

none

»»» suppressRepeatPartitionValues

body

boolean¦null

false

none

»»» timeId

body

string¦null

false

none

»»» validationRules

body

[Varicent.RESTAPI.v1.DTOs.WebReportValidationRuleDTO]¦null

false

none

»»»» formula

body

string¦null

false

none

»»»» errorMessage

body

string¦null

false

none

»»» selectedTemplateId

body

integer(int32)¦null

false

none

»»» columnWidths

body

[number]¦null

false

none

»»» displays

body

[array]¦null

false

none

»»»» anonymous

body

any

false

none

»»» fixedGridDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.FixedGridDisplayStyleDTO

false

none

»»»» rowStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»» borderWidth

body

integer(int32)

false

none

»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»» imageType

body

string¦null

false

none

»»» imageLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»» imageId

body

integer(int32)¦null

false

none

»»» imageByteArray

body

string(byte)¦null

false

none

»»» hoverText

body

string¦null

false

none

»»» imageUrl

body

string¦null

false

none

»»» expiryDate

body

string(date-time)¦null

false

none

»»» cosObjectName

body

string¦null

false

none

»»» controlDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.ControlDisplayStyleDTO

false

none

»»»» style

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»» sortById

body

boolean¦null

false

none

»»» sortAscending

body

boolean¦null

false

none

»»» refParameter

body

string¦null

false

none

»»» nameColumn

body

string¦null

false

none

»»» idColumn

body

string¦null

false

none

»»» hideValueForExport

body

boolean¦null

false

none

»»» hideIdValues

body

boolean¦null

false

none

»»» scalarDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.ScalarDisplayStyleDTO

false

none

»»» scalarLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»» text

body

string¦null

false

none

»»» documentId

body

integer(int32)¦null

false

none

»»» buttonDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.ButtonDisplayStyleDTO

false

none

»»»» style

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»» cellStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»» agreementText

body

string¦null

false

none

»»» format

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»» conditionalFormatRule

body

Varicent.RESTAPI.v1.DTOs.ConditionalFormatRuleDTO

false

none

»»» dateDisplayMode

body

string¦null

false

none

»»» xAxisName

body

string¦null

false

none

»»» yAxisName

body

string¦null

false

none

»»» numberPrefix

body

string¦null

false

none

»»» numberSuffix

body

string¦null

false

none

»»» labelOrientation

body

string¦null

false

none

»»» hideValues

body

boolean¦null

false

none

»»» decimalSeparator

body

string¦null

false

none

»»» thousandSeparator

body

string¦null

false

none

»»» isPercentage

body

string¦null

false

none

»»» numDecimals

body

string¦null

false

none

»»» numberScaling

body

string¦null

false

none

»»» showTitle

body

boolean¦null

false

none

»»» yMinMax

body

boolean¦null

false

none

»»» zMinMax

body

boolean¦null

false

none

»»» yMin

body

string¦null

false

none

»»» yMax

body

string¦null

false

none

»»» zMin

body

string¦null

false

none

»»» zMax

body

string¦null

false

none

»»» dontTrimBarLabel

body

string¦null

false

none

»»» defaultLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»» entityLinkMap

body

object¦null

false

none

»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»» fusionSource

body

Varicent.RESTAPI.v1.DTOs.FusionSourceDTO

false

none

»»»» type

body

string

false

none

»»»» sorted

body

boolean

false

none

»»»» descending

body

boolean

false

none

»»»» sortedByName

body

boolean

false

none

»»»» sourceName

body

string¦null

false

none

»»»» chartLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»» displayColumn

body

string¦null

false

none

»»»» valueColumn

body

string¦null

false

none

»»»» sourceAlias

body

string¦null

false

none

»»»» sortingInfo

body

Varicent.RESTAPI.v1.DTOs.SortingInfoDTO

false

none

»»»»» levelId

body

string¦null

false

none

»»»»» sortDescending

body

boolean

false

none

»»»»» timeId

body

string¦null

false

none

»»»»» sortedByName

body

boolean

false

none

»»»» xColumn

body

string¦null

false

none

»»»» yColumn

body

string¦null

false

none

»»»» zColumn

body

string¦null

false

none

»»»» renderAs

body

string¦null

false

none

»»»» isPrimaryAxis

body

boolean¦null

false

none

»»»» entityColumn

body

string¦null

false

none

»»»» sources

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» minValueSourceName

body

string¦null

false

none

»»»» maxValueSourceName

body

string¦null

false

none

»»»» currentValueSourceName

body

string¦null

false

none

»»»» trendpointValueSourceName

body

string¦null

false

none

»»» fusionStyles

body

Varicent.RESTAPI.v1.DTOs.FusionStyleSetDTO

false

none

»»»» type

body

string

false

none

»»»» title

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»» xAxisName

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»» yAxisName

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»» xAxisValues

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»» yAxisValues

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»» legend

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»» syAxisName

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»» syAxisValues

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»» labels

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»» tickValues

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»» pointerOrFill

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»» fusionTheme

body

string¦null

false

none

»»» height

body

integer(int32)¦null

false

none

»»» legendPosition

body

string¦null

false

none

»»» mapDisplayType

body

string¦null

false

none

»»» mapValueRanges

body

[Varicent.RESTAPI.v1.DTOs.ColorValueRangeDTO]¦null

false

none

»»»» label

body

string¦null

false

none

»»»» min

body

number(double)

false

none

»»»» max

body

number(double)

false

none

»»»» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»» showLegend

body

boolean¦null

false

none

»»» width

body

integer(int32)¦null

false

none

»»» ssChartDisplayType

body

string¦null

false

none

»»» chartLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»» customColors

body

[Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO]¦null

false

none

»»» msChartDisplayType

body

string¦null

false

none

»»» syAxisName

body

string¦null

false

none

»»» syNumberPrefix

body

string¦null

false

none

»»» syNumberSuffix

body

string¦null

false

none

»»» hideSyValues

body

boolean¦null

false

none

»»» centerValues

body

boolean¦null

false

none

»»» syDecimalSeparator

body

string¦null

false

none

»»» syThousandSeparator

body

string¦null

false

none

»»» isSyPercentage

body

string¦null

false

none

»»» syNumDecimals

body

string¦null

false

none

»»» syNumberScaling

body

string¦null

false

none

»»» lowerLimitDisplayName

body

string¦null

false

none

»»» upperLimitDisplayName

body

string¦null

false

none

»»» valueToolTip

body

string¦null

false

none

»»» gaugeDisplayType

body

string¦null

false

none

»»» link

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»» limitLabelFillColor

body

string¦null

false

none

»»» gaugeValueRanges

body

[Varicent.RESTAPI.v1.DTOs.ColorValueRangeDTO]¦null

false

none

»»» trendpoint

body

Varicent.RESTAPI.v1.DTOs.TrendpointDTO

false

none

»»»» label

body

string¦null

false

none

»»»» labelStyle

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»» gaugeStartAngle

body

number(double)¦null

false

none

»»» gaugeEndAngle

body

number(double)¦null

false

none

»»» fillColor

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»» status

body

string¦null

false

none

»»» enableHeaders

body

boolean¦null

false

none

»»» workflowLinkDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.WorkflowLinkDisplayStyleDTO

false

none

»»»» headerStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»» primaryStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»» secondaryStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»» columns

body

[string]¦null

false

none

» isLayoutLocked

body

boolean

false

none

» name

body

string¦null

false

none

» pdfOptions

body

Varicent.RESTAPI.v1.DTOs.WebReportPdfOptionsDTO

false

none

»» autoScale

body

boolean

false

none

»» customScaleValue

body

number(double)

false

none

»» footerText

body

string¦null

false

none

»» includePageNumber

body

boolean

false

none

»» portraitOrientation

body

boolean

false

none

»» showTotalPageNumber

body

boolean

false

none

»» tableViewportWidth

body

number(double)¦null

false

none

» sources

body

[Varicent.RESTAPI.v1.DTOs.ReportSourceDTO]¦null

false

none

»» dependencies

body

[string]¦null

false

none

»» name

body

string¦null

false

none

»» type

body

string

false

none

»» scalarType

body

string¦null

false

none

»» value

body

any

false

none

»» column

body

string¦null

false

none

»» keyValues

body

object¦null

false

none

»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.ReportVariableDTO

false

none

»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» variableName

body

string¦null

false

none

»»»» variableType

body

string

false

none

»» table

body

string¦null

false

none

»» expression

body

string¦null

false

none

»» variables

body

[string]¦null

false

none

»» required

body

boolean

false

none

»» useWebUser

body

boolean

false

none

»» isParameterValueScalar

body

boolean

false

none

»» parameterValue

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»» parameterId

body

integer(int32)

false

none

»» columnNames

body

[string]¦null

false

none

»» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»» formula

body

string¦null

false

none

»» partitionColumns

body

[string]¦null

false

none

»» timeEnd

body

string(date-time)

false

none

»» timeFrequency

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»» timePartition

body

string¦null

false

none

»» timeStart

body

string(date-time)

false

none

»» newColumnName

body

string¦null

false

none

»» keyColumns

body

[string]¦null

false

none

»» newColumns

body

[string]¦null

false

none

»» transposeColumn

body

string¦null

false

none

» trees

body

[Varicent.RESTAPI.v1.DTOs.ReportTreeNodeDTO]¦null

false

none

»» name

body

string¦null

false

none

»» parent

body

string¦null

false

none

»» parentNodeType

body

string¦null

false

none

»» treeNodeType

body

string

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

» webReportId

body

integer(int32)

false

none

» workflowObjectId

body

integer(int32)

false

none

» element

body

Varicent.RESTAPI.v1.DTOs.IExpandableResourceDTO

false

none

» styleCategory

body

string¦null

false

none

Enumerated Values

Parameter

Value

»»»»»» dataType

Report

»»»»»» dataType

Form

»»»»»» dataType

String

»»»»»» dataType

DateTime

»»»»»» dataType

Decimal

»»»»»» dataType

Integer

»»»»»» type

Scalar

»»»»»» type

RowValue

»»»»»» type

Constant

»»»» targetType

WebReport

»»»» targetType

WebForm

»»»» targetType

URL

»» imageAttachment

Scroll

»» imageAttachment

Fixed

»» imagePosition

Absolute

»» imagePosition

Percent

»» imagePosition

LeftTop

»» imagePosition

LeftCenter

»» imagePosition

LeftBottom

»» imagePosition

RightTop

»» imagePosition

RightCenter

»» imagePosition

RightBottom

»» imagePosition

CenterTop

»» imagePosition

CenterCenter

»» imagePosition

CenterBottom

»» imageTile

None

»» imageTile

Vertical

»» imageTile

Horizontal

»» imageTile

Both

»» horizontalAlign

Left

»» horizontalAlign

Middle

»» horizontalAlign

Right

»» verticalAlign

Top

»» verticalAlign

Middle

»» verticalAlign

Bottom

»» type

Frame

»» type

Content

»»» type

DataGridDisplay

»»» type

FixedGridDisplay

»»» type

ImageDisplay

»»» type

MapDisplay

»»» type

MultiSeriesChartDisplay

»»» type

PickListControl

»»» type

QuickTextDisplay

»»» type

DocumentLinkDisplay

»»» type

SingleSeriesChartDisplay

»»» type

SubmitButtonDisplay

»»» type

TextControl

»»» type

SignatureControl

»»» type

TextScalarDisplay

»»» type

NumericScalarDisplay

»»» type

DateScalarDisplay

»»» type

CylinderGaugeDisplay

»»» type

HLinearGaugeDisplay

»»» type

AngularGaugeDisplay

»»» type

WorkflowLinkControl

»»»»»» style

Date

»»»»»» style

DateTime

»»»»»»»»» dataType

Int

»»»»»»»»» dataType

Decimal

»»»»»»»»» dataType

DateTime

»»»»»»»»» dataType

None

»»»»»»»»» dataType

String

»»»»»»»»» type

SelectAll

»»»»»»»»» type

SelectItem

»»»»»»»»» type

SelectLiteral

»»»»»»»»» type

SelectCustom

»»»»»»»»» type

SelectExpression

»»»»»»»»»» expressionType

caseExpression

»»»»»»»»»» expressionType

dataField

»»»»»»»»»» expressionType

function

»»»»»»»»»» expressionType

ifExpression

»»»»»»»»»» expressionType

literal

»»»»»»»»»»» expressionType

caseExpression

»»»»»»»»»»» expressionType

dataField

»»»»»»»»»»» expressionType

function

»»»»»»»»»»» expressionType

ifExpression

»»»»»»»»»»» expressionType

literal

»»»»»»»»»»»» constraintType

clause

»»»»»»»»»»»» constraintType

constraint

»»»»»»»»»»»» constraintType

expressionConstraint

»»»»»»»»»»»» constraintType

likeConstraint

»»»»»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»»»»»» constraintType

subQueryConstraint

»»»»»»»»»»»»» expressionType

caseExpression

»»»»»»»»»»»»» expressionType

dataField

»»»»»»»»»»»»» expressionType

function

»»»»»»»»»»»»» expressionType

ifExpression

»»»»»»»»»»»»» expressionType

literal

»»»»»»»»»»»»» literalType

Integer

»»»»»»»»»»»»» literalType

Decimal

»»»»»»»»»»»»» literalType

Date

»»»»»»»»»»»»» literalType

DateTime

»»»»»»»»»»»»» literalType

String

»»»»»»»»»»»»» literalType

Float

»»»»»»»»»»»»» literalType

Long

»»»»»»»»»»»»» literalType

Null

»»»»»»»»»»»»» literalType

Parameter

»»»»»»»»»»»»» literalType

Guid

»»»»»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»»»»»» literalType

Boolean

»»»»»»»»»»» literalType

Integer

»»»»»»»»»»» literalType

Decimal

»»»»»»»»»»» literalType

Date

»»»»»»»»»»» literalType

DateTime

»»»»»»»»»»» literalType

String

»»»»»»»»»»» literalType

Float

»»»»»»»»»»» literalType

Long

»»»»»»»»»»» literalType

Null

»»»»»»»»»»» literalType

Parameter

»»»»»»»»»»» literalType

Guid

»»»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»»»» literalType

Boolean

»»»»»»»»»» literalType

Integer

»»»»»»»»»» literalType

Decimal

»»»»»»»»»» literalType

Date

»»»»»»»»»» literalType

DateTime

»»»»»»»»»» literalType

String

»»»»»»»»»» literalType

Float

»»»»»»»»»» literalType

Long

»»»»»»»»»» literalType

Null

»»»»»»»»»» literalType

Parameter

»»»»»»»»»» literalType

Guid

»»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»»» literalType

Boolean

»»»»»»»»» sourceType

Table

»»»»»»»»» sourceType

Query

»»»»»»»»» joinType

Inner

»»»»»»»»» joinType

Left

»»»»»»»»» joinType

Right

»»»»»»»»» joinType

Cross

»»»»»»»»» joinType

CrossApply

»»»»»»»»» joinType

OuterApply

»»»»»»»»»» constraintType

clause

»»»»»»»»»» constraintType

constraint

»»»»»»»»»» constraintType

expressionConstraint

»»»»»»»»»» constraintType

likeConstraint

»»»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»»»» constraintType

subQueryConstraint

»»»»»»»»» direction

Ascending

»»»»»»»»» direction

Descending

»»»»»»»»» direction

AscendingNullsFirst

»»»»»»»»» direction

DescendingNullsLast

»»»»»» order

Ascending

»»»»»» order

Descending

»»»»»» alignment

Justify

»»»»»» alignment

Left

»»»»»» alignment

Center

»»»»»» alignment

Right

»»»»»»»» style

Number

»»»»»»»» style

Percent

»»»»»»»» style

Dollars

»»»»»»»» style

FrenchCanadianDollars

»»»»»»»» style

Pounds

»»»»»»»» style

Euro

»»»»»»»» style

Yen

»»»»»»»» style

Yuan

»»»»»»»» style

Rand

»»»»»»»» style

BrazilianReal

»»»»»»»» style

Rupee

»»»»»»»» style

SingaporeanDollar

»»»»»»»» style

AustralianDollar

»»»»»»»» style

Won

»»»»» verticalAlignment

Top

»»»»» verticalAlignment

Middle

»»»»» verticalAlignment

Bottom

»»»» verticalAlignment

Top

»»»» verticalAlignment

Middle

»»»» verticalAlignment

Bottom

»»»»» valueType

Text

»»»»» valueType

Formula

»»»» operatorType

LessThan

»»»» operatorType

LessThanEquals

»»»» operatorType

Equals

»»»» operatorType

NotEquals

»»»» operatorType

GreaterThan

»»»» operatorType

GreaterThanEquals

»»»» operatorType

IsNull

»»»» operatorType

IsNotNull

»»»» valueType

String

»»»» valueType

Numeric

»»»» valueType

Date

»»»» valueType

Field

»»»» valueType

Scalar

»»» dateDisplayMode

ShortDate

»»» dateDisplayMode

LongDate

»»» labelOrientation

Horizontal

»»» labelOrientation

Vertical

»»» labelOrientation

Slanted

»»»» type

ComboSource

»»»» type

DisplayValueSource

»»»» type

DYComboSource

»»»» type

MapSource

»»»» type

MSComboSource

»»»» type

MSDisplayValueSource

»»»» type

MSDYComboSource

»»»» type

MSXYSource

»»»» type

MSXYZSource

»»»» type

AngularGaugeSource

»»»» type

HLinearGaugeSource

»»»» type

CylinderGaugeSource

»»»» type

XYSource

»»»» type

XYZSource

»»»» renderAs

Column

»»»» renderAs

Area

»»»» renderAs

Line

»»»» type

SingleSeriesChartStyleSet

»»»» type

MultiSeriesChartStyleSet

»»»» type

MapStyleSet

»»»» type

GaugeStyleSet

»»» fusionTheme

Classic

»»» fusionTheme

Solid

»»» legendPosition

Bottom

»»» legendPosition

Right

»»» mapDisplayType

Afghanistan

»»» mapDisplayType

Africa

»»» mapDisplayType

Alabama

»»» mapDisplayType

Alaska

»»» mapDisplayType

Albania

»»» mapDisplayType

Alberta

»»» mapDisplayType

Algeria

»»» mapDisplayType

Andorra

»»» mapDisplayType

Angola

»»» mapDisplayType

Antigua

»»» mapDisplayType

Argentina

»»» mapDisplayType

Arizona

»»» mapDisplayType

Arkansas

»»» mapDisplayType

Armenia

»»» mapDisplayType

Asia

»»» mapDisplayType

Asia3

»»» mapDisplayType

AsiaGeorgia

»»» mapDisplayType

Australia

»»» mapDisplayType

Australia2

»»» mapDisplayType

Austria

»»» mapDisplayType

Azerbaijan

»»» mapDisplayType

Bahamas

»»» mapDisplayType

Bahrain

»»» mapDisplayType

Bangladesh

»»» mapDisplayType

Barbados

»»» mapDisplayType

Belarus

»»» mapDisplayType

Belgium

»»» mapDisplayType

Belize

»»» mapDisplayType

Benin

»»» mapDisplayType

Bhutan

»»» mapDisplayType

Bolivia

»»» mapDisplayType

BosniaHerzegovina

»»» mapDisplayType

Botswana

»»» mapDisplayType

Brazil

»»» mapDisplayType

BrazilRegion

»»» mapDisplayType

BritishColumbia

»»» mapDisplayType

Brunei

»»» mapDisplayType

Bulgaria

»»» mapDisplayType

BurkinaFaso

»»» mapDisplayType

Burma

»»» mapDisplayType

Burundi

»»» mapDisplayType

California

»»» mapDisplayType

Cambodia

»»» mapDisplayType

Cameroon

»»» mapDisplayType

Canada

»»» mapDisplayType

CapeVerde

»»» mapDisplayType

CaymanIslands

»»» mapDisplayType

CentralAfricanRepublic

»»» mapDisplayType

CentralAmerica

»»» mapDisplayType

CentralAmerica2

»»» mapDisplayType

CentralAmericawithCaribbean

»»» mapDisplayType

CentralEuropeanRegion

»»» mapDisplayType

Chad

»»» mapDisplayType

Chile

»»» mapDisplayType

China

»»» mapDisplayType

China2

»»» mapDisplayType

Colombia

»»» mapDisplayType

Colorado

»»» mapDisplayType

Comoros

»»» mapDisplayType

Congo

»»» mapDisplayType

Connecticut

»»» mapDisplayType

CostaRica

»»» mapDisplayType

CoteDivoire

»»» mapDisplayType

Croatia

»»» mapDisplayType

Cuba

»»» mapDisplayType

Cyprus

»»» mapDisplayType

Cyprus2

»»» mapDisplayType

CzechRepublic

»»» mapDisplayType

Delaware

»»» mapDisplayType

DemocraticRepublicofCongo

»»» mapDisplayType

Denmark

»»» mapDisplayType

DenmarkRegion

»»» mapDisplayType

DistrictofColumbia

»»» mapDisplayType

Djibouti

»»» mapDisplayType

Dominica

»»» mapDisplayType

DominicanRepublic

»»» mapDisplayType

EastEuropeanRegion

»»» mapDisplayType

EastTimor

»»» mapDisplayType

Ecuador

»»» mapDisplayType

Egypt

»»» mapDisplayType

ElSalvador

»»» mapDisplayType

England

»»» mapDisplayType

EnglandRegion

»»» mapDisplayType

EquatorialGuinea

»»» mapDisplayType

Eritrea

»»» mapDisplayType

Estonia

»»» mapDisplayType

Ethiopia

»»» mapDisplayType

Europe

»»» mapDisplayType

Europe2

»»» mapDisplayType

EuropeRegion

»»» mapDisplayType

Europewithcountries

»»» mapDisplayType

FalklandIsland

»»» mapDisplayType

Fiji

»»» mapDisplayType

Finland

»»» mapDisplayType

Florida

»»» mapDisplayType

France

»»» mapDisplayType

FranceDepartment

»»» mapDisplayType

FrenchGuiana

»»» mapDisplayType

Gabon

»»» mapDisplayType

Gambia

»»» mapDisplayType

Georgia

»»» mapDisplayType

Germany

»»» mapDisplayType

Ghana

»»» mapDisplayType

Greece

»»» mapDisplayType

Greenland

»»» mapDisplayType

Grenada

»»» mapDisplayType

Guatemala

»»» mapDisplayType

Guinea

»»» mapDisplayType

GuineaBissau

»»» mapDisplayType

Guyana

»»» mapDisplayType

Haiti

»»» mapDisplayType

Hawaii

»»» mapDisplayType

Honduras

»»» mapDisplayType

HongKong

»»» mapDisplayType

Hungary

»»» mapDisplayType

HungaryRegions

»»» mapDisplayType

Iceland

»»» mapDisplayType

Idaho

»»» mapDisplayType

Illinois

»»» mapDisplayType

India

»»» mapDisplayType

Indiana

»»» mapDisplayType

Indonesia

»»» mapDisplayType

Iowa

»»» mapDisplayType

Iran

»»» mapDisplayType

Iraq

»»» mapDisplayType

Ireland

»»» mapDisplayType

Israel

»»» mapDisplayType

Italy

»»» mapDisplayType

Jamaica

»»» mapDisplayType

Japan

»»» mapDisplayType

Jordan

»»» mapDisplayType

Kansas

»»» mapDisplayType

Kazakhstan

»»» mapDisplayType

Kentucky

»»» mapDisplayType

Kenya

»»» mapDisplayType

Kiribati

»»» mapDisplayType

KosovoDistricts

»»» mapDisplayType

Kuwait

»»» mapDisplayType

Kyrgyzstan

»»» mapDisplayType

Laos

»»» mapDisplayType

Latvia

»»» mapDisplayType

Lebanon

»»» mapDisplayType

Lesotho

»»» mapDisplayType

Liberia

»»» mapDisplayType

Libya

»»» mapDisplayType

Liechtenstein

»»» mapDisplayType

Lithuania

»»» mapDisplayType

Louisiana

»»» mapDisplayType

Luxembourg

»»» mapDisplayType

Macau

»»» mapDisplayType

Macedonia

»»» mapDisplayType

Madagascar

»»» mapDisplayType

MadagascarRegions

»»» mapDisplayType

Maine

»»» mapDisplayType

Malawi

»»» mapDisplayType

Malaysia

»»» mapDisplayType

Mali

»»» mapDisplayType

Malta

»»» mapDisplayType

Manitoba

»»» mapDisplayType

MarshallIsland

»»» mapDisplayType

Maryland

»»» mapDisplayType

Massachusetts

»»» mapDisplayType

Mauritania

»»» mapDisplayType

Mauritius

»»» mapDisplayType

Mexico

»»» mapDisplayType

Michigan

»»» mapDisplayType

Micronesia

»»» mapDisplayType

MiddleEast

»»» mapDisplayType

Minnesota

»»» mapDisplayType

Mississippi

»»» mapDisplayType

Missouri

»»» mapDisplayType

Moldova

»»» mapDisplayType

Monaco

»»» mapDisplayType

Mongolia

»»» mapDisplayType

Montana

»»» mapDisplayType

Montenegro

»»» mapDisplayType

Morocco

»»» mapDisplayType

Mozambique

»»» mapDisplayType

Namibia

»»» mapDisplayType

Nauru

»»» mapDisplayType

Nebraska

»»» mapDisplayType

Nepal

»»» mapDisplayType

Netherlands

»»» mapDisplayType

Nevada

»»» mapDisplayType

NewBrunswick

»»» mapDisplayType

NewCaledonia

»»» mapDisplayType

NewfoundlandandLabrador

»»» mapDisplayType

NewHampshire

»»» mapDisplayType

NewJersey

»»» mapDisplayType

NewMexico

»»» mapDisplayType

NewYork

»»» mapDisplayType

NewZealand

»»» mapDisplayType

Nicaragua

»»» mapDisplayType

Niger

»»» mapDisplayType

Nigeria

»»» mapDisplayType

NorthAmerica

»»» mapDisplayType

NorthAmericaWOCentral

»»» mapDisplayType

NorthCarolina

»»» mapDisplayType

NorthDakota

»»» mapDisplayType

NorthEuropeanRegion

»»» mapDisplayType

NorthernIreland

»»» mapDisplayType

NorthKorea

»»» mapDisplayType

NorthWestTerritories

»»» mapDisplayType

Norway

»»» mapDisplayType

NorwayRegion

»»» mapDisplayType

NovaScotia

»»» mapDisplayType

Nunavut

»»» mapDisplayType

Oceania

»»» mapDisplayType

Ohio

»»» mapDisplayType

Oklahoma

»»» mapDisplayType

Oman

»»» mapDisplayType

Ontario

»»» mapDisplayType

Oregon

»»» mapDisplayType

Pakistan

»»» mapDisplayType

Palau

»»» mapDisplayType

Panama

»»» mapDisplayType

PapuaNewGuinea

»»» mapDisplayType

Paraguay

»»» mapDisplayType

Pennsylvania

»»» mapDisplayType

Peru

»»» mapDisplayType

Philippines

»»» mapDisplayType

Poland

»»» mapDisplayType

PolandCounties

»»» mapDisplayType

Portugal

»»» mapDisplayType

PrinceEdwardIsland

»»» mapDisplayType

PuertoRico

»»» mapDisplayType

Qatar

»»» mapDisplayType

Quebec

»»» mapDisplayType

RhodeIsland

»»» mapDisplayType

Romania

»»» mapDisplayType

Russia

»»» mapDisplayType

Rwanda

»»» mapDisplayType

SaintKittsandNevis

»»» mapDisplayType

SaintLucia

»»» mapDisplayType

SaintVincentandtheGrenadines

»»» mapDisplayType

Samoa

»»» mapDisplayType

SanMarino

»»» mapDisplayType

SaoTomeandPrincipe

»»» mapDisplayType

Saskatchewan

»»» mapDisplayType

SaudiArabia

»»» mapDisplayType

Scotland

»»» mapDisplayType

ScotlandRegion

»»» mapDisplayType

Senegal

»»» mapDisplayType

Serbia

»»» mapDisplayType

SerbiaWoKosovo

»»» mapDisplayType

Seychelles

»»» mapDisplayType

SierraLeone

»»» mapDisplayType

Singapore

»»» mapDisplayType

Slovakia

»»» mapDisplayType

Slovenia

»»» mapDisplayType

SolomonIsland

»»» mapDisplayType

Somalia

»»» mapDisplayType

SouthAfrica

»»» mapDisplayType

SouthAmerica

»»» mapDisplayType

SouthCarolina

»»» mapDisplayType

SouthDakota

»»» mapDisplayType

SouthEuropeanRegion

»»» mapDisplayType

SouthKorea

»»» mapDisplayType

SouthSudan

»»» mapDisplayType

Spain

»»» mapDisplayType

SpainProvinces

»»» mapDisplayType

SriLanka

»»» mapDisplayType

Sudan

»»» mapDisplayType

SudanWoSouthSudan

»»» mapDisplayType

Suriname

»»» mapDisplayType

Swaziland

»»» mapDisplayType

Sweden

»»» mapDisplayType

Switzerland

»»» mapDisplayType

Syria

»»» mapDisplayType

Taiwan

»»» mapDisplayType

Tajikistan

»»» mapDisplayType

Tanzania

»»» mapDisplayType

Tennessee

»»» mapDisplayType

Texas

»»» mapDisplayType

Thailand

»»» mapDisplayType

Tibet

»»» mapDisplayType

Togo

»»» mapDisplayType

Tonga

»»» mapDisplayType

TrinidadandTobago

»»» mapDisplayType

Tunisia

»»» mapDisplayType

Turkey

»»» mapDisplayType

Turkmenistan

»»» mapDisplayType

Tuvalu

»»» mapDisplayType

UAE

»»» mapDisplayType

Uganda

»»» mapDisplayType

UK

»»» mapDisplayType

UK7

»»» mapDisplayType

Ukraine

»»» mapDisplayType

Uruguay

»»» mapDisplayType

USA

»»» mapDisplayType

USACentralRegion

»»» mapDisplayType

USANorthEastRegion

»»» mapDisplayType

USANorthWestRegion

»»» mapDisplayType

USARegion

»»» mapDisplayType

USASouthEastRegion

»»» mapDisplayType

USASouthWestRegion

»»» mapDisplayType

Utah

»»» mapDisplayType

Uzbekistan

»»» mapDisplayType

Vanuatu

»»» mapDisplayType

VaticanCity

»»» mapDisplayType

Venezuela

»»» mapDisplayType

Vermont

»»» mapDisplayType

Vietnam

»»» mapDisplayType

Virginia

»»» mapDisplayType

Wales

»»» mapDisplayType

Washington

»»» mapDisplayType

WesternSahara

»»» mapDisplayType

WestEuropeanRegion

»»» mapDisplayType

WestVirginia

»»» mapDisplayType

Wisconsin

»»» mapDisplayType

World

»»» mapDisplayType

World8

»»» mapDisplayType

World8WithAntarctica

»»» mapDisplayType

WorldWithAntarctica

»»» mapDisplayType

WorldwithCountries

»»» mapDisplayType

Wyoming

»»» mapDisplayType

Yemen

»»» mapDisplayType

YukonTerritory

»»» mapDisplayType

Zambia

»»» mapDisplayType

Zimbabwe

»»» ssChartDisplayType

Area2D

»»» ssChartDisplayType

Bar2D

»»» ssChartDisplayType

Column2D

»»» ssChartDisplayType

Column3D

»»» ssChartDisplayType

Doughnut2D

»»» ssChartDisplayType

Doughnut3D

»»» ssChartDisplayType

Funnel

»»» ssChartDisplayType

Pyramid

»»» ssChartDisplayType

Line

»»» ssChartDisplayType

Pie2D

»»» ssChartDisplayType

Pie3D

»»» ssChartDisplayType

Spline

»»» ssChartDisplayType

SplineArea

»»» ssChartDisplayType

Waterfall2D

»»» ssChartDisplayType

Kagi

»»» msChartDisplayType

MSArea

»»» msChartDisplayType

InverseMSArea

»»» msChartDisplayType

ScrollArea2D

»»» msChartDisplayType

MSBar2D

»»» msChartDisplayType

MSColumn2D

»»» msChartDisplayType

InverseMSColumn2D

»»» msChartDisplayType

ScrollColumn2D

»»» msChartDisplayType

LogMSColumn2D

»»» msChartDisplayType

MSColumn3D

»»» msChartDisplayType

MSLine

»»» msChartDisplayType

InverseMSLine

»»» msChartDisplayType

ScrollLine2D

»»» msChartDisplayType

LogMSLine

»»» msChartDisplayType

StackedArea2D

»»» msChartDisplayType

StackedBar2D

»»» msChartDisplayType

StackedBar3D

»»» msChartDisplayType

StackedColumn2D

»»» msChartDisplayType

ScrollStackedColumn2D

»»» msChartDisplayType

StackedColumn3D

»»» msChartDisplayType

MSSpline

»»» msChartDisplayType

MSSplineArea

»»» msChartDisplayType

Radar

»»» msChartDisplayType

Scatter

»»» msChartDisplayType

Bubble

»»» msChartDisplayType

MSCombi2D

»»» msChartDisplayType

MSCombi3D

»»» msChartDisplayType

MSColumnLine3D

»»» msChartDisplayType

MSCombiDY2D

»»» msChartDisplayType

MSColumn3DLineDY

»»» msChartDisplayType

StackedColumn3DLineDY

»»» gaugeDisplayType

AngularGauge

»»» gaugeDisplayType

Cylinder

»»» gaugeDisplayType

HLinearGauge

»»» status

Available

»»» status

Pending

»»» status

Closed

»»» columns

WorkflowID

»»» columns

WorkflowName

»»» columns

WorkflowDescription

»»» columns

ReportName

»»» columns

WebReportID

»»» columns

ActionName

»»» columns

SubmittedBy

»»» columns

SubmittedByName

»»» columns

DateReceived

»»» columns

TokenID

»»» columns

Initiator

»»» columns

InitiatorName

»»» columns

DateOfInitiation

»»» columns

DateOfCompletion

»» type

AggregateTransformation

»» type

ComputedColumn

»» type

InputRowSource

»» type

QuerySource

»» type

TransposedSource

»» type

StaticScalar

»» type

ValueScalar

»» type

ComputedScalar

»» type

Parameter

»»»» variableType

Literal

»»»» variableType

Parameter

»»»» variableType

Scalar

»» treeNodeType

Folder

»» treeNodeType

Source

»» treeNodeType

ParameterRoot

»» treeNodeType

ScalarRoot

»» treeNodeType

SourceRoot

»» treeNodeType

EditableSourceRoot

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.WebReportDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/webreports/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webreports/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "allowPdfExport": true,
  "showInquiry": true,
  "batchExportDetails": {
    "canBatchExport": true,
    "picklistRefParam": "string"
  },
  "background": {
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "image": {
      "displayBorder": {},
      "displayPadding": {},
      "gridType": "string",
      "hoverText": "string",
      "imageByteArray": "string",
      "imageId": 0,
      "imageLink": {},
      "imageType": "string",
      "imageUrl": "string",
      "expiryDate": "2019-08-24T14:15:22Z",
      "cosObjectName": "string",
      "name": "string",
      "source": {},
      "style": {}
    },
    "imageAttachment": "Scroll",
    "imagePosition": "Absolute",
    "imageTile": "None",
    "webreportId": 0,
    "x": 0,
    "y": 0,
    "opacity": 0
  },
  "defaultStyle": {
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    }
  },
  "directlyAccessible": true,
  "frameLayout": {
    "horizontalAlign": "Left",
    "verticalAlign": "Top",
    "type": "Frame",
    "childHeightPercents": [
      0.1
    ],
    "childWidthPercents": [
      0.1
    ],
    "frames": [
      []
    ],
    "name": "string",
    "numColumns": 0,
    "numRows": 0,
    "display": {
      "gridType": "string",
      "name": "string",
      "source": {},
      "type": "DataGridDisplay",
      "restrictSource": {},
      "restrictColumn": "string",
      "style": {},
      "columnMap": {},
      "computedColumns": [],
      "computedRow": {},
      "dataGridDisplayStyle": {},
      "dataGridInputRules": [],
      "dateFormat": {},
      "defaultPageSize": 0,
      "enableExportToExcel": true,
      "enableInquiryCopy": true,
      "enableShowHideColumns": true,
      "freezeTopRow": true,
      "hiddenColumnAliasMap": {},
      "hiddenColumns": [],
      "hiddenInputRowColumnMap": {},
      "inputRowAtTop": true,
      "isVertical": true,
      "numericStyle": {},
      "paginated": true,
      "sections": [],
      "showOnlyInputRow": true,
      "showSectionHeader": true,
      "sortColumns": [],
      "suppressHeader": true,
      "hideRowBorders": true,
      "disableRowHighlighting": true,
      "suppressRepeatPartitionValues": true,
      "timeId": "string",
      "validationRules": [],
      "selectedTemplateId": 0,
      "columnWidths": [],
      "displays": [],
      "fixedGridDisplayStyle": {},
      "imageType": "string",
      "imageLink": {},
      "imageId": 0,
      "imageByteArray": "string",
      "hoverText": "string",
      "imageUrl": "string",
      "expiryDate": "2019-08-24T14:15:22Z",
      "cosObjectName": "string",
      "controlDisplayStyle": {},
      "sortById": true,
      "sortAscending": true,
      "refParameter": "string",
      "nameColumn": "string",
      "idColumn": "string",
      "hideValueForExport": true,
      "hideIdValues": true,
      "scalarDisplayStyle": {},
      "scalarLink": {},
      "text": "string",
      "documentId": 0,
      "buttonDisplayStyle": {},
      "cellStyle": {},
      "agreementText": "string",
      "format": {},
      "conditionalFormatRule": {},
      "dateDisplayMode": "ShortDate",
      "xAxisName": "string",
      "yAxisName": "string",
      "numberPrefix": "string",
      "numberSuffix": "string",
      "labelOrientation": "Horizontal",
      "hideValues": true,
      "decimalSeparator": "string",
      "thousandSeparator": "string",
      "isPercentage": "string",
      "numDecimals": "string",
      "numberScaling": "string",
      "showTitle": true,
      "yMinMax": true,
      "zMinMax": true,
      "yMin": "string",
      "yMax": "string",
      "zMin": "string",
      "zMax": "string",
      "dontTrimBarLabel": "string",
      "defaultLink": {},
      "entityLinkMap": {},
      "fusionSource": {},
      "fusionStyles": {},
      "fusionTheme": "Classic",
      "height": 0,
      "legendPosition": "Bottom",
      "mapDisplayType": "Afghanistan",
      "mapValueRanges": [],
      "showLegend": true,
      "width": 0,
      "ssChartDisplayType": "Area2D",
      "chartLink": {},
      "customColors": [],
      "msChartDisplayType": "MSArea",
      "syAxisName": "string",
      "syNumberPrefix": "string",
      "syNumberSuffix": "string",
      "hideSyValues": true,
      "centerValues": true,
      "syDecimalSeparator": "string",
      "syThousandSeparator": "string",
      "isSyPercentage": "string",
      "syNumDecimals": "string",
      "syNumberScaling": "string",
      "lowerLimitDisplayName": "string",
      "upperLimitDisplayName": "string",
      "valueToolTip": "string",
      "gaugeDisplayType": "AngularGauge",
      "link": {},
      "limitLabelFillColor": "string",
      "gaugeValueRanges": [],
      "trendpoint": {},
      "gaugeStartAngle": 0.1,
      "gaugeEndAngle": 0.1,
      "fillColor": {},
      "status": "Available",
      "enableHeaders": true,
      "workflowLinkDisplayStyle": {},
      "columns": []
    }
  },
  "isLayoutLocked": true,
  "name": "string",
  "pdfOptions": {
    "autoScale": true,
    "customScaleValue": 0.1,
    "footerText": "string",
    "includePageNumber": true,
    "portraitOrientation": true,
    "showTotalPageNumber": true,
    "tableViewportWidth": 0.1
  },
  "sources": [
    {
      "dependencies": [],
      "name": "string",
      "type": "AggregateTransformation",
      "scalarType": "string",
      "value": null,
      "column": "string",
      "keyValues": {},
      "table": "string",
      "expression": "string",
      "variables": [],
      "required": true,
      "useWebUser": true,
      "isParameterValueScalar": true,
      "parameterValue": {},
      "parameterId": 0,
      "columnNames": [],
      "source": {},
      "formula": "string",
      "partitionColumns": [],
      "timeEnd": "2019-08-24T14:15:22Z",
      "timeFrequency": {},
      "timePartition": "string",
      "timeStart": "2019-08-24T14:15:22Z",
      "newColumnName": "string",
      "keyColumns": [],
      "newColumns": [],
      "transposeColumn": "string"
    }
  ],
  "trees": [
    {
      "name": "string",
      "parent": "string",
      "parentNodeType": "string",
      "treeNodeType": "Folder"
    }
  ],
  "version": {
    "rowVersion": 0
  },
  "webReportId": 0,
  "workflowObjectId": 0,
  "element": {},
  "styleCategory": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webreports/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/webreports/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/webreports/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

WebReportsControllerV1_Put

Body parameter

{
  "allowPdfExport": true,
  "showInquiry": true,
  "batchExportDetails": {
    "canBatchExport": true,
    "picklistRefParam": "string"
  },
  "background": {
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "image": {
      "displayBorder": {},
      "displayPadding": {},
      "gridType": "string",
      "hoverText": "string",
      "imageByteArray": "string",
      "imageId": 0,
      "imageLink": {},
      "imageType": "string",
      "imageUrl": "string",
      "expiryDate": "2019-08-24T14:15:22Z",
      "cosObjectName": "string",
      "name": "string",
      "source": {},
      "style": {}
    },
    "imageAttachment": "Scroll",
    "imagePosition": "Absolute",
    "imageTile": "None",
    "webreportId": 0,
    "x": 0,
    "y": 0,
    "opacity": 0
  },
  "defaultStyle": {
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    }
  },
  "directlyAccessible": true,
  "frameLayout": {
    "horizontalAlign": "Left",
    "verticalAlign": "Top",
    "type": "Frame",
    "childHeightPercents": [
      0.1
    ],
    "childWidthPercents": [
      0.1
    ],
    "frames": [
      []
    ],
    "name": "string",
    "numColumns": 0,
    "numRows": 0,
    "display": {
      "gridType": "string",
      "name": "string",
      "source": {},
      "type": "DataGridDisplay",
      "restrictSource": {},
      "restrictColumn": "string",
      "style": {},
      "columnMap": {},
      "computedColumns": [],
      "computedRow": {},
      "dataGridDisplayStyle": {},
      "dataGridInputRules": [],
      "dateFormat": {},
      "defaultPageSize": 0,
      "enableExportToExcel": true,
      "enableInquiryCopy": true,
      "enableShowHideColumns": true,
      "freezeTopRow": true,
      "hiddenColumnAliasMap": {},
      "hiddenColumns": [],
      "hiddenInputRowColumnMap": {},
      "inputRowAtTop": true,
      "isVertical": true,
      "numericStyle": {},
      "paginated": true,
      "sections": [],
      "showOnlyInputRow": true,
      "showSectionHeader": true,
      "sortColumns": [],
      "suppressHeader": true,
      "hideRowBorders": true,
      "disableRowHighlighting": true,
      "suppressRepeatPartitionValues": true,
      "timeId": "string",
      "validationRules": [],
      "selectedTemplateId": 0,
      "columnWidths": [],
      "displays": [],
      "fixedGridDisplayStyle": {},
      "imageType": "string",
      "imageLink": {},
      "imageId": 0,
      "imageByteArray": "string",
      "hoverText": "string",
      "imageUrl": "string",
      "expiryDate": "2019-08-24T14:15:22Z",
      "cosObjectName": "string",
      "controlDisplayStyle": {},
      "sortById": true,
      "sortAscending": true,
      "refParameter": "string",
      "nameColumn": "string",
      "idColumn": "string",
      "hideValueForExport": true,
      "hideIdValues": true,
      "scalarDisplayStyle": {},
      "scalarLink": {},
      "text": "string",
      "documentId": 0,
      "buttonDisplayStyle": {},
      "cellStyle": {},
      "agreementText": "string",
      "format": {},
      "conditionalFormatRule": {},
      "dateDisplayMode": "ShortDate",
      "xAxisName": "string",
      "yAxisName": "string",
      "numberPrefix": "string",
      "numberSuffix": "string",
      "labelOrientation": "Horizontal",
      "hideValues": true,
      "decimalSeparator": "string",
      "thousandSeparator": "string",
      "isPercentage": "string",
      "numDecimals": "string",
      "numberScaling": "string",
      "showTitle": true,
      "yMinMax": true,
      "zMinMax": true,
      "yMin": "string",
      "yMax": "string",
      "zMin": "string",
      "zMax": "string",
      "dontTrimBarLabel": "string",
      "defaultLink": {},
      "entityLinkMap": {},
      "fusionSource": {},
      "fusionStyles": {},
      "fusionTheme": "Classic",
      "height": 0,
      "legendPosition": "Bottom",
      "mapDisplayType": "Afghanistan",
      "mapValueRanges": [],
      "showLegend": true,
      "width": 0,
      "ssChartDisplayType": "Area2D",
      "chartLink": {},
      "customColors": [],
      "msChartDisplayType": "MSArea",
      "syAxisName": "string",
      "syNumberPrefix": "string",
      "syNumberSuffix": "string",
      "hideSyValues": true,
      "centerValues": true,
      "syDecimalSeparator": "string",
      "syThousandSeparator": "string",
      "isSyPercentage": "string",
      "syNumDecimals": "string",
      "syNumberScaling": "string",
      "lowerLimitDisplayName": "string",
      "upperLimitDisplayName": "string",
      "valueToolTip": "string",
      "gaugeDisplayType": "AngularGauge",
      "link": {},
      "limitLabelFillColor": "string",
      "gaugeValueRanges": [],
      "trendpoint": {},
      "gaugeStartAngle": 0.1,
      "gaugeEndAngle": 0.1,
      "fillColor": {},
      "status": "Available",
      "enableHeaders": true,
      "workflowLinkDisplayStyle": {},
      "columns": []
    }
  },
  "isLayoutLocked": true,
  "name": "string",
  "pdfOptions": {
    "autoScale": true,
    "customScaleValue": 0.1,
    "footerText": "string",
    "includePageNumber": true,
    "portraitOrientation": true,
    "showTotalPageNumber": true,
    "tableViewportWidth": 0.1
  },
  "sources": [
    {
      "dependencies": [],
      "name": "string",
      "type": "AggregateTransformation",
      "scalarType": "string",
      "value": null,
      "column": "string",
      "keyValues": {},
      "table": "string",
      "expression": "string",
      "variables": [],
      "required": true,
      "useWebUser": true,
      "isParameterValueScalar": true,
      "parameterValue": {},
      "parameterId": 0,
      "columnNames": [],
      "source": {},
      "formula": "string",
      "partitionColumns": [],
      "timeEnd": "2019-08-24T14:15:22Z",
      "timeFrequency": {},
      "timePartition": "string",
      "timeStart": "2019-08-24T14:15:22Z",
      "newColumnName": "string",
      "keyColumns": [],
      "newColumns": [],
      "transposeColumn": "string"
    }
  ],
  "trees": [
    {
      "name": "string",
      "parent": "string",
      "parentNodeType": "string",
      "treeNodeType": "Folder"
    }
  ],
  "version": {
    "rowVersion": 0
  },
  "webReportId": 0,
  "workflowObjectId": 0,
  "element": {},
  "styleCategory": "string"
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.WebReportDTO

false

none

» allowPdfExport

body

boolean

false

none

» showInquiry

body

boolean

false

none

» batchExportDetails

body

Varicent.RESTAPI.v1.DTOs.WebReportBatchExportDetailsDTO

false

none

»» canBatchExport

body

boolean

false

none

»» picklistRefParam

body

string¦null

false

none

» background

body

Varicent.RESTAPI.v1.DTOs.BackgroundDisplayDTO

false

none

»» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»» a

body

integer(int32)

false

none

»»» b

body

integer(int32)

false

none

»»» g

body

integer(int32)

false

none

»»» r

body

integer(int32)

false

none

»» image

body

Varicent.RESTAPI.v1.DTOs.ImageDisplayDTO

false

none

»»» displayBorder

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»» bottom

body

Varicent.RESTAPI.v1.DTOs.BorderDTO

false

none

»»»»» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»»»» width

body

number(float)

false

none

»»»» left

body

Varicent.RESTAPI.v1.DTOs.BorderDTO

false

none

»»»» right

body

Varicent.RESTAPI.v1.DTOs.BorderDTO

false

none

»»»» top

body

Varicent.RESTAPI.v1.DTOs.BorderDTO

false

none

»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»»» bottom

body

number(float)

false

none

»»»» left

body

number(float)

false

none

»»»» right

body

number(float)

false

none

»»»» top

body

number(float)

false

none

»»» gridType

body

string¦null

false

none

»»» hoverText

body

string¦null

false

none

»»» imageByteArray

body

string(byte)¦null

false

none

»»» imageId

body

integer(int32)

false

none

»»» imageLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»» document

body

string¦null

false

none

»»»» openInNewWindow

body

boolean

false

none

»»»» parameters

body

object¦null

false

none

»»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.LinkParameterValueDTO

false

none

»»»»»» dataType

body

string

false

none

»»»»»» source

body

string¦null

false

none

»»»»»» type

body

string

false

none

»»»»»» value

body

string¦null

false

none

»»»» reportId

body

integer(int32)¦null

false

none

»»»» targetId

body

integer(int32)

false

none

»»»» targetType

body

string

false

none

»»»» webFormId

body

integer(int32)¦null

false

none

»»»» webTabId

body

integer(int32)¦null

false

none

»»» imageType

body

string¦null

false

none

»»» imageUrl

body

string¦null

false

none

»»» expiryDate

body

string(date-time)¦null

false

none

»»» cosObjectName

body

string¦null

false

none

»»» name

body

string¦null

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DisplaySourceDTO

false

none

»»»» name

body

string¦null

false

none

»»» style

body

Varicent.RESTAPI.v1.DTOs.DataDisplayStyleDTO

false

none

»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»» imageAttachment

body

string

false

none

»» imagePosition

body

string

false

none

»» imageTile

body

string

false

none

»» webreportId

body

integer(int32)

false

none

»» x

body

integer(int32)

false

none

»» y

body

integer(int32)

false

none

»» opacity

body

integer(int32)

false

none

» defaultStyle

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»» font

body

Varicent.RESTAPI.v1.DTOs.FontDefinitionDTO

false

none

»»» family

body

string¦null

false

none

»»» size

body

number(float)

false

none

»»» unit

body

string¦null

false

none

»»» bold

body

boolean

false

none

»»» italic

body

boolean

false

none

»»» underline

body

boolean

false

none

»»» strikeout

body

boolean

false

none

» directlyAccessible

body

boolean

false

none

» frameLayout

body

Varicent.RESTAPI.v1.DTOs.FrameableDTO

false

none

»» horizontalAlign

body

string

false

none

»» verticalAlign

body

string

false

none

»» type

body

string

false

none

»» childHeightPercents

body

[number]¦null

false

none

»» childWidthPercents

body

[number]¦null

false

none

»» frames

body

[array]¦null

false

none

»»» anonymous

body

any

false

none

»» name

body

string¦null

false

none

»» numColumns

body

integer(int32)

false

none

»» numRows

body

integer(int32)

false

none

»» display

body

Varicent.RESTAPI.v1.DTOs.DataDisplayDTO

false

none

»»» gridType

body

string¦null

false

none

»»» name

body

string¦null

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DisplaySourceDTO

false

none

»»» type

body

string

false

none

»»» restrictSource

body

Varicent.RESTAPI.v1.DTOs.DisplaySourceDTO

false

none

»»» restrictColumn

body

string¦null

false

none

»»» style

body

Varicent.RESTAPI.v1.DTOs.DataDisplayStyleDTO

false

none

»»» columnMap

body

object¦null

false

none

»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.DataGridSourceColumnDTO

false

none

»»»»» displayName

body

Varicent.RESTAPI.v1.DTOs.DataGridColumnDisplayNameDTO

false

none

»»»»»» displayName

body

string¦null

false

none

»»»»» dateFormat

body

Varicent.RESTAPI.v1.DTOs.PRDateFormatDTO

false

none

»»»»»» style

body

string

false

none

»»»»» pickListFilter

body

Varicent.RESTAPI.v1.DTOs.DataGridPicklistFilterDTO

false

none

»»»»»» name

body

string¦null

false

none

»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»»»»»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»»»»»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»»»»»»» alias

body

string¦null

false

none

»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»» customSelect

body

string¦null

false

none

»»»»»»»»» dataType

body

string

false

none

»»»»»»»»» type

body

string

false

none

»»»»»»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»»»»»» constraintType

body

string

false

none

»»»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»»»» condition

body

any

false

none

»»»»»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»»»»»» literalType

body

string

false

none

»»»»»»»»»»»»» value

body

any

false

none

»»»»»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»»»»»» constraints

body

array¦null

false

none

»»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»»» literalRight

body

any

false

none

»»»»»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»»»» right

body

any

false

none

»»»»»»»»»»»» expressionLeft

body

any

false

none

»»»»»»»»»»»» expressionRight

body

any

false

none

»»»»»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»»»»»» like

body

string¦null

false

none

»»»»»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»»»» literalType

body

string

false

none

»»»»»»»»»»» value

body

any

false

none

»»»»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»»» literalType

body

string

false

none

»»»»»»»»»» value

body

any

false

none

»»»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»»»»»»» m_namespace

body

string¦null

false

none

»»»»»»»»»» name

body

string¦null

false

none

»»»»»»»»» query

body

any

false

none

»»»»»»»»» alias

body

string¦null

false

none

»»»»»»»»» sourceType

body

string

false

none

»»»»»»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»»»»» joinType

body

string

false

none

»»»»»»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»»»»»» constraintType

body

string

false

none

»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»»»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»»»» like

body

string¦null

false

none

»»»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»» direction

body

string

false

none

»»»»»»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»» column

body

string¦null

false

none

»»»»»»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»»»» distinct

body

boolean

false

none

»»»»»»»» unionWith

body

any

false

none

»»»»»»»» exceptWith

body

any

false

none

»»»»»»» sourceNames

body

object¦null

false

none

»»»»»»»» additionalProperties

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»» defaultValue

body

string¦null

false

none

»»»»» referencedFrequency

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»»»»» levelId

body

string¦null

false

none

»»»»»» timeId

body

string¦null

false

none

»»»»» isEditable

body

boolean

false

none

»»»»» picklistDisplayOptions

body

Varicent.RESTAPI.v1.DTOs.InputRowPicklistOptionsDTO

false

none

»»»»»» description

body

string¦null

false

none

»»»»»» order

body

string

false

none

»»»»»» hideKey

body

boolean

false

none

»»»»»» hideDescription

body

boolean

false

none

»»»»»» sortById

body

boolean

false

none

»»»»» order

body

integer(int32)

false

none

»»»»» headerStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»»» alignment

body

string

false

none

»»»»»» backColor

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»»»»» font

body

Varicent.RESTAPI.v1.DTOs.FontDefinitionDTO

false

none

»»»»»» foreColor

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»»»» formatRule

body

Varicent.RESTAPI.v1.DTOs.ConditionalFormatRuleDTO

false

none

»»»»»» formats

body

[Varicent.RESTAPI.v1.DTOs.ConditionalFormatDTO]¦null

false

none

»»»»»»» formula

body

string¦null

false

none

»»»»»»» numericFormat

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»»»»»»» scale

body

integer(int32)

false

none

»»»»»»»» style

body

string

false

none

»»»»»»» style

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» columnLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»»» numericFormat

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»»»» width

body

number(double)

false

none

»»»»» initiallyShow

body

boolean

false

none

»»»»» useRowTextAlignment

body

boolean

false

none

»»»»» wrapText

body

boolean

false

none

»»»»» maxWidth

body

integer(int32)

false

none

»»»»» verticalAlignment

body

string

false

none

»»» computedColumns

body

[Varicent.RESTAPI.v1.DTOs.DataGridComputedColumnDTO]¦null

false

none

»»»» name

body

string¦null

false

none

»»»» formula

body

string¦null

false

none

»»»» order

body

integer(int32)

false

none

»»»» headerStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»» formatRule

body

Varicent.RESTAPI.v1.DTOs.ConditionalFormatRuleDTO

false

none

»»»» columnLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»» numericFormat

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»»» width

body

number(double)

false

none

»»»» initiallyShow

body

boolean

false

none

»»»» useRowTextAlignment

body

boolean

false

none

»»»» wrapText

body

boolean

false

none

»»»» maxWidth

body

integer(int32)

false

none

»»»» verticalAlignment

body

string

false

none

»»» computedRow

body

object¦null

false

none

»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.DataGridComputedRowCellDTO

false

none

»»»»» columnDisplayName

body

string¦null

false

none

»»»»» cellValue

body

string¦null

false

none

»»»»» valueType

body

string

false

none

»»»»» numericFormat

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»» dataGridDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.DataGridDisplayStyleDTO

false

none

»»»» headerStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»» evenRowStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»» oddRowStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»» allowAlternateRowFont

body

boolean

false

none

»»»» isHeaderVerticalAlignmentBottom

body

boolean

false

none

»»»» computedRowStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»» borderWidth

body

integer(int32)

false

none

»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»» dataGridInputRules

body

[Varicent.RESTAPI.v1.DTOs.DataGridInputRuleDTO]¦null

false

none

»»»» id

body

integer(int32)

false

none

»»»» dataGrid

body

string¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» operatorType

body

string

false

none

»»»» valueType

body

string

false

none

»»»» value

body

any

false

none

»»» dateFormat

body

Varicent.RESTAPI.v1.DTOs.PRDateFormatDTO

false

none

»»» defaultPageSize

body

integer(int32)¦null

false

none

»»» enableExportToExcel

body

boolean¦null

false

none

»»» enableInquiryCopy

body

boolean¦null

false

none

»»» enableShowHideColumns

body

boolean¦null

false

none

»»» freezeTopRow

body

boolean¦null

false

none

»»» hiddenColumnAliasMap

body

object¦null

false

none

»»»» additionalProperties

body

string¦null

false

none

»»» hiddenColumns

body

[Varicent.RESTAPI.v1.DTOs.DataGridHiddenColumnDTO]¦null

false

none

»»»» order

body

integer(int32)

false

none

»»»» name

body

string¦null

false

none

»»»» type

body

string¦null

false

none

»»» hiddenInputRowColumnMap

body

object¦null

false

none

»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.DataGridSourceColumnDTO

false

none

»»» inputRowAtTop

body

boolean¦null

false

none

»»» isVertical

body

boolean¦null

false

none

»»» numericStyle

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»» paginated

body

boolean¦null

false

none

»»» sections

body

[Varicent.RESTAPI.v1.DTOs.SectionDisplayDTO]¦null

false

none

»»»» name

body

string¦null

false

none

»»»» frequency

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»»» sources

body

[Varicent.RESTAPI.v1.DTOs.SourceInfoDTO]¦null

false

none

»»»»» columnMapping

body

object¦null

false

none

»»»»»» additionalProperties

body

string¦null

false

none

»»»»» valueColumn

body

string¦null

false

none

»»»»» sourceName

body

string¦null

false

none

»»»»» sectionStyle

body

Varicent.RESTAPI.v1.DTOs.ScalarDisplayStyleDTO

false

none

»»»»»» style

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»»»» format

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»»»» dateFormat

body

Varicent.RESTAPI.v1.DTOs.PRDateFormatDTO

false

none

»»»» sectionDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.ScalarDisplayStyleDTO

false

none

»»» showOnlyInputRow

body

boolean¦null

false

none

»»» showSectionHeader

body

boolean¦null

false

none

»»» sortColumns

body

[Varicent.RESTAPI.v1.DTOs.DataGridSortColumnDTO]¦null

false

none

»»»» column

body

string¦null

false

none

»»»» sortDescending

body

boolean

false

none

»»»» columnFrequency

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»» suppressHeader

body

boolean¦null

false

none

»»» hideRowBorders

body

boolean¦null

false

none

»»» disableRowHighlighting

body

boolean¦null

false

none

»»» suppressRepeatPartitionValues

body

boolean¦null

false

none

»»» timeId

body

string¦null

false

none

»»» validationRules

body

[Varicent.RESTAPI.v1.DTOs.WebReportValidationRuleDTO]¦null

false

none

»»»» formula

body

string¦null

false

none

»»»» errorMessage

body

string¦null

false

none

»»» selectedTemplateId

body

integer(int32)¦null

false

none

»»» columnWidths

body

[number]¦null

false

none

»»» displays

body

[array]¦null

false

none

»»»» anonymous

body

any

false

none

»»» fixedGridDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.FixedGridDisplayStyleDTO

false

none

»»»» rowStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»» borderWidth

body

integer(int32)

false

none

»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»» imageType

body

string¦null

false

none

»»» imageLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»» imageId

body

integer(int32)¦null

false

none

»»» imageByteArray

body

string(byte)¦null

false

none

»»» hoverText

body

string¦null

false

none

»»» imageUrl

body

string¦null

false

none

»»» expiryDate

body

string(date-time)¦null

false

none

»»» cosObjectName

body

string¦null

false

none

»»» controlDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.ControlDisplayStyleDTO

false

none

»»»» style

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»» sortById

body

boolean¦null

false

none

»»» sortAscending

body

boolean¦null

false

none

»»» refParameter

body

string¦null

false

none

»»» nameColumn

body

string¦null

false

none

»»» idColumn

body

string¦null

false

none

»»» hideValueForExport

body

boolean¦null

false

none

»»» hideIdValues

body

boolean¦null

false

none

»»» scalarDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.ScalarDisplayStyleDTO

false

none

»»» scalarLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»» text

body

string¦null

false

none

»»» documentId

body

integer(int32)¦null

false

none

»»» buttonDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.ButtonDisplayStyleDTO

false

none

»»»» style

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»» cellStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»» agreementText

body

string¦null

false

none

»»» format

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»» conditionalFormatRule

body

Varicent.RESTAPI.v1.DTOs.ConditionalFormatRuleDTO

false

none

»»» dateDisplayMode

body

string¦null

false

none

»»» xAxisName

body

string¦null

false

none

»»» yAxisName

body

string¦null

false

none

»»» numberPrefix

body

string¦null

false

none

»»» numberSuffix

body

string¦null

false

none

»»» labelOrientation

body

string¦null

false

none

»»» hideValues

body

boolean¦null

false

none

»»» decimalSeparator

body

string¦null

false

none

»»» thousandSeparator

body

string¦null

false

none

»»» isPercentage

body

string¦null

false

none

»»» numDecimals

body

string¦null

false

none

»»» numberScaling

body

string¦null

false

none

»»» showTitle

body

boolean¦null

false

none

»»» yMinMax

body

boolean¦null

false

none

»»» zMinMax

body

boolean¦null

false

none

»»» yMin

body

string¦null

false

none

»»» yMax

body

string¦null

false

none

»»» zMin

body

string¦null

false

none

»»» zMax

body

string¦null

false

none

»»» dontTrimBarLabel

body

string¦null

false

none

»»» defaultLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»» entityLinkMap

body

object¦null

false

none

»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»» fusionSource

body

Varicent.RESTAPI.v1.DTOs.FusionSourceDTO

false

none

»»»» type

body

string

false

none

»»»» sorted

body

boolean

false

none

»»»» descending

body

boolean

false

none

»»»» sortedByName

body

boolean

false

none

»»»» sourceName

body

string¦null

false

none

»»»» chartLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»» displayColumn

body

string¦null

false

none

»»»» valueColumn

body

string¦null

false

none

»»»» sourceAlias

body

string¦null

false

none

»»»» sortingInfo

body

Varicent.RESTAPI.v1.DTOs.SortingInfoDTO

false

none

»»»»» levelId

body

string¦null

false

none

»»»»» sortDescending

body

boolean

false

none

»»»»» timeId

body

string¦null

false

none

»»»»» sortedByName

body

boolean

false

none

»»»» xColumn

body

string¦null

false

none

»»»» yColumn

body

string¦null

false

none

»»»» zColumn

body

string¦null

false

none

»»»» renderAs

body

string¦null

false

none

»»»» isPrimaryAxis

body

boolean¦null

false

none

»»»» entityColumn

body

string¦null

false

none

»»»» sources

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» minValueSourceName

body

string¦null

false

none

»»»» maxValueSourceName

body

string¦null

false

none

»»»» currentValueSourceName

body

string¦null

false

none

»»»» trendpointValueSourceName

body

string¦null

false

none

»»» fusionStyles

body

Varicent.RESTAPI.v1.DTOs.FusionStyleSetDTO

false

none

»»»» type

body

string

false

none

»»»» title

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»» xAxisName

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»» yAxisName

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»» xAxisValues

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»» yAxisValues

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»» legend

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»» syAxisName

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»» syAxisValues

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»» labels

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»» tickValues

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»» pointerOrFill

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»» fusionTheme

body

string¦null

false

none

»»» height

body

integer(int32)¦null

false

none

»»» legendPosition

body

string¦null

false

none

»»» mapDisplayType

body

string¦null

false

none

»»» mapValueRanges

body

[Varicent.RESTAPI.v1.DTOs.ColorValueRangeDTO]¦null

false

none

»»»» label

body

string¦null

false

none

»»»» min

body

number(double)

false

none

»»»» max

body

number(double)

false

none

»»»» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»» showLegend

body

boolean¦null

false

none

»»» width

body

integer(int32)¦null

false

none

»»» ssChartDisplayType

body

string¦null

false

none

»»» chartLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»» customColors

body

[Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO]¦null

false

none

»»» msChartDisplayType

body

string¦null

false

none

»»» syAxisName

body

string¦null

false

none

»»» syNumberPrefix

body

string¦null

false

none

»»» syNumberSuffix

body

string¦null

false

none

»»» hideSyValues

body

boolean¦null

false

none

»»» centerValues

body

boolean¦null

false

none

»»» syDecimalSeparator

body

string¦null

false

none

»»» syThousandSeparator

body

string¦null

false

none

»»» isSyPercentage

body

string¦null

false

none

»»» syNumDecimals

body

string¦null

false

none

»»» syNumberScaling

body

string¦null

false

none

»»» lowerLimitDisplayName

body

string¦null

false

none

»»» upperLimitDisplayName

body

string¦null

false

none

»»» valueToolTip

body

string¦null

false

none

»»» gaugeDisplayType

body

string¦null

false

none

»»» link

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»» limitLabelFillColor

body

string¦null

false

none

»»» gaugeValueRanges

body

[Varicent.RESTAPI.v1.DTOs.ColorValueRangeDTO]¦null

false

none

»»» trendpoint

body

Varicent.RESTAPI.v1.DTOs.TrendpointDTO

false

none

»»»» label

body

string¦null

false

none

»»»» labelStyle

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»» gaugeStartAngle

body

number(double)¦null

false

none

»»» gaugeEndAngle

body

number(double)¦null

false

none

»»» fillColor

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»» status

body

string¦null

false

none

»»» enableHeaders

body

boolean¦null

false

none

»»» workflowLinkDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.WorkflowLinkDisplayStyleDTO

false

none

»»»» headerStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»» primaryStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»» secondaryStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»» columns

body

[string]¦null

false

none

» isLayoutLocked

body

boolean

false

none

» name

body

string¦null

false

none

» pdfOptions

body

Varicent.RESTAPI.v1.DTOs.WebReportPdfOptionsDTO

false

none

»» autoScale

body

boolean

false

none

»» customScaleValue

body

number(double)

false

none

»» footerText

body

string¦null

false

none

»» includePageNumber

body

boolean

false

none

»» portraitOrientation

body

boolean

false

none

»» showTotalPageNumber

body

boolean

false

none

»» tableViewportWidth

body

number(double)¦null

false

none

» sources

body

[Varicent.RESTAPI.v1.DTOs.ReportSourceDTO]¦null

false

none

»» dependencies

body

[string]¦null

false

none

»» name

body

string¦null

false

none

»» type

body

string

false

none

»» scalarType

body

string¦null

false

none

»» value

body

any

false

none

»» column

body

string¦null

false

none

»» keyValues

body

object¦null

false

none

»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.ReportVariableDTO

false

none

»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» variableName

body

string¦null

false

none

»»»» variableType

body

string

false

none

»» table

body

string¦null

false

none

»» expression

body

string¦null

false

none

»» variables

body

[string]¦null

false

none

»» required

body

boolean

false

none

»» useWebUser

body

boolean

false

none

»» isParameterValueScalar

body

boolean

false

none

»» parameterValue

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»» parameterId

body

integer(int32)

false

none

»» columnNames

body

[string]¦null

false

none

»» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»» formula

body

string¦null

false

none

»» partitionColumns

body

[string]¦null

false

none

»» timeEnd

body

string(date-time)

false

none

»» timeFrequency

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»» timePartition

body

string¦null

false

none

»» timeStart

body

string(date-time)

false

none

»» newColumnName

body

string¦null

false

none

»» keyColumns

body

[string]¦null

false

none

»» newColumns

body

[string]¦null

false

none

»» transposeColumn

body

string¦null

false

none

» trees

body

[Varicent.RESTAPI.v1.DTOs.ReportTreeNodeDTO]¦null

false

none

»» name

body

string¦null

false

none

»» parent

body

string¦null

false

none

»» parentNodeType

body

string¦null

false

none

»» treeNodeType

body

string

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

» webReportId

body

integer(int32)

false

none

» workflowObjectId

body

integer(int32)

false

none

» element

body

Varicent.RESTAPI.v1.DTOs.IExpandableResourceDTO

false

none

» styleCategory

body

string¦null

false

none

Enumerated Values

Parameter

Value

»»»»»» dataType

Report

»»»»»» dataType

Form

»»»»»» dataType

String

»»»»»» dataType

DateTime

»»»»»» dataType

Decimal

»»»»»» dataType

Integer

»»»»»» type

Scalar

»»»»»» type

RowValue

»»»»»» type

Constant

»»»» targetType

WebReport

»»»» targetType

WebForm

»»»» targetType

URL

»» imageAttachment

Scroll

»» imageAttachment

Fixed

»» imagePosition

Absolute

»» imagePosition

Percent

»» imagePosition

LeftTop

»» imagePosition

LeftCenter

»» imagePosition

LeftBottom

»» imagePosition

RightTop

»» imagePosition

RightCenter

»» imagePosition

RightBottom

»» imagePosition

CenterTop

»» imagePosition

CenterCenter

»» imagePosition

CenterBottom

»» imageTile

None

»» imageTile

Vertical

»» imageTile

Horizontal

»» imageTile

Both

»» horizontalAlign

Left

»» horizontalAlign

Middle

»» horizontalAlign

Right

»» verticalAlign

Top

»» verticalAlign

Middle

»» verticalAlign

Bottom

»» type

Frame

»» type

Content

»»» type

DataGridDisplay

»»» type

FixedGridDisplay

»»» type

ImageDisplay

»»» type

MapDisplay

»»» type

MultiSeriesChartDisplay

»»» type

PickListControl

»»» type

QuickTextDisplay

»»» type

DocumentLinkDisplay

»»» type

SingleSeriesChartDisplay

»»» type

SubmitButtonDisplay

»»» type

TextControl

»»» type

SignatureControl

»»» type

TextScalarDisplay

»»» type

NumericScalarDisplay

»»» type

DateScalarDisplay

»»» type

CylinderGaugeDisplay

»»» type

HLinearGaugeDisplay

»»» type

AngularGaugeDisplay

»»» type

WorkflowLinkControl

»»»»»» style

Date

»»»»»» style

DateTime

»»»»»»»»» dataType

Int

»»»»»»»»» dataType

Decimal

»»»»»»»»» dataType

DateTime

»»»»»»»»» dataType

None

»»»»»»»»» dataType

String

»»»»»»»»» type

SelectAll

»»»»»»»»» type

SelectItem

»»»»»»»»» type

SelectLiteral

»»»»»»»»» type

SelectCustom

»»»»»»»»» type

SelectExpression

»»»»»»»»»» expressionType

caseExpression

»»»»»»»»»» expressionType

dataField

»»»»»»»»»» expressionType

function

»»»»»»»»»» expressionType

ifExpression

»»»»»»»»»» expressionType

literal

»»»»»»»»»»» expressionType

caseExpression

»»»»»»»»»»» expressionType

dataField

»»»»»»»»»»» expressionType

function

»»»»»»»»»»» expressionType

ifExpression

»»»»»»»»»»» expressionType

literal

»»»»»»»»»»»» constraintType

clause

»»»»»»»»»»»» constraintType

constraint

»»»»»»»»»»»» constraintType

expressionConstraint

»»»»»»»»»»»» constraintType

likeConstraint

»»»»»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»»»»»» constraintType

subQueryConstraint

»»»»»»»»»»»»» expressionType

caseExpression

»»»»»»»»»»»»» expressionType

dataField

»»»»»»»»»»»»» expressionType

function

»»»»»»»»»»»»» expressionType

ifExpression

»»»»»»»»»»»»» expressionType

literal

»»»»»»»»»»»»» literalType

Integer

»»»»»»»»»»»»» literalType

Decimal

»»»»»»»»»»»»» literalType

Date

»»»»»»»»»»»»» literalType

DateTime

»»»»»»»»»»»»» literalType

String

»»»»»»»»»»»»» literalType

Float

»»»»»»»»»»»»» literalType

Long

»»»»»»»»»»»»» literalType

Null

»»»»»»»»»»»»» literalType

Parameter

»»»»»»»»»»»»» literalType

Guid

»»»»»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»»»»»» literalType

Boolean

»»»»»»»»»»» literalType

Integer

»»»»»»»»»»» literalType

Decimal

»»»»»»»»»»» literalType

Date

»»»»»»»»»»» literalType

DateTime

»»»»»»»»»»» literalType

String

»»»»»»»»»»» literalType

Float

»»»»»»»»»»» literalType

Long

»»»»»»»»»»» literalType

Null

»»»»»»»»»»» literalType

Parameter

»»»»»»»»»»» literalType

Guid

»»»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»»»» literalType

Boolean

»»»»»»»»»» literalType

Integer

»»»»»»»»»» literalType

Decimal

»»»»»»»»»» literalType

Date

»»»»»»»»»» literalType

DateTime

»»»»»»»»»» literalType

String

»»»»»»»»»» literalType

Float

»»»»»»»»»» literalType

Long

»»»»»»»»»» literalType

Null

»»»»»»»»»» literalType

Parameter

»»»»»»»»»» literalType

Guid

»»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»»» literalType

Boolean

»»»»»»»»» sourceType

Table

»»»»»»»»» sourceType

Query

»»»»»»»»» joinType

Inner

»»»»»»»»» joinType

Left

»»»»»»»»» joinType

Right

»»»»»»»»» joinType

Cross

»»»»»»»»» joinType

CrossApply

»»»»»»»»» joinType

OuterApply

»»»»»»»»»» constraintType

clause

»»»»»»»»»» constraintType

constraint

»»»»»»»»»» constraintType

expressionConstraint

»»»»»»»»»» constraintType

likeConstraint

»»»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»»»» constraintType

subQueryConstraint

»»»»»»»»» direction

Ascending

»»»»»»»»» direction

Descending

»»»»»»»»» direction

AscendingNullsFirst

»»»»»»»»» direction

DescendingNullsLast

»»»»»» order

Ascending

»»»»»» order

Descending

»»»»»» alignment

Justify

»»»»»» alignment

Left

»»»»»» alignment

Center

»»»»»» alignment

Right

»»»»»»»» style

Number

»»»»»»»» style

Percent

»»»»»»»» style

Dollars

»»»»»»»» style

FrenchCanadianDollars

»»»»»»»» style

Pounds

»»»»»»»» style

Euro

»»»»»»»» style

Yen

»»»»»»»» style

Yuan

»»»»»»»» style

Rand

»»»»»»»» style

BrazilianReal

»»»»»»»» style

Rupee

»»»»»»»» style

SingaporeanDollar

»»»»»»»» style

AustralianDollar

»»»»»»»» style

Won

»»»»» verticalAlignment

Top

»»»»» verticalAlignment

Middle

»»»»» verticalAlignment

Bottom

»»»» verticalAlignment

Top

»»»» verticalAlignment

Middle

»»»» verticalAlignment

Bottom

»»»»» valueType

Text

»»»»» valueType

Formula

»»»» operatorType

LessThan

»»»» operatorType

LessThanEquals

»»»» operatorType

Equals

»»»» operatorType

NotEquals

»»»» operatorType

GreaterThan

»»»» operatorType

GreaterThanEquals

»»»» operatorType

IsNull

»»»» operatorType

IsNotNull

»»»» valueType

String

»»»» valueType

Numeric

»»»» valueType

Date

»»»» valueType

Field

»»»» valueType

Scalar

»»» dateDisplayMode

ShortDate

»»» dateDisplayMode

LongDate

»»» labelOrientation

Horizontal

»»» labelOrientation

Vertical

»»» labelOrientation

Slanted

»»»» type

ComboSource

»»»» type

DisplayValueSource

»»»» type

DYComboSource

»»»» type

MapSource

»»»» type

MSComboSource

»»»» type

MSDisplayValueSource

»»»» type

MSDYComboSource

»»»» type

MSXYSource

»»»» type

MSXYZSource

»»»» type

AngularGaugeSource

»»»» type

HLinearGaugeSource

»»»» type

CylinderGaugeSource

»»»» type

XYSource

»»»» type

XYZSource

»»»» renderAs

Column

»»»» renderAs

Area

»»»» renderAs

Line

»»»» type

SingleSeriesChartStyleSet

»»»» type

MultiSeriesChartStyleSet

»»»» type

MapStyleSet

»»»» type

GaugeStyleSet

»»» fusionTheme

Classic

»»» fusionTheme

Solid

»»» legendPosition

Bottom

»»» legendPosition

Right

»»» mapDisplayType

Afghanistan

»»» mapDisplayType

Africa

»»» mapDisplayType

Alabama

»»» mapDisplayType

Alaska

»»» mapDisplayType

Albania

»»» mapDisplayType

Alberta

»»» mapDisplayType

Algeria

»»» mapDisplayType

Andorra

»»» mapDisplayType

Angola

»»» mapDisplayType

Antigua

»»» mapDisplayType

Argentina

»»» mapDisplayType

Arizona

»»» mapDisplayType

Arkansas

»»» mapDisplayType

Armenia

»»» mapDisplayType

Asia

»»» mapDisplayType

Asia3

»»» mapDisplayType

AsiaGeorgia

»»» mapDisplayType

Australia

»»» mapDisplayType

Australia2

»»» mapDisplayType

Austria

»»» mapDisplayType

Azerbaijan

»»» mapDisplayType

Bahamas

»»» mapDisplayType

Bahrain

»»» mapDisplayType

Bangladesh

»»» mapDisplayType

Barbados

»»» mapDisplayType

Belarus

»»» mapDisplayType

Belgium

»»» mapDisplayType

Belize

»»» mapDisplayType

Benin

»»» mapDisplayType

Bhutan

»»» mapDisplayType

Bolivia

»»» mapDisplayType

BosniaHerzegovina

»»» mapDisplayType

Botswana

»»» mapDisplayType

Brazil

»»» mapDisplayType

BrazilRegion

»»» mapDisplayType

BritishColumbia

»»» mapDisplayType

Brunei

»»» mapDisplayType

Bulgaria

»»» mapDisplayType

BurkinaFaso

»»» mapDisplayType

Burma

»»» mapDisplayType

Burundi

»»» mapDisplayType

California

»»» mapDisplayType

Cambodia

»»» mapDisplayType

Cameroon

»»» mapDisplayType

Canada

»»» mapDisplayType

CapeVerde

»»» mapDisplayType

CaymanIslands

»»» mapDisplayType

CentralAfricanRepublic

»»» mapDisplayType

CentralAmerica

»»» mapDisplayType

CentralAmerica2

»»» mapDisplayType

CentralAmericawithCaribbean

»»» mapDisplayType

CentralEuropeanRegion

»»» mapDisplayType

Chad

»»» mapDisplayType

Chile

»»» mapDisplayType

China

»»» mapDisplayType

China2

»»» mapDisplayType

Colombia

»»» mapDisplayType

Colorado

»»» mapDisplayType

Comoros

»»» mapDisplayType

Congo

»»» mapDisplayType

Connecticut

»»» mapDisplayType

CostaRica

»»» mapDisplayType

CoteDivoire

»»» mapDisplayType

Croatia

»»» mapDisplayType

Cuba

»»» mapDisplayType

Cyprus

»»» mapDisplayType

Cyprus2

»»» mapDisplayType

CzechRepublic

»»» mapDisplayType

Delaware

»»» mapDisplayType

DemocraticRepublicofCongo

»»» mapDisplayType

Denmark

»»» mapDisplayType

DenmarkRegion

»»» mapDisplayType

DistrictofColumbia

»»» mapDisplayType

Djibouti

»»» mapDisplayType

Dominica

»»» mapDisplayType

DominicanRepublic

»»» mapDisplayType

EastEuropeanRegion

»»» mapDisplayType

EastTimor

»»» mapDisplayType

Ecuador

»»» mapDisplayType

Egypt

»»» mapDisplayType

ElSalvador

»»» mapDisplayType

England

»»» mapDisplayType

EnglandRegion

»»» mapDisplayType

EquatorialGuinea

»»» mapDisplayType

Eritrea

»»» mapDisplayType

Estonia

»»» mapDisplayType

Ethiopia

»»» mapDisplayType

Europe

»»» mapDisplayType

Europe2

»»» mapDisplayType

EuropeRegion

»»» mapDisplayType

Europewithcountries

»»» mapDisplayType

FalklandIsland

»»» mapDisplayType

Fiji

»»» mapDisplayType

Finland

»»» mapDisplayType

Florida

»»» mapDisplayType

France

»»» mapDisplayType

FranceDepartment

»»» mapDisplayType

FrenchGuiana

»»» mapDisplayType

Gabon

»»» mapDisplayType

Gambia

»»» mapDisplayType

Georgia

»»» mapDisplayType

Germany

»»» mapDisplayType

Ghana

»»» mapDisplayType

Greece

»»» mapDisplayType

Greenland

»»» mapDisplayType

Grenada

»»» mapDisplayType

Guatemala

»»» mapDisplayType

Guinea

»»» mapDisplayType

GuineaBissau

»»» mapDisplayType

Guyana

»»» mapDisplayType

Haiti

»»» mapDisplayType

Hawaii

»»» mapDisplayType

Honduras

»»» mapDisplayType

HongKong

»»» mapDisplayType

Hungary

»»» mapDisplayType

HungaryRegions

»»» mapDisplayType

Iceland

»»» mapDisplayType

Idaho

»»» mapDisplayType

Illinois

»»» mapDisplayType

India

»»» mapDisplayType

Indiana

»»» mapDisplayType

Indonesia

»»» mapDisplayType

Iowa

»»» mapDisplayType

Iran

»»» mapDisplayType

Iraq

»»» mapDisplayType

Ireland

»»» mapDisplayType

Israel

»»» mapDisplayType

Italy

»»» mapDisplayType

Jamaica

»»» mapDisplayType

Japan

»»» mapDisplayType

Jordan

»»» mapDisplayType

Kansas

»»» mapDisplayType

Kazakhstan

»»» mapDisplayType

Kentucky

»»» mapDisplayType

Kenya

»»» mapDisplayType

Kiribati

»»» mapDisplayType

KosovoDistricts

»»» mapDisplayType

Kuwait

»»» mapDisplayType

Kyrgyzstan

»»» mapDisplayType

Laos

»»» mapDisplayType

Latvia

»»» mapDisplayType

Lebanon

»»» mapDisplayType

Lesotho

»»» mapDisplayType

Liberia

»»» mapDisplayType

Libya

»»» mapDisplayType

Liechtenstein

»»» mapDisplayType

Lithuania

»»» mapDisplayType

Louisiana

»»» mapDisplayType

Luxembourg

»»» mapDisplayType

Macau

»»» mapDisplayType

Macedonia

»»» mapDisplayType

Madagascar

»»» mapDisplayType

MadagascarRegions

»»» mapDisplayType

Maine

»»» mapDisplayType

Malawi

»»» mapDisplayType

Malaysia

»»» mapDisplayType

Mali

»»» mapDisplayType

Malta

»»» mapDisplayType

Manitoba

»»» mapDisplayType

MarshallIsland

»»» mapDisplayType

Maryland

»»» mapDisplayType

Massachusetts

»»» mapDisplayType

Mauritania

»»» mapDisplayType

Mauritius

»»» mapDisplayType

Mexico

»»» mapDisplayType

Michigan

»»» mapDisplayType

Micronesia

»»» mapDisplayType

MiddleEast

»»» mapDisplayType

Minnesota

»»» mapDisplayType

Mississippi

»»» mapDisplayType

Missouri

»»» mapDisplayType

Moldova

»»» mapDisplayType

Monaco

»»» mapDisplayType

Mongolia

»»» mapDisplayType

Montana

»»» mapDisplayType

Montenegro

»»» mapDisplayType

Morocco

»»» mapDisplayType

Mozambique

»»» mapDisplayType

Namibia

»»» mapDisplayType

Nauru

»»» mapDisplayType

Nebraska

»»» mapDisplayType

Nepal

»»» mapDisplayType

Netherlands

»»» mapDisplayType

Nevada

»»» mapDisplayType

NewBrunswick

»»» mapDisplayType

NewCaledonia

»»» mapDisplayType

NewfoundlandandLabrador

»»» mapDisplayType

NewHampshire

»»» mapDisplayType

NewJersey

»»» mapDisplayType

NewMexico

»»» mapDisplayType

NewYork

»»» mapDisplayType

NewZealand

»»» mapDisplayType

Nicaragua

»»» mapDisplayType

Niger

»»» mapDisplayType

Nigeria

»»» mapDisplayType

NorthAmerica

»»» mapDisplayType

NorthAmericaWOCentral

»»» mapDisplayType

NorthCarolina

»»» mapDisplayType

NorthDakota

»»» mapDisplayType

NorthEuropeanRegion

»»» mapDisplayType

NorthernIreland

»»» mapDisplayType

NorthKorea

»»» mapDisplayType

NorthWestTerritories

»»» mapDisplayType

Norway

»»» mapDisplayType

NorwayRegion

»»» mapDisplayType

NovaScotia

»»» mapDisplayType

Nunavut

»»» mapDisplayType

Oceania

»»» mapDisplayType

Ohio

»»» mapDisplayType

Oklahoma

»»» mapDisplayType

Oman

»»» mapDisplayType

Ontario

»»» mapDisplayType

Oregon

»»» mapDisplayType

Pakistan

»»» mapDisplayType

Palau

»»» mapDisplayType

Panama

»»» mapDisplayType

PapuaNewGuinea

»»» mapDisplayType

Paraguay

»»» mapDisplayType

Pennsylvania

»»» mapDisplayType

Peru

»»» mapDisplayType

Philippines

»»» mapDisplayType

Poland

»»» mapDisplayType

PolandCounties

»»» mapDisplayType

Portugal

»»» mapDisplayType

PrinceEdwardIsland

»»» mapDisplayType

PuertoRico

»»» mapDisplayType

Qatar

»»» mapDisplayType

Quebec

»»» mapDisplayType

RhodeIsland

»»» mapDisplayType

Romania

»»» mapDisplayType

Russia

»»» mapDisplayType

Rwanda

»»» mapDisplayType

SaintKittsandNevis

»»» mapDisplayType

SaintLucia

»»» mapDisplayType

SaintVincentandtheGrenadines

»»» mapDisplayType

Samoa

»»» mapDisplayType

SanMarino

»»» mapDisplayType

SaoTomeandPrincipe

»»» mapDisplayType

Saskatchewan

»»» mapDisplayType

SaudiArabia

»»» mapDisplayType

Scotland

»»» mapDisplayType

ScotlandRegion

»»» mapDisplayType

Senegal

»»» mapDisplayType

Serbia

»»» mapDisplayType

SerbiaWoKosovo

»»» mapDisplayType

Seychelles

»»» mapDisplayType

SierraLeone

»»» mapDisplayType

Singapore

»»» mapDisplayType

Slovakia

»»» mapDisplayType

Slovenia

»»» mapDisplayType

SolomonIsland

»»» mapDisplayType

Somalia

»»» mapDisplayType

SouthAfrica

»»» mapDisplayType

SouthAmerica

»»» mapDisplayType

SouthCarolina

»»» mapDisplayType

SouthDakota

»»» mapDisplayType

SouthEuropeanRegion

»»» mapDisplayType

SouthKorea

»»» mapDisplayType

SouthSudan

»»» mapDisplayType

Spain

»»» mapDisplayType

SpainProvinces

»»» mapDisplayType

SriLanka

»»» mapDisplayType

Sudan

»»» mapDisplayType

SudanWoSouthSudan

»»» mapDisplayType

Suriname

»»» mapDisplayType

Swaziland

»»» mapDisplayType

Sweden

»»» mapDisplayType

Switzerland

»»» mapDisplayType

Syria

»»» mapDisplayType

Taiwan

»»» mapDisplayType

Tajikistan

»»» mapDisplayType

Tanzania

»»» mapDisplayType

Tennessee

»»» mapDisplayType

Texas

»»» mapDisplayType

Thailand

»»» mapDisplayType

Tibet

»»» mapDisplayType

Togo

»»» mapDisplayType

Tonga

»»» mapDisplayType

TrinidadandTobago

»»» mapDisplayType

Tunisia

»»» mapDisplayType

Turkey

»»» mapDisplayType

Turkmenistan

»»» mapDisplayType

Tuvalu

»»» mapDisplayType

UAE

»»» mapDisplayType

Uganda

»»» mapDisplayType

UK

»»» mapDisplayType

UK7

»»» mapDisplayType

Ukraine

»»» mapDisplayType

Uruguay

»»» mapDisplayType

USA

»»» mapDisplayType

USACentralRegion

»»» mapDisplayType

USANorthEastRegion

»»» mapDisplayType

USANorthWestRegion

»»» mapDisplayType

USARegion

»»» mapDisplayType

USASouthEastRegion

»»» mapDisplayType

USASouthWestRegion

»»» mapDisplayType

Utah

»»» mapDisplayType

Uzbekistan

»»» mapDisplayType

Vanuatu

»»» mapDisplayType

VaticanCity

»»» mapDisplayType

Venezuela

»»» mapDisplayType

Vermont

»»» mapDisplayType

Vietnam

»»» mapDisplayType

Virginia

»»» mapDisplayType

Wales

»»» mapDisplayType

Washington

»»» mapDisplayType

WesternSahara

»»» mapDisplayType

WestEuropeanRegion

»»» mapDisplayType

WestVirginia

»»» mapDisplayType

Wisconsin

»»» mapDisplayType

World

»»» mapDisplayType

World8

»»» mapDisplayType

World8WithAntarctica

»»» mapDisplayType

WorldWithAntarctica

»»» mapDisplayType

WorldwithCountries

»»» mapDisplayType

Wyoming

»»» mapDisplayType

Yemen

»»» mapDisplayType

YukonTerritory

»»» mapDisplayType

Zambia

»»» mapDisplayType

Zimbabwe

»»» ssChartDisplayType

Area2D

»»» ssChartDisplayType

Bar2D

»»» ssChartDisplayType

Column2D

»»» ssChartDisplayType

Column3D

»»» ssChartDisplayType

Doughnut2D

»»» ssChartDisplayType

Doughnut3D

»»» ssChartDisplayType

Funnel

»»» ssChartDisplayType

Pyramid

»»» ssChartDisplayType

Line

»»» ssChartDisplayType

Pie2D

»»» ssChartDisplayType

Pie3D

»»» ssChartDisplayType

Spline

»»» ssChartDisplayType

SplineArea

»»» ssChartDisplayType

Waterfall2D

»»» ssChartDisplayType

Kagi

»»» msChartDisplayType

MSArea

»»» msChartDisplayType

InverseMSArea

»»» msChartDisplayType

ScrollArea2D

»»» msChartDisplayType

MSBar2D

»»» msChartDisplayType

MSColumn2D

»»» msChartDisplayType

InverseMSColumn2D

»»» msChartDisplayType

ScrollColumn2D

»»» msChartDisplayType

LogMSColumn2D

»»» msChartDisplayType

MSColumn3D

»»» msChartDisplayType

MSLine

»»» msChartDisplayType

InverseMSLine

»»» msChartDisplayType

ScrollLine2D

»»» msChartDisplayType

LogMSLine

»»» msChartDisplayType

StackedArea2D

»»» msChartDisplayType

StackedBar2D

»»» msChartDisplayType

StackedBar3D

»»» msChartDisplayType

StackedColumn2D

»»» msChartDisplayType

ScrollStackedColumn2D

»»» msChartDisplayType

StackedColumn3D

»»» msChartDisplayType

MSSpline

»»» msChartDisplayType

MSSplineArea

»»» msChartDisplayType

Radar

»»» msChartDisplayType

Scatter

»»» msChartDisplayType

Bubble

»»» msChartDisplayType

MSCombi2D

»»» msChartDisplayType

MSCombi3D

»»» msChartDisplayType

MSColumnLine3D

»»» msChartDisplayType

MSCombiDY2D

»»» msChartDisplayType

MSColumn3DLineDY

»»» msChartDisplayType

StackedColumn3DLineDY

»»» gaugeDisplayType

AngularGauge

»»» gaugeDisplayType

Cylinder

»»» gaugeDisplayType

HLinearGauge

»»» status

Available

»»» status

Pending

»»» status

Closed

»»» columns

WorkflowID

»»» columns

WorkflowName

»»» columns

WorkflowDescription

»»» columns

ReportName

»»» columns

WebReportID

»»» columns

ActionName

»»» columns

SubmittedBy

»»» columns

SubmittedByName

»»» columns

DateReceived

»»» columns

TokenID

»»» columns

Initiator

»»» columns

InitiatorName

»»» columns

DateOfInitiation

»»» columns

DateOfCompletion

»» type

AggregateTransformation

»» type

ComputedColumn

»» type

InputRowSource

»» type

QuerySource

»» type

TransposedSource

»» type

StaticScalar

»» type

ValueScalar

»» type

ComputedScalar

»» type

Parameter

»»»» variableType

Literal

»»»» variableType

Parameter

»»»» variableType

Scalar

»» treeNodeType

Folder

»» treeNodeType

Source

»» treeNodeType

ParameterRoot

»» treeNodeType

ScalarRoot

»» treeNodeType

SourceRoot

»» treeNodeType

EditableSourceRoot

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.WebReportDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/webreports/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webreports/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "allowPdfExport": true,
  "showInquiry": true,
  "batchExportDetails": {
    "canBatchExport": true,
    "picklistRefParam": "string"
  },
  "background": {
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "image": {
      "displayBorder": {},
      "displayPadding": {},
      "gridType": "string",
      "hoverText": "string",
      "imageByteArray": "string",
      "imageId": 0,
      "imageLink": {},
      "imageType": "string",
      "imageUrl": "string",
      "expiryDate": "2019-08-24T14:15:22Z",
      "cosObjectName": "string",
      "name": "string",
      "source": {},
      "style": {}
    },
    "imageAttachment": "Scroll",
    "imagePosition": "Absolute",
    "imageTile": "None",
    "webreportId": 0,
    "x": 0,
    "y": 0,
    "opacity": 0
  },
  "defaultStyle": {
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    }
  },
  "directlyAccessible": true,
  "frameLayout": {
    "horizontalAlign": "Left",
    "verticalAlign": "Top",
    "type": "Frame",
    "childHeightPercents": [
      0.1
    ],
    "childWidthPercents": [
      0.1
    ],
    "frames": [
      []
    ],
    "name": "string",
    "numColumns": 0,
    "numRows": 0,
    "display": {
      "gridType": "string",
      "name": "string",
      "source": {},
      "type": "DataGridDisplay",
      "restrictSource": {},
      "restrictColumn": "string",
      "style": {},
      "columnMap": {},
      "computedColumns": [],
      "computedRow": {},
      "dataGridDisplayStyle": {},
      "dataGridInputRules": [],
      "dateFormat": {},
      "defaultPageSize": 0,
      "enableExportToExcel": true,
      "enableInquiryCopy": true,
      "enableShowHideColumns": true,
      "freezeTopRow": true,
      "hiddenColumnAliasMap": {},
      "hiddenColumns": [],
      "hiddenInputRowColumnMap": {},
      "inputRowAtTop": true,
      "isVertical": true,
      "numericStyle": {},
      "paginated": true,
      "sections": [],
      "showOnlyInputRow": true,
      "showSectionHeader": true,
      "sortColumns": [],
      "suppressHeader": true,
      "hideRowBorders": true,
      "disableRowHighlighting": true,
      "suppressRepeatPartitionValues": true,
      "timeId": "string",
      "validationRules": [],
      "selectedTemplateId": 0,
      "columnWidths": [],
      "displays": [],
      "fixedGridDisplayStyle": {},
      "imageType": "string",
      "imageLink": {},
      "imageId": 0,
      "imageByteArray": "string",
      "hoverText": "string",
      "imageUrl": "string",
      "expiryDate": "2019-08-24T14:15:22Z",
      "cosObjectName": "string",
      "controlDisplayStyle": {},
      "sortById": true,
      "sortAscending": true,
      "refParameter": "string",
      "nameColumn": "string",
      "idColumn": "string",
      "hideValueForExport": true,
      "hideIdValues": true,
      "scalarDisplayStyle": {},
      "scalarLink": {},
      "text": "string",
      "documentId": 0,
      "buttonDisplayStyle": {},
      "cellStyle": {},
      "agreementText": "string",
      "format": {},
      "conditionalFormatRule": {},
      "dateDisplayMode": "ShortDate",
      "xAxisName": "string",
      "yAxisName": "string",
      "numberPrefix": "string",
      "numberSuffix": "string",
      "labelOrientation": "Horizontal",
      "hideValues": true,
      "decimalSeparator": "string",
      "thousandSeparator": "string",
      "isPercentage": "string",
      "numDecimals": "string",
      "numberScaling": "string",
      "showTitle": true,
      "yMinMax": true,
      "zMinMax": true,
      "yMin": "string",
      "yMax": "string",
      "zMin": "string",
      "zMax": "string",
      "dontTrimBarLabel": "string",
      "defaultLink": {},
      "entityLinkMap": {},
      "fusionSource": {},
      "fusionStyles": {},
      "fusionTheme": "Classic",
      "height": 0,
      "legendPosition": "Bottom",
      "mapDisplayType": "Afghanistan",
      "mapValueRanges": [],
      "showLegend": true,
      "width": 0,
      "ssChartDisplayType": "Area2D",
      "chartLink": {},
      "customColors": [],
      "msChartDisplayType": "MSArea",
      "syAxisName": "string",
      "syNumberPrefix": "string",
      "syNumberSuffix": "string",
      "hideSyValues": true,
      "centerValues": true,
      "syDecimalSeparator": "string",
      "syThousandSeparator": "string",
      "isSyPercentage": "string",
      "syNumDecimals": "string",
      "syNumberScaling": "string",
      "lowerLimitDisplayName": "string",
      "upperLimitDisplayName": "string",
      "valueToolTip": "string",
      "gaugeDisplayType": "AngularGauge",
      "link": {},
      "limitLabelFillColor": "string",
      "gaugeValueRanges": [],
      "trendpoint": {},
      "gaugeStartAngle": 0.1,
      "gaugeEndAngle": 0.1,
      "fillColor": {},
      "status": "Available",
      "enableHeaders": true,
      "workflowLinkDisplayStyle": {},
      "columns": []
    }
  },
  "isLayoutLocked": true,
  "name": "string",
  "pdfOptions": {
    "autoScale": true,
    "customScaleValue": 0.1,
    "footerText": "string",
    "includePageNumber": true,
    "portraitOrientation": true,
    "showTotalPageNumber": true,
    "tableViewportWidth": 0.1
  },
  "sources": [
    {
      "dependencies": [],
      "name": "string",
      "type": "AggregateTransformation",
      "scalarType": "string",
      "value": null,
      "column": "string",
      "keyValues": {},
      "table": "string",
      "expression": "string",
      "variables": [],
      "required": true,
      "useWebUser": true,
      "isParameterValueScalar": true,
      "parameterValue": {},
      "parameterId": 0,
      "columnNames": [],
      "source": {},
      "formula": "string",
      "partitionColumns": [],
      "timeEnd": "2019-08-24T14:15:22Z",
      "timeFrequency": {},
      "timePartition": "string",
      "timeStart": "2019-08-24T14:15:22Z",
      "newColumnName": "string",
      "keyColumns": [],
      "newColumns": [],
      "transposeColumn": "string"
    }
  ],
  "trees": [
    {
      "name": "string",
      "parent": "string",
      "parentNodeType": "string",
      "treeNodeType": "Folder"
    }
  ],
  "version": {
    "rowVersion": 0
  },
  "webReportId": 0,
  "workflowObjectId": 0,
  "element": {},
  "styleCategory": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webreports/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/webreports/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/webreports/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

WebReportsControllerV1_Delete

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

string

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/webreports/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webreports/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webreports/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('http://localhost:8080/api/v1/webreports/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.delete 'http://localhost:8080/api/v1/webreports/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
"string"
"string"

Get framelayout from webreport.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Unique id of the web Report

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/webreports/{id}/workflow", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webreports/{id}/workflow");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webreports/{id}/workflow',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/webreports/{id}/workflow', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/webreports/{id}/workflow',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  "string"
]
["string"]

WebReportsControllerV1_GetDependencies

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

dependencies for the given presenter report

RESTAPI.v1.DTOs.DependencyInfoDTO

404

Not Found

Web Form does not exist

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/webreports/{id}/dependents", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webreports/{id}/dependents");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webreports/{id}/dependents',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/webreports/{id}/dependents', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/webreports/{id}/dependents',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "dependencies": {
    "Calendars": [
      {}
    ],
    "StarSchemas": [
      {}
    ],
    "Calculations": [
      {}
    ],
    "SavedImports": [
      {}
    ],
    "InputForms": [
      {}
    ],
    "TaskGroup": [
      {}
    ],
    "Plans": [
      {}
    ],
    "TailoredReports": [
      {}
    ],
    "Publications": [
      {}
    ],
    "PayeeGroups": [
      {}
    ],
    "Payees": [
      {}
    ],
    "Blocks": [
      {}
    ],
    "Ports": [
      {}
    ],
    "WebForms": [
      {}
    ],
    "WebFormFilters": [
      {}
    ],
    "WorkflowGroups": [
      {}
    ],
    "WebTab": [
      {}
    ],
    "Transformations": [
      {}
    ],
    "WebFormValidationRules": [
      {}
    ],
    "DataStores": [
      {}
    ],
    "BPMWorkflow": [
      {}
    ],
    "BPMSwimLane": [
      {}
    ],
    "BPMNode": [
      {}
    ],
    "BPMComponent": [
      {}
    ],
    "Views": [
      {}
    ],
    "Tables": [
      {}
    ],
    "PresenterReports": [
      {}
    ],
    "PickList": [
      {}
    ],
    "WebEditRestriction": [
      {}
    ],
    "PresenterReportDataSources": [
      {}
    ],
    "PresenterReportValueSources": [
      {}
    ],
    "PresenterReportRowFormSources": [
      {}
    ],
    "ScenarioWorkspace": [
      {}
    ],
    "Scheduler": [
      {}
    ],
    "RapidReport": [
      {}
    ],
    "DDE": [
      {}
    ],
    "Hierarchy": [
      {}
    ],
    "PresenterFlex": [
      {}
    ],
    "AdaptiveForms": [
      {}
    ],
    "ReportDataModelSource": [
      {}
    ],
    "PlanComponentSource": [
      {}
    ],
    "PlanBuilderCalculation": [
      {}
    ],
    "PlanBuilderItem": [
      {}
    ]
  }
}
{"dependencies":{"Calendars":[{}],"StarSchemas":[{}],"Calculations":[{}],"SavedImports":[{}],"InputForms":[{}],"TaskGroup":[{}],"Plans":[{}],"TailoredReports":[{}],"Publications":[{}],"PayeeGroups":[{}],"Payees":[{}],"Blocks":[{}],"Ports":[{}],"WebForms":[{}],"WebFormFilters":[{}],"WorkflowGroups":[{}],"WebTab":[{}],"Transformations":[{}],"WebFormValidationRules":[{}],"DataStores":[{}],"BPMWorkflow":[{}],"BPMSwimLane":[{}],"BPMNode":[{}],"BPMComponent":[{}],"Views":[{}],"Tables":[{}],"PresenterReports":[{}],"PickList":[{}],"WebEditRestriction":[{}],"PresenterReportDataSources":[{}],"PresenterReportValueSources":[{}],"PresenterReportRowFormSources":[{}],"ScenarioWorkspace":[{}],"Scheduler":[{}],"RapidReport":[{}],"DDE":[{}],"Hierarchy":[{}],"PresenterFlex":[{}],"AdaptiveForms":[{}],"ReportDataModelSource":[{}],"PlanComponentSource":[{}],"PlanBuilderCalculation":[{}],"PlanBuilderItem":[{}]}}

Get the dropdown options for picklist-filled parameters.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

ID of the web Report

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

object

false

none

none

»» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/webreports/{id}/parameteroptions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webreports/{id}/parameteroptions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webreports/{id}/parameteroptions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/webreports/{id}/parameteroptions', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/webreports/{id}/parameteroptions',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "property1": {
    "property1": "string",
    "property2": "string"
  },
  "property2": {
    "property1": "string",
    "property2": "string"
  }
}
{"property1":{"property1":"string","property2":"string"},"property2":{"property1":"string","property2":"string"}}

Get system data stores.

Responses

Status

Meaning

Description

Schema

200

OK

Get all System sources

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.ReportSourceDTO]

false

none

none

» dependencies

[string]¦null

false

none

none

» name

string¦null

false

none

none

» type

string

false

none

none

» scalarType

string¦null

false

none

none

» value

any

false

none

none

» column

string¦null

false

none

none

» keyValues

object¦null

false

none

none

»» additionalProperties

Varicent.RESTAPI.v1.DTOs.ReportVariableDTO

false

none

none

»»» value

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»» expressionType

string

false

none

none

»»»» cases

array¦null

false

none

none

»»»»» anonymous

any

false

none

none

»»»» table

string¦null

false

none

none

»»»» column

string¦null

false

none

none

»»»» op

string¦null

false

none

none

»»»» arguments

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

none

[DTO version of IExpression]

»»»»» expressionType

string

false

none

none

»»»»» cases

array¦null

false

none

none

»»»»»» anonymous

any

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» column

string¦null

false

none

none

»»»»» op

string¦null

false

none

none

»»»»» arguments

array¦null

false

none

none

»»»»»» anonymous

any

false

none

none

»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»» constraintType

string

false

none

none

»»»»»» op

string¦null

false

none

none

»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»» expressionType

string

false

none

none

»»»»»»» cases

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» column

string¦null

false

none

none

»»»»»»» op

string¦null

false

none

none

»»»»»»» arguments

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»»» condition

any

false

none

none

»»»»»»» trueValue

any

false

none

none

»»»»»»» falseValue

any

false

none

none

»»»»»»» isDate

boolean

false

none

none

»»»»»»» literalType

string

false

none

none

»»»»»»» value

any

false

none

none

»»»»»» caseSensitive

boolean

false

none

none

»»»»»» constraints

array¦null

false

none

none

»»»»»»» anonymous

any

false

none

none

»»»»»» literalRight

any

false

none

none

»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»» right

any

false

none

none

»»»»»» expressionLeft

any

false

none

none

»»»»»» expressionRight

any

false

none

none

»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»» like

string¦null

false

none

none

»»»»»» escapeWildcards

boolean

false

none

none

»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»» rowVersion

integer(int64)

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» queryDefinitionRight

any

false

none

none

»»»»» trueValue

any

false

none

none

»»»»» falseValue

any

false

none

none

»»»»» isDate

boolean

false

none

none

»»»»» literalType

string

false

none

none

»»»»» value

any

false

none

none

»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»» trueValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»» falseValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»» isDate

boolean

false

none

none

»»»» literalType

string

false

none

none

»»»» value

any

false

none

none

»»» variableName

string¦null

false

none

none

»»» variableType

string

false

none

none

» table

string¦null

false

none

none

» expression

string¦null

false

none

none

» variables

[string]¦null

false

none

none

» required

boolean

false

none

none

» useWebUser

boolean

false

none

none

» isParameterValueScalar

boolean

false

none

none

» parameterValue

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

» parameterId

integer(int32)

false

none

none

» columnNames

[string]¦null

false

none

none

» source

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

»» query

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

»»» selectItems

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

none

»»»» alias

string¦null

false

none

none

»»»» column

string¦null

false

none

none

»»»» table

string¦null

false

none

none

»»»» customSelect

string¦null

false

none

none

»»»» dataType

string

false

none

none

»»»» type

string

false

none

none

»»»» value

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»» namespaceTable

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

none

»»»»» m_namespace

string¦null

false

none

none

»»»»» name

string¦null

false

none

none

»»»» query

any

false

none

none

»»»» alias

string¦null

false

none

none

»»»» sourceType

string

false

none

none

»»» joins

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

none

»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»» joinType

string

false

none

none

»»»» onClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»» constraintType

string

false

none

none

»»»»» op

string¦null

false

none

none

»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»» caseSensitive

boolean

false

none

none

»»»»» constraints

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

none

[DTO version of IConstraint]

»»»»» literalRight

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»» right

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» expressionLeft

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» expressionRight

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» isPreciseDecimal

boolean

false

none

none

»»»»» like

string¦null

false

none

none

»»»»» escapeWildcards

boolean

false

none

none

»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» queryDefinitionRight

any

false

none

none

»»» whereClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»» order

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

none

»»»» table

string¦null

false

none

none

»»»» column

string¦null

false

none

none

»»»» direction

string

false

none

none

»»» group

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

none

»»»» table

string¦null

false

none

none

»»»» column

string¦null

false

none

none

»»» havingClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»» distinct

boolean

false

none

none

»»» unionWith

any

false

none

none

»»» exceptWith

any

false

none

none

»» sourceNames

object¦null

false

none

none

»»» additionalProperties

string¦null

false

none

none

» formula

string¦null

false

none

none

» partitionColumns

[string]¦null

false

none

none

» timeEnd

string(date-time)

false

none

none

» timeFrequency

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

none

»» levelId

string¦null

false

none

none

»» timeId

string¦null

false

none

none

» timePartition

string¦null

false

none

none

» timeStart

string(date-time)

false

none

none

» newColumnName

string¦null

false

none

none

» keyColumns

[string]¦null

false

none

none

» newColumns

[string]¦null

false

none

none

» transposeColumn

string¦null

false

none

none

Enumerated Values

Property

Value

type

AggregateTransformation

type

ComputedColumn

type

InputRowSource

type

QuerySource

type

TransposedSource

type

StaticScalar

type

ValueScalar

type

ComputedScalar

type

Parameter

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

variableType

Literal

variableType

Parameter

variableType

Scalar

dataType

Int

dataType

Decimal

dataType

DateTime

dataType

None

dataType

String

type

SelectAll

type

SelectItem

type

SelectLiteral

type

SelectCustom

type

SelectExpression

sourceType

Table

sourceType

Query

joinType

Inner

joinType

Left

joinType

Right

joinType

Cross

joinType

CrossApply

joinType

OuterApply

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

direction

Ascending

direction

Descending

direction

AscendingNullsFirst

direction

DescendingNullsLast

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/systemsources", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/systemsources");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/systemsources',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/systemsources', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/systemsources',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "dependencies": [
      "string"
    ],
    "name": "string",
    "type": "AggregateTransformation",
    "scalarType": "string",
    "value": null,
    "column": "string",
    "keyValues": {
      "property1": {},
      "property2": {}
    },
    "table": "string",
    "expression": "string",
    "variables": [
      "string"
    ],
    "required": true,
    "useWebUser": true,
    "isParameterValueScalar": true,
    "parameterValue": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "parameterId": 0,
    "columnNames": [
      "string"
    ],
    "source": {
      "query": {},
      "sourceNames": {}
    },
    "formula": "string",
    "partitionColumns": [
      "string"
    ],
    "timeEnd": "2019-08-24T14:15:22Z",
    "timeFrequency": {
      "levelId": "string",
      "timeId": "string"
    },
    "timePartition": "string",
    "timeStart": "2019-08-24T14:15:22Z",
    "newColumnName": "string",
    "keyColumns": [
      "string"
    ],
    "newColumns": [
      "string"
    ],
    "transposeColumn": "string"
  }
]
[{"dependencies":["string"],"name":"string","type":"AggregateTransformation","scalarType":"string","value":null,"column":"string","keyValues":{"property1":{},"property2":{}},"table":"string","expression":"string","variables":["string"],"required":true,"useWebUser":true,"isParameterValueScalar":true,"parameterValue":{"expressionType":"caseExpression","cases":[],"table":"string","column":"string","op":"string","arguments":[],"condition":{},"trueValue":{},"falseValue":{},"isDate":true,"literalType":"Integer","value":null},"parameterId":0,"columnNames":["string"],"source":{"query":{},"sourceNames":{}},"formula":"string","partitionColumns":["string"],"timeEnd":"2019-08-24T14:15:22Z","timeFrequency":{"levelId":"string","timeId":"string"},"timePartition":"string","timeStart":"2019-08-24T14:15:22Z","newColumnName":"string","keyColumns":["string"],"newColumns":["string"],"transposeColumn":"string"}]

Translate multiple web report source definitions to a full table schema.

Body parameter

[
  {
    "dependencies": [
      "string"
    ],
    "name": "string",
    "type": "AggregateTransformation",
    "scalarType": "string",
    "value": null,
    "column": "string",
    "keyValues": {
      "property1": {},
      "property2": {}
    },
    "table": "string",
    "expression": "string",
    "variables": [
      "string"
    ],
    "required": true,
    "useWebUser": true,
    "isParameterValueScalar": true,
    "parameterValue": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "parameterId": 0,
    "columnNames": [
      "string"
    ],
    "source": {
      "query": {},
      "sourceNames": {}
    },
    "formula": "string",
    "partitionColumns": [
      "string"
    ],
    "timeEnd": "2019-08-24T14:15:22Z",
    "timeFrequency": {
      "levelId": "string",
      "timeId": "string"
    },
    "timePartition": "string",
    "timeStart": "2019-08-24T14:15:22Z",
    "newColumnName": "string",
    "keyColumns": [
      "string"
    ],
    "newColumns": [
      "string"
    ],
    "transposeColumn": "string"
  }
]

Parameters

Name

In

Type

Required

Description

webReportID

path

integer(int32)

true

ID of the web report to which the sources belong.

body

body

Varicent.RESTAPI.v1.DTOs.ReportSourceDTO

false

Report source definitions

Detailed descriptions

webReportID: ID of the web report to which the sources belong. This is used for working with aggregate transformation sources that depend on a pre-existing source.

Responses

Status

Meaning

Description

Schema

200

OK

Schemas of the given source definitions

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.FullTableSchemaDTO]

false

none

none

» columns

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

none

»» name

string¦null

false

none

none

»» type

string

false

none

none

»» isKey

boolean

false

none

none

»» nullable

boolean

false

none

none

»» values

string¦null

false

none

none

»» lockedPeriod

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

none

»»» start

string(date-time)

false

none

none

»»» end

string(date-time)

false

none

none

»» referencedCol

string¦null

false

none

none

»» picklistFilter

string¦null

false

none

none

»» displayName

string¦null

false

none

none

»» isELTPeriod

boolean¦null

false

none

none

» table

string¦null

false

none

none

» name

string¦null

false

none

none

» referencedSources

[string]¦null

false

none

none

» referencedTimes

[Varicent.RESTAPI.v1.DTOs.FrequencyDTO]¦null

false

none

none

»» levelId

string¦null

false

none

none

»» timeId

string¦null

false

none

none

» referencedSourcesDictionary

object¦null

false

none

none

»» additionalProperties

string

false

none

none

» referencedTimesDictionary

object¦null

false

none

none

»» additionalProperties

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

none

Enumerated Values

Property

Value

type

String

type

LongString

type

MaxString

type

Date

type

DateTime

type

Decimal

type

Int

type

Long

type

Float

type

BLOB

type

Identity

type

CLOB

type

RowVersion

type

UID

type

VarCharMax

type

Boolean

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/webreports/{webReportID}/translatesourceschemas", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/webreports/{webReportID}/translatesourceschemas");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "dependencies": [
      "string"
    ],
    "name": "string",
    "type": "AggregateTransformation",
    "scalarType": "string",
    "value": null,
    "column": "string",
    "keyValues": {
      "property1": {},
      "property2": {}
    },
    "table": "string",
    "expression": "string",
    "variables": [
      "string"
    ],
    "required": true,
    "useWebUser": true,
    "isParameterValueScalar": true,
    "parameterValue": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "parameterId": 0,
    "columnNames": [
      "string"
    ],
    "source": {
      "query": {},
      "sourceNames": {}
    },
    "formula": "string",
    "partitionColumns": [
      "string"
    ],
    "timeEnd": "2019-08-24T14:15:22Z",
    "timeFrequency": {
      "levelId": "string",
      "timeId": "string"
    },
    "timePartition": "string",
    "timeStart": "2019-08-24T14:15:22Z",
    "newColumnName": "string",
    "keyColumns": [
      "string"
    ],
    "newColumns": [
      "string"
    ],
    "transposeColumn": "string"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/webreports/{webReportID}/translatesourceschemas',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/webreports/{webReportID}/translatesourceschemas', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/webreports/{webReportID}/translatesourceschemas',
  params: {
  }, headers: headers

p JSON.parse(result)

Translate a web report source definition to a full table schema.

Body parameter

{
  "source": {
    "dependencies": [
      "string"
    ],
    "name": "string",
    "type": "AggregateTransformation",
    "scalarType": "string",
    "value": null,
    "column": "string",
    "keyValues": {
      "property1": {},
      "property2": {}
    },
    "table": "string",
    "expression": "string",
    "variables": [
      "string"
    ],
    "required": true,
    "useWebUser": true,
    "isParameterValueScalar": true,
    "parameterValue": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "parameterId": 0,
    "columnNames": [
      "string"
    ],
    "source": {
      "query": {},
      "sourceNames": {}
    },
    "formula": "string",
    "partitionColumns": [
      "string"
    ],
    "timeEnd": "2019-08-24T14:15:22Z",
    "timeFrequency": {
      "levelId": "string",
      "timeId": "string"
    },
    "timePartition": "string",
    "timeStart": "2019-08-24T14:15:22Z",
    "newColumnName": "string",
    "keyColumns": [
      "string"
    ],
    "newColumns": [
      "string"
    ],
    "transposeColumn": "string"
  },
  "dependencies": [
    {
      "dependencies": [],
      "name": "string",
      "type": "AggregateTransformation",
      "scalarType": "string",
      "value": null,
      "column": "string",
      "keyValues": {},
      "table": "string",
      "expression": "string",
      "variables": [],
      "required": true,
      "useWebUser": true,
      "isParameterValueScalar": true,
      "parameterValue": {},
      "parameterId": 0,
      "columnNames": [],
      "source": {},
      "formula": "string",
      "partitionColumns": [],
      "timeEnd": "2019-08-24T14:15:22Z",
      "timeFrequency": {},
      "timePartition": "string",
      "timeStart": "2019-08-24T14:15:22Z",
      "newColumnName": "string",
      "keyColumns": [],
      "newColumns": [],
      "transposeColumn": "string"
    }
  ]
}

Parameters

Name

In

Type

Required

Description

webReportID

path

integer(int32)

true

ID of the web report to which the source belongs.

body

body

RESTAPI.v1.DTOs.TranslateSingleReportSourceDTO

false

Report source definition and its dependency sources

» source

body

Varicent.RESTAPI.v1.DTOs.ReportSourceDTO

false

none

»» dependencies

body

[string]¦null

false

none

»» name

body

string¦null

false

none

»» type

body

string

false

none

»» scalarType

body

string¦null

false

none

»» value

body

any

false

none

»» column

body

string¦null

false

none

»» keyValues

body

object¦null

false

none

»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.ReportVariableDTO

false

none

»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»» expressionType

body

string

false

none

»»»»»» cases

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» arguments

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»» constraintType

body

string

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» condition

body

any

false

none

»»»»»»»» trueValue

body

any

false

none

»»»»»»»» falseValue

body

any

false

none

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»» constraints

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» literalRight

body

any

false

none

»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» right

body

any

false

none

»»»»»»» expressionLeft

body

any

false

none

»»»»»»» expressionRight

body

any

false

none

»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»» like

body

string¦null

false

none

»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»» trueValue

body

any

false

none

»»»»»» falseValue

body

any

false

none

»»»»»» isDate

body

boolean

false

none

»»»»»» literalType

body

string

false

none

»»»»»» value

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»»» variableName

body

string¦null

false

none

»»»» variableType

body

string

false

none

»» table

body

string¦null

false

none

»» expression

body

string¦null

false

none

»» variables

body

[string]¦null

false

none

»» required

body

boolean

false

none

»» useWebUser

body

boolean

false

none

»» isParameterValueScalar

body

boolean

false

none

»» parameterValue

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»» parameterId

body

integer(int32)

false

none

»» columnNames

body

[string]¦null

false

none

»» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»»» alias

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» table

body

string¦null

false

none

»»»»» customSelect

body

string¦null

false

none

»»»»» dataType

body

string

false

none

»»»»» type

body

string

false

none

»»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»»» m_namespace

body

string¦null

false

none

»»»»»» name

body

string¦null

false

none

»»»»» query

body

any

false

none

»»»»» alias

body

string¦null

false

none

»»»»» sourceType

body

string

false

none

»»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»» joinType

body

string

false

none

»»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»» constraintType

body

string

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»» caseSensitive

body

boolean

false

none

»»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»» like

body

string¦null

false

none

»»»»»» escapeWildcards

body

boolean

false

none

»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» queryDefinitionRight

body

any

false

none

»»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» direction

body

string

false

none

»»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»» distinct

body

boolean

false

none

»»»» unionWith

body

any

false

none

»»»» exceptWith

body

any

false

none

»»» sourceNames

body

object¦null

false

none

»»»» additionalProperties

body

string¦null

false

none

»» formula

body

string¦null

false

none

»» partitionColumns

body

[string]¦null

false

none

»» timeEnd

body

string(date-time)

false

none

»» timeFrequency

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»» levelId

body

string¦null

false

none

»»» timeId

body

string¦null

false

none

»» timePartition

body

string¦null

false

none

»» timeStart

body

string(date-time)

false

none

»» newColumnName

body

string¦null

false

none

»» keyColumns

body

[string]¦null

false

none

»» newColumns

body

[string]¦null

false

none

»» transposeColumn

body

string¦null

false

none

» dependencies

body

[Varicent.RESTAPI.v1.DTOs.ReportSourceDTO]¦null

false

none

Detailed descriptions

webReportID: ID of the web report to which the source belongs. This is used for working with aggregate transformation sources that depend on a pre-existing source.

Enumerated Values

Parameter

Value

»» type

AggregateTransformation

»» type

ComputedColumn

»» type

InputRowSource

»» type

QuerySource

»» type

TransposedSource

»» type

StaticScalar

»» type

ValueScalar

»» type

ComputedScalar

»» type

Parameter

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» expressionType

caseExpression

»»»»»» expressionType

dataField

»»»»»» expressionType

function

»»»»»» expressionType

ifExpression

»»»»»» expressionType

literal

»»»»»»» constraintType

clause

»»»»»»» constraintType

constraint

»»»»»»» constraintType

expressionConstraint

»»»»»»» constraintType

likeConstraint

»»»»»»» constraintType

rowVersionConstraint

»»»»»»» constraintType

subQueryConstraint

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»» literalType

Integer

»»»»»» literalType

Decimal

»»»»»» literalType

Date

»»»»»» literalType

DateTime

»»»»»» literalType

String

»»»»»» literalType

Float

»»»»»» literalType

Long

»»»»»» literalType

Null

»»»»»» literalType

Parameter

»»»»»» literalType

Guid

»»»»»» literalType

SystemUtcTime

»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» variableType

Literal

»»»» variableType

Parameter

»»»» variableType

Scalar

»»»»» dataType

Int

»»»»» dataType

Decimal

»»»»» dataType

DateTime

»»»»» dataType

None

»»»»» dataType

String

»»»»» type

SelectAll

»»»»» type

SelectItem

»»»»» type

SelectLiteral

»»»»» type

SelectCustom

»»»»» type

SelectExpression

»»»»» sourceType

Table

»»»»» sourceType

Query

»»»»» joinType

Inner

»»»»» joinType

Left

»»»»» joinType

Right

»»»»» joinType

Cross

»»»»» joinType

CrossApply

»»»»» joinType

OuterApply

»»»»»» constraintType

clause

»»»»»» constraintType

constraint

»»»»»» constraintType

expressionConstraint

»»»»»» constraintType

likeConstraint

»»»»»» constraintType

rowVersionConstraint

»»»»»» constraintType

subQueryConstraint

»»»»» direction

Ascending

»»»»» direction

Descending

»»»»» direction

AscendingNullsFirst

»»»»» direction

DescendingNullsLast

Responses

Status

Meaning

Description

Schema

200

OK

Schema of the given a single source definition and its dependent sources

Varicent.RESTAPI.v1.DTOs.FullTableSchemaDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/webreports/{webReportID}/translatesinglesourceschema", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/webreports/{webReportID}/translatesinglesourceschema");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "source": {
    "dependencies": [
      "string"
    ],
    "name": "string",
    "type": "AggregateTransformation",
    "scalarType": "string",
    "value": null,
    "column": "string",
    "keyValues": {
      "property1": {},
      "property2": {}
    },
    "table": "string",
    "expression": "string",
    "variables": [
      "string"
    ],
    "required": true,
    "useWebUser": true,
    "isParameterValueScalar": true,
    "parameterValue": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "parameterId": 0,
    "columnNames": [
      "string"
    ],
    "source": {
      "query": {},
      "sourceNames": {}
    },
    "formula": "string",
    "partitionColumns": [
      "string"
    ],
    "timeEnd": "2019-08-24T14:15:22Z",
    "timeFrequency": {
      "levelId": "string",
      "timeId": "string"
    },
    "timePartition": "string",
    "timeStart": "2019-08-24T14:15:22Z",
    "newColumnName": "string",
    "keyColumns": [
      "string"
    ],
    "newColumns": [
      "string"
    ],
    "transposeColumn": "string"
  },
  "dependencies": [
    {
      "dependencies": [],
      "name": "string",
      "type": "AggregateTransformation",
      "scalarType": "string",
      "value": null,
      "column": "string",
      "keyValues": {},
      "table": "string",
      "expression": "string",
      "variables": [],
      "required": true,
      "useWebUser": true,
      "isParameterValueScalar": true,
      "parameterValue": {},
      "parameterId": 0,
      "columnNames": [],
      "source": {},
      "formula": "string",
      "partitionColumns": [],
      "timeEnd": "2019-08-24T14:15:22Z",
      "timeFrequency": {},
      "timePartition": "string",
      "timeStart": "2019-08-24T14:15:22Z",
      "newColumnName": "string",
      "keyColumns": [],
      "newColumns": [],
      "transposeColumn": "string"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/webreports/{webReportID}/translatesinglesourceschema',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/webreports/{webReportID}/translatesinglesourceschema', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/webreports/{webReportID}/translatesinglesourceschema',
  params: {
  }, headers: headers

p JSON.parse(result)

Return a preview of the given source definition for the given web report when in the Web Report Source Wizard.

Body parameter

{
  "sourceDefinition": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "parameters": {
    "property1": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "property2": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    }
  },
  "webReport": {
    "allowPdfExport": true,
    "showInquiry": true,
    "batchExportDetails": {
      "canBatchExport": true,
      "picklistRefParam": "string"
    },
    "background": {
      "color": {},
      "image": {},
      "imageAttachment": "Scroll",
      "imagePosition": "Absolute",
      "imageTile": "None",
      "webreportId": 0,
      "x": 0,
      "y": 0,
      "opacity": 0
    },
    "defaultStyle": {
      "color": {},
      "font": {}
    },
    "directlyAccessible": true,
    "frameLayout": {
      "horizontalAlign": "Left",
      "verticalAlign": "Top",
      "type": "Frame",
      "childHeightPercents": [],
      "childWidthPercents": [],
      "frames": [],
      "name": "string",
      "numColumns": 0,
      "numRows": 0,
      "display": {}
    },
    "isLayoutLocked": true,
    "name": "string",
    "pdfOptions": {
      "autoScale": true,
      "customScaleValue": 0.1,
      "footerText": "string",
      "includePageNumber": true,
      "portraitOrientation": true,
      "showTotalPageNumber": true,
      "tableViewportWidth": 0.1
    },
    "sources": [
      {}
    ],
    "trees": [
      {}
    ],
    "version": {
      "rowVersion": 0
    },
    "webReportId": 0,
    "workflowObjectId": 0,
    "element": {},
    "styleCategory": "string"
  },
  "dependencies": [
    "string"
  ],
  "selectNames": [
    "string"
  ],
  "restrictions": {
    "constraintType": "clause",
    "op": "string",
    "dataFieldLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "caseSensitive": true,
    "constraints": [
      {}
    ],
    "literalRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "dataFieldRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "right": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "isPreciseDecimal": true,
    "like": "string",
    "escapeWildcards": true,
    "rowVersion": {
      "rowVersion": 0
    },
    "table": "string",
    "queryDefinitionRight": null
  }
}

Parameters

Name

In

Type

Required

Description

offset

query

integer(int32)

false

none

limit

query

integer(int32)

false

none

orderBy

query

string

false

none

filter

query

string

false

none

body

body

Varicent.RESTAPI.v1.DTOs.Preview.WebReportPreviewStateDTO

false

none

» sourceDefinition

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»» alias

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» table

body

string¦null

false

none

»»»» customSelect

body

string¦null

false

none

»»»» dataType

body

string

false

none

»»»» type

body

string

false

none

»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»» expressionType

body

string

false

none

»»»»»» cases

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» arguments

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»» constraintType

body

string

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» condition

body

any

false

none

»»»»»»»» trueValue

body

any

false

none

»»»»»»»» falseValue

body

any

false

none

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»» constraints

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» literalRight

body

any

false

none

»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» right

body

any

false

none

»»»»»»» expressionLeft

body

any

false

none

»»»»»»» expressionRight

body

any

false

none

»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»» like

body

string¦null

false

none

»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»» trueValue

body

any

false

none

»»»»»» falseValue

body

any

false

none

»»»»»» isDate

body

boolean

false

none

»»»»»» literalType

body

string

false

none

»»»»»» value

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»» m_namespace

body

string¦null

false

none

»»»»» name

body

string¦null

false

none

»»»» query

body

any

false

none

»»»» alias

body

string¦null

false

none

»»»» sourceType

body

string

false

none

»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» joinType

body

string

false

none

»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» constraintType

body

string

false

none

»»»»» op

body

string¦null

false

none

»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» caseSensitive

body

boolean

false

none

»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isPreciseDecimal

body

boolean

false

none

»»»»» like

body

string¦null

false

none

»»»»» escapeWildcards

body

boolean

false

none

»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»» table

body

string¦null

false

none

»»»»» queryDefinitionRight

body

any

false

none

»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» direction

body

string

false

none

»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» distinct

body

boolean

false

none

»»» unionWith

body

any

false

none

»»» exceptWith

body

any

false

none

»» sourceNames

body

object¦null

false

none

»»» additionalProperties

body

string¦null

false

none

» parameters

body

object¦null

false

none

»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

» webReport

body

Varicent.RESTAPI.v1.DTOs.WebReportDTO

false

none

»» allowPdfExport

body

boolean

false

none

»» showInquiry

body

boolean

false

none

»» batchExportDetails

body

Varicent.RESTAPI.v1.DTOs.WebReportBatchExportDetailsDTO

false

none

»»» canBatchExport

body

boolean

false

none

»»» picklistRefParam

body

string¦null

false

none

»» background

body

Varicent.RESTAPI.v1.DTOs.BackgroundDisplayDTO

false

none

»»» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»»» a

body

integer(int32)

false

none

»»»» b

body

integer(int32)

false

none

»»»» g

body

integer(int32)

false

none

»»»» r

body

integer(int32)

false

none

»»» image

body

Varicent.RESTAPI.v1.DTOs.ImageDisplayDTO

false

none

»»»» displayBorder

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»»» bottom

body

Varicent.RESTAPI.v1.DTOs.BorderDTO

false

none

»»»»»» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»»»»» width

body

number(float)

false

none

»»»»» left

body

Varicent.RESTAPI.v1.DTOs.BorderDTO

false

none

»»»»» right

body

Varicent.RESTAPI.v1.DTOs.BorderDTO

false

none

»»»»» top

body

Varicent.RESTAPI.v1.DTOs.BorderDTO

false

none

»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»»»» bottom

body

number(float)

false

none

»»»»» left

body

number(float)

false

none

»»»»» right

body

number(float)

false

none

»»»»» top

body

number(float)

false

none

»»»» gridType

body

string¦null

false

none

»»»» hoverText

body

string¦null

false

none

»»»» imageByteArray

body

string(byte)¦null

false

none

»»»» imageId

body

integer(int32)

false

none

»»»» imageLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»»» document

body

string¦null

false

none

»»»»» openInNewWindow

body

boolean

false

none

»»»»» parameters

body

object¦null

false

none

»»»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.LinkParameterValueDTO

false

none

»»»»»»» dataType

body

string

false

none

»»»»»»» source

body

string¦null

false

none

»»»»»»» type

body

string

false

none

»»»»»»» value

body

string¦null

false

none

»»»»» reportId

body

integer(int32)¦null

false

none

»»»»» targetId

body

integer(int32)

false

none

»»»»» targetType

body

string

false

none

»»»»» webFormId

body

integer(int32)¦null

false

none

»»»»» webTabId

body

integer(int32)¦null

false

none

»»»» imageType

body

string¦null

false

none

»»»» imageUrl

body

string¦null

false

none

»»»» expiryDate

body

string(date-time)¦null

false

none

»»»» cosObjectName

body

string¦null

false

none

»»»» name

body

string¦null

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DisplaySourceDTO

false

none

»»»»» name

body

string¦null

false

none

»»»» style

body

Varicent.RESTAPI.v1.DTOs.DataDisplayStyleDTO

false

none

»»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»» imageAttachment

body

string

false

none

»»» imagePosition

body

string

false

none

»»» imageTile

body

string

false

none

»»» webreportId

body

integer(int32)

false

none

»»» x

body

integer(int32)

false

none

»»» y

body

integer(int32)

false

none

»»» opacity

body

integer(int32)

false

none

»» defaultStyle

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»» font

body

Varicent.RESTAPI.v1.DTOs.FontDefinitionDTO

false

none

»»»» family

body

string¦null

false

none

»»»» size

body

number(float)

false

none

»»»» unit

body

string¦null

false

none

»»»» bold

body

boolean

false

none

»»»» italic

body

boolean

false

none

»»»» underline

body

boolean

false

none

»»»» strikeout

body

boolean

false

none

»» directlyAccessible

body

boolean

false

none

»» frameLayout

body

Varicent.RESTAPI.v1.DTOs.FrameableDTO

false

none

»»» horizontalAlign

body

string

false

none

»»» verticalAlign

body

string

false

none

»»» type

body

string

false

none

»»» childHeightPercents

body

[number]¦null

false

none

»»» childWidthPercents

body

[number]¦null

false

none

»»» frames

body

[array]¦null

false

none

»»»» anonymous

body

any

false

none

»»» name

body

string¦null

false

none

»»» numColumns

body

integer(int32)

false

none

»»» numRows

body

integer(int32)

false

none

»»» display

body

Varicent.RESTAPI.v1.DTOs.DataDisplayDTO

false

none

»»»» gridType

body

string¦null

false

none

»»»» name

body

string¦null

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DisplaySourceDTO

false

none

»»»» type

body

string

false

none

»»»» restrictSource

body

Varicent.RESTAPI.v1.DTOs.DisplaySourceDTO

false

none

»»»» restrictColumn

body

string¦null

false

none

»»»» style

body

Varicent.RESTAPI.v1.DTOs.DataDisplayStyleDTO

false

none

»»»» columnMap

body

object¦null

false

none

»»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.DataGridSourceColumnDTO

false

none

»»»»»» displayName

body

Varicent.RESTAPI.v1.DTOs.DataGridColumnDisplayNameDTO

false

none

»»»»»»» displayName

body

string¦null

false

none

»»»»»» dateFormat

body

Varicent.RESTAPI.v1.DTOs.PRDateFormatDTO

false

none

»»»»»»» style

body

string

false

none

»»»»»» pickListFilter

body

Varicent.RESTAPI.v1.DTOs.DataGridPicklistFilterDTO

false

none

»»»»»»» name

body

string¦null

false

none

»»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»» defaultValue

body

string¦null

false

none

»»»»»» referencedFrequency

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»»»»»» levelId

body

string¦null

false

none

»»»»»»» timeId

body

string¦null

false

none

»»»»»» isEditable

body

boolean

false

none

»»»»»» picklistDisplayOptions

body

Varicent.RESTAPI.v1.DTOs.InputRowPicklistOptionsDTO

false

none

»»»»»»» description

body

string¦null

false

none

»»»»»»» order

body

string

false

none

»»»»»»» hideKey

body

boolean

false

none

»»»»»»» hideDescription

body

boolean

false

none

»»»»»»» sortById

body

boolean

false

none

»»»»»» order

body

integer(int32)

false

none

»»»»»» headerStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»»»» alignment

body

string

false

none

»»»»»»» backColor

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»»»»»» font

body

Varicent.RESTAPI.v1.DTOs.FontDefinitionDTO

false

none

»»»»»»» foreColor

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»»»»» formatRule

body

Varicent.RESTAPI.v1.DTOs.ConditionalFormatRuleDTO

false

none

»»»»»»» formats

body

[Varicent.RESTAPI.v1.DTOs.ConditionalFormatDTO]¦null

false

none

»»»»»»»» formula

body

string¦null

false

none

»»»»»»»» numericFormat

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»»»»»»»» scale

body

integer(int32)

false

none

»»»»»»»»» style

body

string

false

none

»»»»»»»» style

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»»» columnLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»»»» numericFormat

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»»»»» width

body

number(double)

false

none

»»»»»» initiallyShow

body

boolean

false

none

»»»»»» useRowTextAlignment

body

boolean

false

none

»»»»»» wrapText

body

boolean

false

none

»»»»»» maxWidth

body

integer(int32)

false

none

»»»»»» verticalAlignment

body

string

false

none

»»»» computedColumns

body

[Varicent.RESTAPI.v1.DTOs.DataGridComputedColumnDTO]¦null

false

none

»»»»» name

body

string¦null

false

none

»»»»» formula

body

string¦null

false

none

»»»»» order

body

integer(int32)

false

none

»»»»» headerStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» formatRule

body

Varicent.RESTAPI.v1.DTOs.ConditionalFormatRuleDTO

false

none

»»»»» columnLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»»» numericFormat

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»»»» width

body

number(double)

false

none

»»»»» initiallyShow

body

boolean

false

none

»»»»» useRowTextAlignment

body

boolean

false

none

»»»»» wrapText

body

boolean

false

none

»»»»» maxWidth

body

integer(int32)

false

none

»»»»» verticalAlignment

body

string

false

none

»»»» computedRow

body

object¦null

false

none

»»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.DataGridComputedRowCellDTO

false

none

»»»»»» columnDisplayName

body

string¦null

false

none

»»»»»» cellValue

body

string¦null

false

none

»»»»»» valueType

body

string

false

none

»»»»»» numericFormat

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»»» dataGridDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.DataGridDisplayStyleDTO

false

none

»»»»» headerStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» evenRowStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» oddRowStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» allowAlternateRowFont

body

boolean

false

none

»»»»» isHeaderVerticalAlignmentBottom

body

boolean

false

none

»»»»» computedRowStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» borderWidth

body

integer(int32)

false

none

»»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»»» dataGridInputRules

body

[Varicent.RESTAPI.v1.DTOs.DataGridInputRuleDTO]¦null

false

none

»»»»» id

body

integer(int32)

false

none

»»»»» dataGrid

body

string¦null

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» operatorType

body

string

false

none

»»»»» valueType

body

string

false

none

»»»»» value

body

any

false

none

»»»» dateFormat

body

Varicent.RESTAPI.v1.DTOs.PRDateFormatDTO

false

none

»»»» defaultPageSize

body

integer(int32)¦null

false

none

»»»» enableExportToExcel

body

boolean¦null

false

none

»»»» enableInquiryCopy

body

boolean¦null

false

none

»»»» enableShowHideColumns

body

boolean¦null

false

none

»»»» freezeTopRow

body

boolean¦null

false

none

»»»» hiddenColumnAliasMap

body

object¦null

false

none

»»»»» additionalProperties

body

string¦null

false

none

»»»» hiddenColumns

body

[Varicent.RESTAPI.v1.DTOs.DataGridHiddenColumnDTO]¦null

false

none

»»»»» order

body

integer(int32)

false

none

»»»»» name

body

string¦null

false

none

»»»»» type

body

string¦null

false

none

»»»» hiddenInputRowColumnMap

body

object¦null

false

none

»»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.DataGridSourceColumnDTO

false

none

»»»» inputRowAtTop

body

boolean¦null

false

none

»»»» isVertical

body

boolean¦null

false

none

»»»» numericStyle

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»»» paginated

body

boolean¦null

false

none

»»»» sections

body

[Varicent.RESTAPI.v1.DTOs.SectionDisplayDTO]¦null

false

none

»»»»» name

body

string¦null

false

none

»»»»» frequency

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»»»» sources

body

[Varicent.RESTAPI.v1.DTOs.SourceInfoDTO]¦null

false

none

»»»»»» columnMapping

body

object¦null

false

none

»»»»»»» additionalProperties

body

string¦null

false

none

»»»»»» valueColumn

body

string¦null

false

none

»»»»»» sourceName

body

string¦null

false

none

»»»»»» sectionStyle

body

Varicent.RESTAPI.v1.DTOs.ScalarDisplayStyleDTO

false

none

»»»»»»» style

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»»»»» format

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»»»»» dateFormat

body

Varicent.RESTAPI.v1.DTOs.PRDateFormatDTO

false

none

»»»»» sectionDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.ScalarDisplayStyleDTO

false

none

»»»» showOnlyInputRow

body

boolean¦null

false

none

»»»» showSectionHeader

body

boolean¦null

false

none

»»»» sortColumns

body

[Varicent.RESTAPI.v1.DTOs.DataGridSortColumnDTO]¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» sortDescending

body

boolean

false

none

»»»»» columnFrequency

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»»» suppressHeader

body

boolean¦null

false

none

»»»» hideRowBorders

body

boolean¦null

false

none

»»»» disableRowHighlighting

body

boolean¦null

false

none

»»»» suppressRepeatPartitionValues

body

boolean¦null

false

none

»»»» timeId

body

string¦null

false

none

»»»» validationRules

body

[Varicent.RESTAPI.v1.DTOs.WebReportValidationRuleDTO]¦null

false

none

»»»»» formula

body

string¦null

false

none

»»»»» errorMessage

body

string¦null

false

none

»»»» selectedTemplateId

body

integer(int32)¦null

false

none

»»»» columnWidths

body

[number]¦null

false

none

»»»» displays

body

[array]¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» fixedGridDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.FixedGridDisplayStyleDTO

false

none

»»»»» rowStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» borderWidth

body

integer(int32)

false

none

»»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»»» imageType

body

string¦null

false

none

»»»» imageLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»» imageId

body

integer(int32)¦null

false

none

»»»» imageByteArray

body

string(byte)¦null

false

none

»»»» hoverText

body

string¦null

false

none

»»»» imageUrl

body

string¦null

false

none

»»»» expiryDate

body

string(date-time)¦null

false

none

»»»» cosObjectName

body

string¦null

false

none

»»»» controlDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.ControlDisplayStyleDTO

false

none

»»»»» style

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»»» sortById

body

boolean¦null

false

none

»»»» sortAscending

body

boolean¦null

false

none

»»»» refParameter

body

string¦null

false

none

»»»» nameColumn

body

string¦null

false

none

»»»» idColumn

body

string¦null

false

none

»»»» hideValueForExport

body

boolean¦null

false

none

»»»» hideIdValues

body

boolean¦null

false

none

»»»» scalarDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.ScalarDisplayStyleDTO

false

none

»»»» scalarLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»» text

body

string¦null

false

none

»»»» documentId

body

integer(int32)¦null

false

none

»»»» buttonDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.ButtonDisplayStyleDTO

false

none

»»»»» style

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»»» cellStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»» agreementText

body

string¦null

false

none

»»»» format

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»»» conditionalFormatRule

body

Varicent.RESTAPI.v1.DTOs.ConditionalFormatRuleDTO

false

none

»»»» dateDisplayMode

body

string¦null

false

none

»»»» xAxisName

body

string¦null

false

none

»»»» yAxisName

body

string¦null

false

none

»»»» numberPrefix

body

string¦null

false

none

»»»» numberSuffix

body

string¦null

false

none

»»»» labelOrientation

body

string¦null

false

none

»»»» hideValues

body

boolean¦null

false

none

»»»» decimalSeparator

body

string¦null

false

none

»»»» thousandSeparator

body

string¦null

false

none

»»»» isPercentage

body

string¦null

false

none

»»»» numDecimals

body

string¦null

false

none

»»»» numberScaling

body

string¦null

false

none

»»»» showTitle

body

boolean¦null

false

none

»»»» yMinMax

body

boolean¦null

false

none

»»»» zMinMax

body

boolean¦null

false

none

»»»» yMin

body

string¦null

false

none

»»»» yMax

body

string¦null

false

none

»»»» zMin

body

string¦null

false

none

»»»» zMax

body

string¦null

false

none

»»»» dontTrimBarLabel

body

string¦null

false

none

»»»» defaultLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»» entityLinkMap

body

object¦null

false

none

»»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»» fusionSource

body

Varicent.RESTAPI.v1.DTOs.FusionSourceDTO

false

none

»»»»» type

body

string

false

none

»»»»» sorted

body

boolean

false

none

»»»»» descending

body

boolean

false

none

»»»»» sortedByName

body

boolean

false

none

»»»»» sourceName

body

string¦null

false

none

»»»»» chartLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»»» displayColumn

body

string¦null

false

none

»»»»» valueColumn

body

string¦null

false

none

»»»»» sourceAlias

body

string¦null

false

none

»»»»» sortingInfo

body

Varicent.RESTAPI.v1.DTOs.SortingInfoDTO

false

none

»»»»»» levelId

body

string¦null

false

none

»»»»»» sortDescending

body

boolean

false

none

»»»»»» timeId

body

string¦null

false

none

»»»»»» sortedByName

body

boolean

false

none

»»»»» xColumn

body

string¦null

false

none

»»»»» yColumn

body

string¦null

false

none

»»»»» zColumn

body

string¦null

false

none

»»»»» renderAs

body

string¦null

false

none

»»»»» isPrimaryAxis

body

boolean¦null

false

none

»»»»» entityColumn

body

string¦null

false

none

»»»»» sources

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» minValueSourceName

body

string¦null

false

none

»»»»» maxValueSourceName

body

string¦null

false

none

»»»»» currentValueSourceName

body

string¦null

false

none

»»»»» trendpointValueSourceName

body

string¦null

false

none

»»»» fusionStyles

body

Varicent.RESTAPI.v1.DTOs.FusionStyleSetDTO

false

none

»»»»» type

body

string

false

none

»»»»» title

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»»» xAxisName

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»»» yAxisName

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»»» xAxisValues

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»»» yAxisValues

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»»» legend

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»»» syAxisName

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»»» syAxisValues

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»»» labels

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»»» tickValues

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»»» pointerOrFill

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»» fusionTheme

body

string¦null

false

none

»»»» height

body

integer(int32)¦null

false

none

»»»» legendPosition

body

string¦null

false

none

»»»» mapDisplayType

body

string¦null

false

none

»»»» mapValueRanges

body

[Varicent.RESTAPI.v1.DTOs.ColorValueRangeDTO]¦null

false

none

»»»»» label

body

string¦null

false

none

»»»»» min

body

number(double)

false

none

»»»»» max

body

number(double)

false

none

»»»»» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»»» showLegend

body

boolean¦null

false

none

»»»» width

body

integer(int32)¦null

false

none

»»»» ssChartDisplayType

body

string¦null

false

none

»»»» chartLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»» customColors

body

[Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO]¦null

false

none

»»»» msChartDisplayType

body

string¦null

false

none

»»»» syAxisName

body

string¦null

false

none

»»»» syNumberPrefix

body

string¦null

false

none

»»»» syNumberSuffix

body

string¦null

false

none

»»»» hideSyValues

body

boolean¦null

false

none

»»»» centerValues

body

boolean¦null

false

none

»»»» syDecimalSeparator

body

string¦null

false

none

»»»» syThousandSeparator

body

string¦null

false

none

»»»» isSyPercentage

body

string¦null

false

none

»»»» syNumDecimals

body

string¦null

false

none

»»»» syNumberScaling

body

string¦null

false

none

»»»» lowerLimitDisplayName

body

string¦null

false

none

»»»» upperLimitDisplayName

body

string¦null

false

none

»»»» valueToolTip

body

string¦null

false

none

»»»» gaugeDisplayType

body

string¦null

false

none

»»»» link

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»» limitLabelFillColor

body

string¦null

false

none

»»»» gaugeValueRanges

body

[Varicent.RESTAPI.v1.DTOs.ColorValueRangeDTO]¦null

false

none

»»»» trendpoint

body

Varicent.RESTAPI.v1.DTOs.TrendpointDTO

false

none

»»»»» label

body

string¦null

false

none

»»»»» labelStyle

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»»» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»»» gaugeStartAngle

body

number(double)¦null

false

none

»»»» gaugeEndAngle

body

number(double)¦null

false

none

»»»» fillColor

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»»» status

body

string¦null

false

none

»»»» enableHeaders

body

boolean¦null

false

none

»»»» workflowLinkDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.WorkflowLinkDisplayStyleDTO

false

none

»»»»» headerStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» primaryStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» secondaryStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»»» columns

body

[string]¦null

false

none

»» isLayoutLocked

body

boolean

false

none

»» name

body

string¦null

false

none

»» pdfOptions

body

Varicent.RESTAPI.v1.DTOs.WebReportPdfOptionsDTO

false

none

»»» autoScale

body

boolean

false

none

»»» customScaleValue

body

number(double)

false

none

»»» footerText

body

string¦null

false

none

»»» includePageNumber

body

boolean

false

none

»»» portraitOrientation

body

boolean

false

none

»»» showTotalPageNumber

body

boolean

false

none

»»» tableViewportWidth

body

number(double)¦null

false

none

»» sources

body

[Varicent.RESTAPI.v1.DTOs.ReportSourceDTO]¦null

false

none

»»» dependencies

body

[string]¦null

false

none

»»» name

body

string¦null

false

none

»»» type

body

string

false

none

»»» scalarType

body

string¦null

false

none

»»» value

body

any

false

none

»»» column

body

string¦null

false

none

»»» keyValues

body

object¦null

false

none

»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.ReportVariableDTO

false

none

»»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» variableName

body

string¦null

false

none

»»»»» variableType

body

string

false

none

»»» table

body

string¦null

false

none

»»» expression

body

string¦null

false

none

»»» variables

body

[string]¦null

false

none

»»» required

body

boolean

false

none

»»» useWebUser

body

boolean

false

none

»»» isParameterValueScalar

body

boolean

false

none

»»» parameterValue

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»» parameterId

body

integer(int32)

false

none

»»» columnNames

body

[string]¦null

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»» formula

body

string¦null

false

none

»»» partitionColumns

body

[string]¦null

false

none

»»» timeEnd

body

string(date-time)

false

none

»»» timeFrequency

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»» timePartition

body

string¦null

false

none

»»» timeStart

body

string(date-time)

false

none

»»» newColumnName

body

string¦null

false

none

»»» keyColumns

body

[string]¦null

false

none

»»» newColumns

body

[string]¦null

false

none

»»» transposeColumn

body

string¦null

false

none

»» trees

body

[Varicent.RESTAPI.v1.DTOs.ReportTreeNodeDTO]¦null

false

none

»»» name

body

string¦null

false

none

»»» parent

body

string¦null

false

none

»»» parentNodeType

body

string¦null

false

none

»»» treeNodeType

body

string

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» webReportId

body

integer(int32)

false

none

»» workflowObjectId

body

integer(int32)

false

none

»» element

body

Varicent.RESTAPI.v1.DTOs.IExpandableResourceDTO

false

none

»» styleCategory

body

string¦null

false

none

» dependencies

body

[string]¦null

false

none

» selectNames

body

[string]¦null

false

none

» restrictions

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

Enumerated Values

Parameter

Value

»»»» dataType

Int

»»»» dataType

Decimal

»»»» dataType

DateTime

»»»» dataType

None

»»»» dataType

String

»»»» type

SelectAll

»»»» type

SelectItem

»»»» type

SelectLiteral

»»»» type

SelectCustom

»»»» type

SelectExpression

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» expressionType

caseExpression

»»»»»» expressionType

dataField

»»»»»» expressionType

function

»»»»»» expressionType

ifExpression

»»»»»» expressionType

literal

»»»»»»» constraintType

clause

»»»»»»» constraintType

constraint

»»»»»»» constraintType

expressionConstraint

»»»»»»» constraintType

likeConstraint

»»»»»»» constraintType

rowVersionConstraint

»»»»»»» constraintType

subQueryConstraint

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»» literalType

Integer

»»»»»» literalType

Decimal

»»»»»» literalType

Date

»»»»»» literalType

DateTime

»»»»»» literalType

String

»»»»»» literalType

Float

»»»»»» literalType

Long

»»»»»» literalType

Null

»»»»»» literalType

Parameter

»»»»»» literalType

Guid

»»»»»» literalType

SystemUtcTime

»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» sourceType

Table

»»»» sourceType

Query

»»»» joinType

Inner

»»»» joinType

Left

»»»» joinType

Right

»»»» joinType

Cross

»»»» joinType

CrossApply

»»»» joinType

OuterApply

»»»»» constraintType

clause

»»»»» constraintType

constraint

»»»»» constraintType

expressionConstraint

»»»»» constraintType

likeConstraint

»»»»» constraintType

rowVersionConstraint

»»»»» constraintType

subQueryConstraint

»»»» direction

Ascending

»»»» direction

Descending

»»»» direction

AscendingNullsFirst

»»»» direction

DescendingNullsLast

»»»»»»» dataType

Report

»»»»»»» dataType

Form

»»»»»»» dataType

String

»»»»»»» dataType

DateTime

»»»»»»» dataType

Decimal

»»»»»»» dataType

Integer

»»»»»»» type

Scalar

»»»»»»» type

RowValue

»»»»»»» type

Constant

»»»»» targetType

WebReport

»»»»» targetType

WebForm

»»»»» targetType

URL

»»» imageAttachment

Scroll

»»» imageAttachment

Fixed

»»» imagePosition

Absolute

»»» imagePosition

Percent

»»» imagePosition

LeftTop

»»» imagePosition

LeftCenter

»»» imagePosition

LeftBottom

»»» imagePosition

RightTop

»»» imagePosition

RightCenter

»»» imagePosition

RightBottom

»»» imagePosition

CenterTop

»»» imagePosition

CenterCenter

»»» imagePosition

CenterBottom

»»» imageTile

None

»»» imageTile

Vertical

»»» imageTile

Horizontal

»»» imageTile

Both

»»» horizontalAlign

Left

»»» horizontalAlign

Middle

»»» horizontalAlign

Right

»»» verticalAlign

Top

»»» verticalAlign

Middle

»»» verticalAlign

Bottom

»»» type

Frame

»»» type

Content

»»»» type

DataGridDisplay

»»»» type

FixedGridDisplay

»»»» type

ImageDisplay

»»»» type

MapDisplay

»»»» type

MultiSeriesChartDisplay

»»»» type

PickListControl

»»»» type

QuickTextDisplay

»»»» type

DocumentLinkDisplay

»»»» type

SingleSeriesChartDisplay

»»»» type

SubmitButtonDisplay

»»»» type

TextControl

»»»» type

SignatureControl

»»»» type

TextScalarDisplay

»»»» type

NumericScalarDisplay

»»»» type

DateScalarDisplay

»»»» type

CylinderGaugeDisplay

»»»» type

HLinearGaugeDisplay

»»»» type

AngularGaugeDisplay

»»»» type

WorkflowLinkControl

»»»»»»» style

Date

»»»»»»» style

DateTime

»»»»»»» order

Ascending

»»»»»»» order

Descending

»»»»»»» alignment

Justify

»»»»»»» alignment

Left

»»»»»»» alignment

Center

»»»»»»» alignment

Right

»»»»»»»»» style

Number

»»»»»»»»» style

Percent

»»»»»»»»» style

Dollars

»»»»»»»»» style

FrenchCanadianDollars

»»»»»»»»» style

Pounds

»»»»»»»»» style

Euro

»»»»»»»»» style

Yen

»»»»»»»»» style

Yuan

»»»»»»»»» style

Rand

»»»»»»»»» style

BrazilianReal

»»»»»»»»» style

Rupee

»»»»»»»»» style

SingaporeanDollar

»»»»»»»»» style

AustralianDollar

»»»»»»»»» style

Won

»»»»»» verticalAlignment

Top

»»»»»» verticalAlignment

Middle

»»»»»» verticalAlignment

Bottom

»»»»» verticalAlignment

Top

»»»»» verticalAlignment

Middle

»»»»» verticalAlignment

Bottom

»»»»»» valueType

Text

»»»»»» valueType

Formula

»»»»» operatorType

LessThan

»»»»» operatorType

LessThanEquals

»»»»» operatorType

Equals

»»»»» operatorType

NotEquals

»»»»» operatorType

GreaterThan

»»»»» operatorType

GreaterThanEquals

»»»»» operatorType

IsNull

»»»»» operatorType

IsNotNull

»»»»» valueType

String

»»»»» valueType

Numeric

»»»»» valueType

Date

»»»»» valueType

Field

»»»»» valueType

Scalar

»»»» dateDisplayMode

ShortDate

»»»» dateDisplayMode

LongDate

»»»» labelOrientation

Horizontal

»»»» labelOrientation

Vertical

»»»» labelOrientation

Slanted

»»»»» type

ComboSource

»»»»» type

DisplayValueSource

»»»»» type

DYComboSource

»»»»» type

MapSource

»»»»» type

MSComboSource

»»»»» type

MSDisplayValueSource

»»»»» type

MSDYComboSource

»»»»» type

MSXYSource

»»»»» type

MSXYZSource

»»»»» type

AngularGaugeSource

»»»»» type

HLinearGaugeSource

»»»»» type

CylinderGaugeSource

»»»»» type

XYSource

»»»»» type

XYZSource

»»»»» renderAs

Column

»»»»» renderAs

Area

»»»»» renderAs

Line

»»»»» type

SingleSeriesChartStyleSet

»»»»» type

MultiSeriesChartStyleSet

»»»»» type

MapStyleSet

»»»»» type

GaugeStyleSet

»»»» fusionTheme

Classic

»»»» fusionTheme

Solid

»»»» legendPosition

Bottom

»»»» legendPosition

Right

»»»» mapDisplayType

Afghanistan

»»»» mapDisplayType

Africa

»»»» mapDisplayType

Alabama

»»»» mapDisplayType

Alaska

»»»» mapDisplayType

Albania

»»»» mapDisplayType

Alberta

»»»» mapDisplayType

Algeria

»»»» mapDisplayType

Andorra

»»»» mapDisplayType

Angola

»»»» mapDisplayType

Antigua

»»»» mapDisplayType

Argentina

»»»» mapDisplayType

Arizona

»»»» mapDisplayType

Arkansas

»»»» mapDisplayType

Armenia

»»»» mapDisplayType

Asia

»»»» mapDisplayType

Asia3

»»»» mapDisplayType

AsiaGeorgia

»»»» mapDisplayType

Australia

»»»» mapDisplayType

Australia2

»»»» mapDisplayType

Austria

»»»» mapDisplayType

Azerbaijan

»»»» mapDisplayType

Bahamas

»»»» mapDisplayType

Bahrain

»»»» mapDisplayType

Bangladesh

»»»» mapDisplayType

Barbados

»»»» mapDisplayType

Belarus

»»»» mapDisplayType

Belgium

»»»» mapDisplayType

Belize

»»»» mapDisplayType

Benin

»»»» mapDisplayType

Bhutan

»»»» mapDisplayType

Bolivia

»»»» mapDisplayType

BosniaHerzegovina

»»»» mapDisplayType

Botswana

»»»» mapDisplayType

Brazil

»»»» mapDisplayType

BrazilRegion

»»»» mapDisplayType

BritishColumbia

»»»» mapDisplayType

Brunei

»»»» mapDisplayType

Bulgaria

»»»» mapDisplayType

BurkinaFaso

»»»» mapDisplayType

Burma

»»»» mapDisplayType

Burundi

»»»» mapDisplayType

California

»»»» mapDisplayType

Cambodia

»»»» mapDisplayType

Cameroon

»»»» mapDisplayType

Canada

»»»» mapDisplayType

CapeVerde

»»»» mapDisplayType

CaymanIslands

»»»» mapDisplayType

CentralAfricanRepublic

»»»» mapDisplayType

CentralAmerica

»»»» mapDisplayType

CentralAmerica2

»»»» mapDisplayType

CentralAmericawithCaribbean

»»»» mapDisplayType

CentralEuropeanRegion

»»»» mapDisplayType

Chad

»»»» mapDisplayType

Chile

»»»» mapDisplayType

China

»»»» mapDisplayType

China2

»»»» mapDisplayType

Colombia

»»»» mapDisplayType

Colorado

»»»» mapDisplayType

Comoros

»»»» mapDisplayType

Congo

»»»» mapDisplayType

Connecticut

»»»» mapDisplayType

CostaRica

»»»» mapDisplayType

CoteDivoire

»»»» mapDisplayType

Croatia

»»»» mapDisplayType

Cuba

»»»» mapDisplayType

Cyprus

»»»» mapDisplayType

Cyprus2

»»»» mapDisplayType

CzechRepublic

»»»» mapDisplayType

Delaware

»»»» mapDisplayType

DemocraticRepublicofCongo

»»»» mapDisplayType

Denmark

»»»» mapDisplayType

DenmarkRegion

»»»» mapDisplayType

DistrictofColumbia

»»»» mapDisplayType

Djibouti

»»»» mapDisplayType

Dominica

»»»» mapDisplayType

DominicanRepublic

»»»» mapDisplayType

EastEuropeanRegion

»»»» mapDisplayType

EastTimor

»»»» mapDisplayType

Ecuador

»»»» mapDisplayType

Egypt

»»»» mapDisplayType

ElSalvador

»»»» mapDisplayType

England

»»»» mapDisplayType

EnglandRegion

»»»» mapDisplayType

EquatorialGuinea

»»»» mapDisplayType

Eritrea

»»»» mapDisplayType

Estonia

»»»» mapDisplayType

Ethiopia

»»»» mapDisplayType

Europe

»»»» mapDisplayType

Europe2

»»»» mapDisplayType

EuropeRegion

»»»» mapDisplayType

Europewithcountries

»»»» mapDisplayType

FalklandIsland

»»»» mapDisplayType

Fiji

»»»» mapDisplayType

Finland

»»»» mapDisplayType

Florida

»»»» mapDisplayType

France

»»»» mapDisplayType

FranceDepartment

»»»» mapDisplayType

FrenchGuiana

»»»» mapDisplayType

Gabon

»»»» mapDisplayType

Gambia

»»»» mapDisplayType

Georgia

»»»» mapDisplayType

Germany

»»»» mapDisplayType

Ghana

»»»» mapDisplayType

Greece

»»»» mapDisplayType

Greenland

»»»» mapDisplayType

Grenada

»»»» mapDisplayType

Guatemala

»»»» mapDisplayType

Guinea

»»»» mapDisplayType

GuineaBissau

»»»» mapDisplayType

Guyana

»»»» mapDisplayType

Haiti

»»»» mapDisplayType

Hawaii

»»»» mapDisplayType

Honduras

»»»» mapDisplayType

HongKong

»»»» mapDisplayType

Hungary

»»»» mapDisplayType

HungaryRegions

»»»» mapDisplayType

Iceland

»»»» mapDisplayType

Idaho

»»»» mapDisplayType

Illinois

»»»» mapDisplayType

India

»»»» mapDisplayType

Indiana

»»»» mapDisplayType

Indonesia

»»»» mapDisplayType

Iowa

»»»» mapDisplayType

Iran

»»»» mapDisplayType

Iraq

»»»» mapDisplayType

Ireland

»»»» mapDisplayType

Israel

»»»» mapDisplayType

Italy

»»»» mapDisplayType

Jamaica

»»»» mapDisplayType

Japan

»»»» mapDisplayType

Jordan

»»»» mapDisplayType

Kansas

»»»» mapDisplayType

Kazakhstan

»»»» mapDisplayType

Kentucky

»»»» mapDisplayType

Kenya

»»»» mapDisplayType

Kiribati

»»»» mapDisplayType

KosovoDistricts

»»»» mapDisplayType

Kuwait

»»»» mapDisplayType

Kyrgyzstan

»»»» mapDisplayType

Laos

»»»» mapDisplayType

Latvia

»»»» mapDisplayType

Lebanon

»»»» mapDisplayType

Lesotho

»»»» mapDisplayType

Liberia

»»»» mapDisplayType

Libya

»»»» mapDisplayType

Liechtenstein

»»»» mapDisplayType

Lithuania

»»»» mapDisplayType

Louisiana

»»»» mapDisplayType

Luxembourg

»»»» mapDisplayType

Macau

»»»» mapDisplayType

Macedonia

»»»» mapDisplayType

Madagascar

»»»» mapDisplayType

MadagascarRegions

»»»» mapDisplayType

Maine

»»»» mapDisplayType

Malawi

»»»» mapDisplayType

Malaysia

»»»» mapDisplayType

Mali

»»»» mapDisplayType

Malta

»»»» mapDisplayType

Manitoba

»»»» mapDisplayType

MarshallIsland

»»»» mapDisplayType

Maryland

»»»» mapDisplayType

Massachusetts

»»»» mapDisplayType

Mauritania

»»»» mapDisplayType

Mauritius

»»»» mapDisplayType

Mexico

»»»» mapDisplayType

Michigan

»»»» mapDisplayType

Micronesia

»»»» mapDisplayType

MiddleEast

»»»» mapDisplayType

Minnesota

»»»» mapDisplayType

Mississippi

»»»» mapDisplayType

Missouri

»»»» mapDisplayType

Moldova

»»»» mapDisplayType

Monaco

»»»» mapDisplayType

Mongolia

»»»» mapDisplayType

Montana

»»»» mapDisplayType

Montenegro

»»»» mapDisplayType

Morocco

»»»» mapDisplayType

Mozambique

»»»» mapDisplayType

Namibia

»»»» mapDisplayType

Nauru

»»»» mapDisplayType

Nebraska

»»»» mapDisplayType

Nepal

»»»» mapDisplayType

Netherlands

»»»» mapDisplayType

Nevada

»»»» mapDisplayType

NewBrunswick

»»»» mapDisplayType

NewCaledonia

»»»» mapDisplayType

NewfoundlandandLabrador

»»»» mapDisplayType

NewHampshire

»»»» mapDisplayType

NewJersey

»»»» mapDisplayType

NewMexico

»»»» mapDisplayType

NewYork

»»»» mapDisplayType

NewZealand

»»»» mapDisplayType

Nicaragua

»»»» mapDisplayType

Niger

»»»» mapDisplayType

Nigeria

»»»» mapDisplayType

NorthAmerica

»»»» mapDisplayType

NorthAmericaWOCentral

»»»» mapDisplayType

NorthCarolina

»»»» mapDisplayType

NorthDakota

»»»» mapDisplayType

NorthEuropeanRegion

»»»» mapDisplayType

NorthernIreland

»»»» mapDisplayType

NorthKorea

»»»» mapDisplayType

NorthWestTerritories

»»»» mapDisplayType

Norway

»»»» mapDisplayType

NorwayRegion

»»»» mapDisplayType

NovaScotia

»»»» mapDisplayType

Nunavut

»»»» mapDisplayType

Oceania

»»»» mapDisplayType

Ohio

»»»» mapDisplayType

Oklahoma

»»»» mapDisplayType

Oman

»»»» mapDisplayType

Ontario

»»»» mapDisplayType

Oregon

»»»» mapDisplayType

Pakistan

»»»» mapDisplayType

Palau

»»»» mapDisplayType

Panama

»»»» mapDisplayType

PapuaNewGuinea

»»»» mapDisplayType

Paraguay

»»»» mapDisplayType

Pennsylvania

»»»» mapDisplayType

Peru

»»»» mapDisplayType

Philippines

»»»» mapDisplayType

Poland

»»»» mapDisplayType

PolandCounties

»»»» mapDisplayType

Portugal

»»»» mapDisplayType

PrinceEdwardIsland

»»»» mapDisplayType

PuertoRico

»»»» mapDisplayType

Qatar

»»»» mapDisplayType

Quebec

»»»» mapDisplayType

RhodeIsland

»»»» mapDisplayType

Romania

»»»» mapDisplayType

Russia

»»»» mapDisplayType

Rwanda

»»»» mapDisplayType

SaintKittsandNevis

»»»» mapDisplayType

SaintLucia

»»»» mapDisplayType

SaintVincentandtheGrenadines

»»»» mapDisplayType

Samoa

»»»» mapDisplayType

SanMarino

»»»» mapDisplayType

SaoTomeandPrincipe

»»»» mapDisplayType

Saskatchewan

»»»» mapDisplayType

SaudiArabia

»»»» mapDisplayType

Scotland

»»»» mapDisplayType

ScotlandRegion

»»»» mapDisplayType

Senegal

»»»» mapDisplayType

Serbia

»»»» mapDisplayType

SerbiaWoKosovo

»»»» mapDisplayType

Seychelles

»»»» mapDisplayType

SierraLeone

»»»» mapDisplayType

Singapore

»»»» mapDisplayType

Slovakia

»»»» mapDisplayType

Slovenia

»»»» mapDisplayType

SolomonIsland

»»»» mapDisplayType

Somalia

»»»» mapDisplayType

SouthAfrica

»»»» mapDisplayType

SouthAmerica

»»»» mapDisplayType

SouthCarolina

»»»» mapDisplayType

SouthDakota

»»»» mapDisplayType

SouthEuropeanRegion

»»»» mapDisplayType

SouthKorea

»»»» mapDisplayType

SouthSudan

»»»» mapDisplayType

Spain

»»»» mapDisplayType

SpainProvinces

»»»» mapDisplayType

SriLanka

»»»» mapDisplayType

Sudan

»»»» mapDisplayType

SudanWoSouthSudan

»»»» mapDisplayType

Suriname

»»»» mapDisplayType

Swaziland

»»»» mapDisplayType

Sweden

»»»» mapDisplayType

Switzerland

»»»» mapDisplayType

Syria

»»»» mapDisplayType

Taiwan

»»»» mapDisplayType

Tajikistan

»»»» mapDisplayType

Tanzania

»»»» mapDisplayType

Tennessee

»»»» mapDisplayType

Texas

»»»» mapDisplayType

Thailand

»»»» mapDisplayType

Tibet

»»»» mapDisplayType

Togo

»»»» mapDisplayType

Tonga

»»»» mapDisplayType

TrinidadandTobago

»»»» mapDisplayType

Tunisia

»»»» mapDisplayType

Turkey

»»»» mapDisplayType

Turkmenistan

»»»» mapDisplayType

Tuvalu

»»»» mapDisplayType

UAE

»»»» mapDisplayType

Uganda

»»»» mapDisplayType

UK

»»»» mapDisplayType

UK7

»»»» mapDisplayType

Ukraine

»»»» mapDisplayType

Uruguay

»»»» mapDisplayType

USA

»»»» mapDisplayType

USACentralRegion

»»»» mapDisplayType

USANorthEastRegion

»»»» mapDisplayType

USANorthWestRegion

»»»» mapDisplayType

USARegion

»»»» mapDisplayType

USASouthEastRegion

»»»» mapDisplayType

USASouthWestRegion

»»»» mapDisplayType

Utah

»»»» mapDisplayType

Uzbekistan

»»»» mapDisplayType

Vanuatu

»»»» mapDisplayType

VaticanCity

»»»» mapDisplayType

Venezuela

»»»» mapDisplayType

Vermont

»»»» mapDisplayType

Vietnam

»»»» mapDisplayType

Virginia

»»»» mapDisplayType

Wales

»»»» mapDisplayType

Washington

»»»» mapDisplayType

WesternSahara

»»»» mapDisplayType

WestEuropeanRegion

»»»» mapDisplayType

WestVirginia

»»»» mapDisplayType

Wisconsin

»»»» mapDisplayType

World

»»»» mapDisplayType

World8

»»»» mapDisplayType

World8WithAntarctica

»»»» mapDisplayType

WorldWithAntarctica

»»»» mapDisplayType

WorldwithCountries

»»»» mapDisplayType

Wyoming

»»»» mapDisplayType

Yemen

»»»» mapDisplayType

YukonTerritory

»»»» mapDisplayType

Zambia

»»»» mapDisplayType

Zimbabwe

»»»» ssChartDisplayType

Area2D

»»»» ssChartDisplayType

Bar2D

»»»» ssChartDisplayType

Column2D

»»»» ssChartDisplayType

Column3D

»»»» ssChartDisplayType

Doughnut2D

»»»» ssChartDisplayType

Doughnut3D

»»»» ssChartDisplayType

Funnel

»»»» ssChartDisplayType

Pyramid

»»»» ssChartDisplayType

Line

»»»» ssChartDisplayType

Pie2D

»»»» ssChartDisplayType

Pie3D

»»»» ssChartDisplayType

Spline

»»»» ssChartDisplayType

SplineArea

»»»» ssChartDisplayType

Waterfall2D

»»»» ssChartDisplayType

Kagi

»»»» msChartDisplayType

MSArea

»»»» msChartDisplayType

InverseMSArea

»»»» msChartDisplayType

ScrollArea2D

»»»» msChartDisplayType

MSBar2D

»»»» msChartDisplayType

MSColumn2D

»»»» msChartDisplayType

InverseMSColumn2D

»»»» msChartDisplayType

ScrollColumn2D

»»»» msChartDisplayType

LogMSColumn2D

»»»» msChartDisplayType

MSColumn3D

»»»» msChartDisplayType

MSLine

»»»» msChartDisplayType

InverseMSLine

»»»» msChartDisplayType

ScrollLine2D

»»»» msChartDisplayType

LogMSLine

»»»» msChartDisplayType

StackedArea2D

»»»» msChartDisplayType

StackedBar2D

»»»» msChartDisplayType

StackedBar3D

»»»» msChartDisplayType

StackedColumn2D

»»»» msChartDisplayType

ScrollStackedColumn2D

»»»» msChartDisplayType

StackedColumn3D

»»»» msChartDisplayType

MSSpline

»»»» msChartDisplayType

MSSplineArea

»»»» msChartDisplayType

Radar

»»»» msChartDisplayType

Scatter

»»»» msChartDisplayType

Bubble

»»»» msChartDisplayType

MSCombi2D

»»»» msChartDisplayType

MSCombi3D

»»»» msChartDisplayType

MSColumnLine3D

»»»» msChartDisplayType

MSCombiDY2D

»»»» msChartDisplayType

MSColumn3DLineDY

»»»» msChartDisplayType

StackedColumn3DLineDY

»»»» gaugeDisplayType

AngularGauge

»»»» gaugeDisplayType

Cylinder

»»»» gaugeDisplayType

HLinearGauge

»»»» status

Available

»»»» status

Pending

»»»» status

Closed

»»»» columns

WorkflowID

»»»» columns

WorkflowName

»»»» columns

WorkflowDescription

»»»» columns

ReportName

»»»» columns

WebReportID

»»»» columns

ActionName

»»»» columns

SubmittedBy

»»»» columns

SubmittedByName

»»»» columns

DateReceived

»»»» columns

TokenID

»»»» columns

Initiator

»»»» columns

InitiatorName

»»»» columns

DateOfInitiation

»»»» columns

DateOfCompletion

»»» type

AggregateTransformation

»»» type

ComputedColumn

»»» type

InputRowSource

»»» type

QuerySource

»»» type

TransposedSource

»»» type

StaticScalar

»»» type

ValueScalar

»»» type

ComputedScalar

»»» type

Parameter

»»»»» variableType

Literal

»»»»» variableType

Parameter

»»»»» variableType

Scalar

»»» treeNodeType

Folder

»»» treeNodeType

Source

»»» treeNodeType

ParameterRoot

»»» treeNodeType

ScalarRoot

»»» treeNodeType

SourceRoot

»»» treeNodeType

EditableSourceRoot

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.ResultSetDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/webreports/preview", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webreports/preview");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "sourceDefinition": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "parameters": {
    "property1": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "property2": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    }
  },
  "webReport": {
    "allowPdfExport": true,
    "showInquiry": true,
    "batchExportDetails": {
      "canBatchExport": true,
      "picklistRefParam": "string"
    },
    "background": {
      "color": {},
      "image": {},
      "imageAttachment": "Scroll",
      "imagePosition": "Absolute",
      "imageTile": "None",
      "webreportId": 0,
      "x": 0,
      "y": 0,
      "opacity": 0
    },
    "defaultStyle": {
      "color": {},
      "font": {}
    },
    "directlyAccessible": true,
    "frameLayout": {
      "horizontalAlign": "Left",
      "verticalAlign": "Top",
      "type": "Frame",
      "childHeightPercents": [],
      "childWidthPercents": [],
      "frames": [],
      "name": "string",
      "numColumns": 0,
      "numRows": 0,
      "display": {}
    },
    "isLayoutLocked": true,
    "name": "string",
    "pdfOptions": {
      "autoScale": true,
      "customScaleValue": 0.1,
      "footerText": "string",
      "includePageNumber": true,
      "portraitOrientation": true,
      "showTotalPageNumber": true,
      "tableViewportWidth": 0.1
    },
    "sources": [
      {}
    ],
    "trees": [
      {}
    ],
    "version": {
      "rowVersion": 0
    },
    "webReportId": 0,
    "workflowObjectId": 0,
    "element": {},
    "styleCategory": "string"
  },
  "dependencies": [
    "string"
  ],
  "selectNames": [
    "string"
  ],
  "restrictions": {
    "constraintType": "clause",
    "op": "string",
    "dataFieldLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "caseSensitive": true,
    "constraints": [
      {}
    ],
    "literalRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "dataFieldRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "right": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "isPreciseDecimal": true,
    "like": "string",
    "escapeWildcards": true,
    "rowVersion": {
      "rowVersion": 0
    },
    "table": "string",
    "queryDefinitionRight": null
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webreports/preview',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/webreports/preview', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/webreports/preview',
  params: {
  }, headers: headers

p JSON.parse(result)

Return the HTML information required to render a preview of the web report passed in parameter.

Body parameter

{
  "payeeId": "string",
  "parameters": {
    "property1": "string",
    "property2": "string"
  },
  "webReport": {
    "allowPdfExport": true,
    "showInquiry": true,
    "batchExportDetails": {
      "canBatchExport": true,
      "picklistRefParam": "string"
    },
    "background": {
      "color": {},
      "image": {},
      "imageAttachment": "Scroll",
      "imagePosition": "Absolute",
      "imageTile": "None",
      "webreportId": 0,
      "x": 0,
      "y": 0,
      "opacity": 0
    },
    "defaultStyle": {
      "color": {},
      "font": {}
    },
    "directlyAccessible": true,
    "frameLayout": {
      "horizontalAlign": "Left",
      "verticalAlign": "Top",
      "type": "Frame",
      "childHeightPercents": [],
      "childWidthPercents": [],
      "frames": [],
      "name": "string",
      "numColumns": 0,
      "numRows": 0,
      "display": {}
    },
    "isLayoutLocked": true,
    "name": "string",
    "pdfOptions": {
      "autoScale": true,
      "customScaleValue": 0.1,
      "footerText": "string",
      "includePageNumber": true,
      "portraitOrientation": true,
      "showTotalPageNumber": true,
      "tableViewportWidth": 0.1
    },
    "sources": [
      {}
    ],
    "trees": [
      {}
    ],
    "version": {
      "rowVersion": 0
    },
    "webReportId": 0,
    "workflowObjectId": 0,
    "element": {},
    "styleCategory": "string"
  },
  "isFull": true,
  "retrieveBPMParams": true,
  "bpmTokenID": 0,
  "forWorkflow": true,
  "workflowID": 0,
  "timeZoneOffsetMinutes": 0,
  "signatures": {
    "property1": 0,
    "property2": 0
  }
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

ID of an existing web report in the model.

body

body

RESTAPI.v1.DTOs.WebReportHtmlPreviewRequestDTO

false

Definition of parameters and a web report. Does not have to be up to date with the version saved in the model.

» payeeId

body

string¦null

false

none

» parameters

body

object¦null

false

none

»» additionalProperties

body

string¦null

false

none

» webReport

body

Varicent.RESTAPI.v1.DTOs.WebReportDTO

false

none

»» allowPdfExport

body

boolean

false

none

»» showInquiry

body

boolean

false

none

»» batchExportDetails

body

Varicent.RESTAPI.v1.DTOs.WebReportBatchExportDetailsDTO

false

none

»»» canBatchExport

body

boolean

false

none

»»» picklistRefParam

body

string¦null

false

none

»» background

body

Varicent.RESTAPI.v1.DTOs.BackgroundDisplayDTO

false

none

»»» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»»» a

body

integer(int32)

false

none

»»»» b

body

integer(int32)

false

none

»»»» g

body

integer(int32)

false

none

»»»» r

body

integer(int32)

false

none

»»» image

body

Varicent.RESTAPI.v1.DTOs.ImageDisplayDTO

false

none

»»»» displayBorder

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»»» bottom

body

Varicent.RESTAPI.v1.DTOs.BorderDTO

false

none

»»»»»» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»»»»» width

body

number(float)

false

none

»»»»» left

body

Varicent.RESTAPI.v1.DTOs.BorderDTO

false

none

»»»»» right

body

Varicent.RESTAPI.v1.DTOs.BorderDTO

false

none

»»»»» top

body

Varicent.RESTAPI.v1.DTOs.BorderDTO

false

none

»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»»»» bottom

body

number(float)

false

none

»»»»» left

body

number(float)

false

none

»»»»» right

body

number(float)

false

none

»»»»» top

body

number(float)

false

none

»»»» gridType

body

string¦null

false

none

»»»» hoverText

body

string¦null

false

none

»»»» imageByteArray

body

string(byte)¦null

false

none

»»»» imageId

body

integer(int32)

false

none

»»»» imageLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»»» document

body

string¦null

false

none

»»»»» openInNewWindow

body

boolean

false

none

»»»»» parameters

body

object¦null

false

none

»»»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.LinkParameterValueDTO

false

none

»»»»»»» dataType

body

string

false

none

»»»»»»» source

body

string¦null

false

none

»»»»»»» type

body

string

false

none

»»»»»»» value

body

string¦null

false

none

»»»»» reportId

body

integer(int32)¦null

false

none

»»»»» targetId

body

integer(int32)

false

none

»»»»» targetType

body

string

false

none

»»»»» webFormId

body

integer(int32)¦null

false

none

»»»»» webTabId

body

integer(int32)¦null

false

none

»»»» imageType

body

string¦null

false

none

»»»» imageUrl

body

string¦null

false

none

»»»» expiryDate

body

string(date-time)¦null

false

none

»»»» cosObjectName

body

string¦null

false

none

»»»» name

body

string¦null

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DisplaySourceDTO

false

none

»»»»» name

body

string¦null

false

none

»»»» style

body

Varicent.RESTAPI.v1.DTOs.DataDisplayStyleDTO

false

none

»»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»» imageAttachment

body

string

false

none

»»» imagePosition

body

string

false

none

»»» imageTile

body

string

false

none

»»» webreportId

body

integer(int32)

false

none

»»» x

body

integer(int32)

false

none

»»» y

body

integer(int32)

false

none

»»» opacity

body

integer(int32)

false

none

»» defaultStyle

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»» font

body

Varicent.RESTAPI.v1.DTOs.FontDefinitionDTO

false

none

»»»» family

body

string¦null

false

none

»»»» size

body

number(float)

false

none

»»»» unit

body

string¦null

false

none

»»»» bold

body

boolean

false

none

»»»» italic

body

boolean

false

none

»»»» underline

body

boolean

false

none

»»»» strikeout

body

boolean

false

none

»» directlyAccessible

body

boolean

false

none

»» frameLayout

body

Varicent.RESTAPI.v1.DTOs.FrameableDTO

false

none

»»» horizontalAlign

body

string

false

none

»»» verticalAlign

body

string

false

none

»»» type

body

string

false

none

»»» childHeightPercents

body

[number]¦null

false

none

»»» childWidthPercents

body

[number]¦null

false

none

»»» frames

body

[array]¦null

false

none

»»»» anonymous

body

any

false

none

»»» name

body

string¦null

false

none

»»» numColumns

body

integer(int32)

false

none

»»» numRows

body

integer(int32)

false

none

»»» display

body

Varicent.RESTAPI.v1.DTOs.DataDisplayDTO

false

none

»»»» gridType

body

string¦null

false

none

»»»» name

body

string¦null

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DisplaySourceDTO

false

none

»»»» type

body

string

false

none

»»»» restrictSource

body

Varicent.RESTAPI.v1.DTOs.DisplaySourceDTO

false

none

»»»» restrictColumn

body

string¦null

false

none

»»»» style

body

Varicent.RESTAPI.v1.DTOs.DataDisplayStyleDTO

false

none

»»»» columnMap

body

object¦null

false

none

»»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.DataGridSourceColumnDTO

false

none

»»»»»» displayName

body

Varicent.RESTAPI.v1.DTOs.DataGridColumnDisplayNameDTO

false

none

»»»»»»» displayName

body

string¦null

false

none

»»»»»» dateFormat

body

Varicent.RESTAPI.v1.DTOs.PRDateFormatDTO

false

none

»»»»»»» style

body

string

false

none

»»»»»» pickListFilter

body

Varicent.RESTAPI.v1.DTOs.DataGridPicklistFilterDTO

false

none

»»»»»»» name

body

string¦null

false

none

»»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»»»»»»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»»»»»»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»»»»»»»» alias

body

string¦null

false

none

»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»» customSelect

body

string¦null

false

none

»»»»»»»»»» dataType

body

string

false

none

»»»»»»»»»» type

body

string

false

none

»»»»»»»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»»»»»»» constraintType

body

string

false

none

»»»»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»»»»» condition

body

any

false

none

»»»»»»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»»»»»»» literalType

body

string

false

none

»»»»»»»»»»»»»» value

body

any

false

none

»»»»»»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»»»»»»» constraints

body

array¦null

false

none

»»»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»»»» literalRight

body

any

false

none

»»»»»»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»»»»» right

body

any

false

none

»»»»»»»»»»»»» expressionLeft

body

any

false

none

»»»»»»»»»»»»» expressionRight

body

any

false

none

»»»»»»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»»»»»»» like

body

string¦null

false

none

»»»»»»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»»»»» literalType

body

string

false

none

»»»»»»»»»»»» value

body

any

false

none

»»»»»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»»»» literalType

body

string

false

none

»»»»»»»»»»» value

body

any

false

none

»»»»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»»»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»»»»»»»» m_namespace

body

string¦null

false

none

»»»»»»»»»»» name

body

string¦null

false

none

»»»»»»»»»» query

body

any

false

none

»»»»»»»»»» alias

body

string¦null

false

none

»»»»»»»»»» sourceType

body

string

false

none

»»»»»»»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»»»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»»»»»» joinType

body

string

false

none

»»»»»»»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»»»»»»» constraintType

body

string

false

none

»»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»»»»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»»»»» like

body

string¦null

false

none

»»»»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»»»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»»»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»» direction

body

string

false

none

»»»»»»»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»»»»» distinct

body

boolean

false

none

»»»»»»»»» unionWith

body

any

false

none

»»»»»»»»» exceptWith

body

any

false

none

»»»»»»»» sourceNames

body

object¦null

false

none

»»»»»»»»» additionalProperties

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»» defaultValue

body

string¦null

false

none

»»»»»» referencedFrequency

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»»»»»» levelId

body

string¦null

false

none

»»»»»»» timeId

body

string¦null

false

none

»»»»»» isEditable

body

boolean

false

none

»»»»»» picklistDisplayOptions

body

Varicent.RESTAPI.v1.DTOs.InputRowPicklistOptionsDTO

false

none

»»»»»»» description

body

string¦null

false

none

»»»»»»» order

body

string

false

none

»»»»»»» hideKey

body

boolean

false

none

»»»»»»» hideDescription

body

boolean

false

none

»»»»»»» sortById

body

boolean

false

none

»»»»»» order

body

integer(int32)

false

none

»»»»»» headerStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»»»» alignment

body

string

false

none

»»»»»»» backColor

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»»»»»» font

body

Varicent.RESTAPI.v1.DTOs.FontDefinitionDTO

false

none

»»»»»»» foreColor

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»»»»» formatRule

body

Varicent.RESTAPI.v1.DTOs.ConditionalFormatRuleDTO

false

none

»»»»»»» formats

body

[Varicent.RESTAPI.v1.DTOs.ConditionalFormatDTO]¦null

false

none

»»»»»»»» formula

body

string¦null

false

none

»»»»»»»» numericFormat

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»»»»»»»» scale

body

integer(int32)

false

none

»»»»»»»»» style

body

string

false

none

»»»»»»»» style

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»»» columnLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»»»» numericFormat

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»»»»» width

body

number(double)

false

none

»»»»»» initiallyShow

body

boolean

false

none

»»»»»» useRowTextAlignment

body

boolean

false

none

»»»»»» wrapText

body

boolean

false

none

»»»»»» maxWidth

body

integer(int32)

false

none

»»»»»» verticalAlignment

body

string

false

none

»»»» computedColumns

body

[Varicent.RESTAPI.v1.DTOs.DataGridComputedColumnDTO]¦null

false

none

»»»»» name

body

string¦null

false

none

»»»»» formula

body

string¦null

false

none

»»»»» order

body

integer(int32)

false

none

»»»»» headerStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» formatRule

body

Varicent.RESTAPI.v1.DTOs.ConditionalFormatRuleDTO

false

none

»»»»» columnLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»»» numericFormat

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»»»» width

body

number(double)

false

none

»»»»» initiallyShow

body

boolean

false

none

»»»»» useRowTextAlignment

body

boolean

false

none

»»»»» wrapText

body

boolean

false

none

»»»»» maxWidth

body

integer(int32)

false

none

»»»»» verticalAlignment

body

string

false

none

»»»» computedRow

body

object¦null

false

none

»»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.DataGridComputedRowCellDTO

false

none

»»»»»» columnDisplayName

body

string¦null

false

none

»»»»»» cellValue

body

string¦null

false

none

»»»»»» valueType

body

string

false

none

»»»»»» numericFormat

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»»» dataGridDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.DataGridDisplayStyleDTO

false

none

»»»»» headerStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» evenRowStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» oddRowStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» allowAlternateRowFont

body

boolean

false

none

»»»»» isHeaderVerticalAlignmentBottom

body

boolean

false

none

»»»»» computedRowStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» borderWidth

body

integer(int32)

false

none

»»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»»» dataGridInputRules

body

[Varicent.RESTAPI.v1.DTOs.DataGridInputRuleDTO]¦null

false

none

»»»»» id

body

integer(int32)

false

none

»»»»» dataGrid

body

string¦null

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» operatorType

body

string

false

none

»»»»» valueType

body

string

false

none

»»»»» value

body

any

false

none

»»»» dateFormat

body

Varicent.RESTAPI.v1.DTOs.PRDateFormatDTO

false

none

»»»» defaultPageSize

body

integer(int32)¦null

false

none

»»»» enableExportToExcel

body

boolean¦null

false

none

»»»» enableInquiryCopy

body

boolean¦null

false

none

»»»» enableShowHideColumns

body

boolean¦null

false

none

»»»» freezeTopRow

body

boolean¦null

false

none

»»»» hiddenColumnAliasMap

body

object¦null

false

none

»»»»» additionalProperties

body

string¦null

false

none

»»»» hiddenColumns

body

[Varicent.RESTAPI.v1.DTOs.DataGridHiddenColumnDTO]¦null

false

none

»»»»» order

body

integer(int32)

false

none

»»»»» name

body

string¦null

false

none

»»»»» type

body

string¦null

false

none

»»»» hiddenInputRowColumnMap

body

object¦null

false

none

»»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.DataGridSourceColumnDTO

false

none

»»»» inputRowAtTop

body

boolean¦null

false

none

»»»» isVertical

body

boolean¦null

false

none

»»»» numericStyle

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»»» paginated

body

boolean¦null

false

none

»»»» sections

body

[Varicent.RESTAPI.v1.DTOs.SectionDisplayDTO]¦null

false

none

»»»»» name

body

string¦null

false

none

»»»»» frequency

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»»»» sources

body

[Varicent.RESTAPI.v1.DTOs.SourceInfoDTO]¦null

false

none

»»»»»» columnMapping

body

object¦null

false

none

»»»»»»» additionalProperties

body

string¦null

false

none

»»»»»» valueColumn

body

string¦null

false

none

»»»»»» sourceName

body

string¦null

false

none

»»»»»» sectionStyle

body

Varicent.RESTAPI.v1.DTOs.ScalarDisplayStyleDTO

false

none

»»»»»»» style

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»»»»» format

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»»»»» dateFormat

body

Varicent.RESTAPI.v1.DTOs.PRDateFormatDTO

false

none

»»»»» sectionDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.ScalarDisplayStyleDTO

false

none

»»»» showOnlyInputRow

body

boolean¦null

false

none

»»»» showSectionHeader

body

boolean¦null

false

none

»»»» sortColumns

body

[Varicent.RESTAPI.v1.DTOs.DataGridSortColumnDTO]¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» sortDescending

body

boolean

false

none

»»»»» columnFrequency

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»»» suppressHeader

body

boolean¦null

false

none

»»»» hideRowBorders

body

boolean¦null

false

none

»»»» disableRowHighlighting

body

boolean¦null

false

none

»»»» suppressRepeatPartitionValues

body

boolean¦null

false

none

»»»» timeId

body

string¦null

false

none

»»»» validationRules

body

[Varicent.RESTAPI.v1.DTOs.WebReportValidationRuleDTO]¦null

false

none

»»»»» formula

body

string¦null

false

none

»»»»» errorMessage

body

string¦null

false

none

»»»» selectedTemplateId

body

integer(int32)¦null

false

none

»»»» columnWidths

body

[number]¦null

false

none

»»»» displays

body

[array]¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» fixedGridDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.FixedGridDisplayStyleDTO

false

none

»»»»» rowStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» borderWidth

body

integer(int32)

false

none

»»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»»» imageType

body

string¦null

false

none

»»»» imageLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»» imageId

body

integer(int32)¦null

false

none

»»»» imageByteArray

body

string(byte)¦null

false

none

»»»» hoverText

body

string¦null

false

none

»»»» imageUrl

body

string¦null

false

none

»»»» expiryDate

body

string(date-time)¦null

false

none

»»»» cosObjectName

body

string¦null

false

none

»»»» controlDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.ControlDisplayStyleDTO

false

none

»»»»» style

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»»» sortById

body

boolean¦null

false

none

»»»» sortAscending

body

boolean¦null

false

none

»»»» refParameter

body

string¦null

false

none

»»»» nameColumn

body

string¦null

false

none

»»»» idColumn

body

string¦null

false

none

»»»» hideValueForExport

body

boolean¦null

false

none

»»»» hideIdValues

body

boolean¦null

false

none

»»»» scalarDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.ScalarDisplayStyleDTO

false

none

»»»» scalarLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»» text

body

string¦null

false

none

»»»» documentId

body

integer(int32)¦null

false

none

»»»» buttonDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.ButtonDisplayStyleDTO

false

none

»»»»» style

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»»» cellStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»» agreementText

body

string¦null

false

none

»»»» format

body

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

»»»» conditionalFormatRule

body

Varicent.RESTAPI.v1.DTOs.ConditionalFormatRuleDTO

false

none

»»»» dateDisplayMode

body

string¦null

false

none

»»»» xAxisName

body

string¦null

false

none

»»»» yAxisName

body

string¦null

false

none

»»»» numberPrefix

body

string¦null

false

none

»»»» numberSuffix

body

string¦null

false

none

»»»» labelOrientation

body

string¦null

false

none

»»»» hideValues

body

boolean¦null

false

none

»»»» decimalSeparator

body

string¦null

false

none

»»»» thousandSeparator

body

string¦null

false

none

»»»» isPercentage

body

string¦null

false

none

»»»» numDecimals

body

string¦null

false

none

»»»» numberScaling

body

string¦null

false

none

»»»» showTitle

body

boolean¦null

false

none

»»»» yMinMax

body

boolean¦null

false

none

»»»» zMinMax

body

boolean¦null

false

none

»»»» yMin

body

string¦null

false

none

»»»» yMax

body

string¦null

false

none

»»»» zMin

body

string¦null

false

none

»»»» zMax

body

string¦null

false

none

»»»» dontTrimBarLabel

body

string¦null

false

none

»»»» defaultLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»» entityLinkMap

body

object¦null

false

none

»»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»» fusionSource

body

Varicent.RESTAPI.v1.DTOs.FusionSourceDTO

false

none

»»»»» type

body

string

false

none

»»»»» sorted

body

boolean

false

none

»»»»» descending

body

boolean

false

none

»»»»» sortedByName

body

boolean

false

none

»»»»» sourceName

body

string¦null

false

none

»»»»» chartLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»»» displayColumn

body

string¦null

false

none

»»»»» valueColumn

body

string¦null

false

none

»»»»» sourceAlias

body

string¦null

false

none

»»»»» sortingInfo

body

Varicent.RESTAPI.v1.DTOs.SortingInfoDTO

false

none

»»»»»» levelId

body

string¦null

false

none

»»»»»» sortDescending

body

boolean

false

none

»»»»»» timeId

body

string¦null

false

none

»»»»»» sortedByName

body

boolean

false

none

»»»»» xColumn

body

string¦null

false

none

»»»»» yColumn

body

string¦null

false

none

»»»»» zColumn

body

string¦null

false

none

»»»»» renderAs

body

string¦null

false

none

»»»»» isPrimaryAxis

body

boolean¦null

false

none

»»»»» entityColumn

body

string¦null

false

none

»»»»» sources

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» minValueSourceName

body

string¦null

false

none

»»»»» maxValueSourceName

body

string¦null

false

none

»»»»» currentValueSourceName

body

string¦null

false

none

»»»»» trendpointValueSourceName

body

string¦null

false

none

»»»» fusionStyles

body

Varicent.RESTAPI.v1.DTOs.FusionStyleSetDTO

false

none

»»»»» type

body

string

false

none

»»»»» title

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»»» xAxisName

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»»» yAxisName

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»»» xAxisValues

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»»» yAxisValues

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»»» legend

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»»» syAxisName

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»»» syAxisValues

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»»» labels

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»»» tickValues

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»»» pointerOrFill

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»» fusionTheme

body

string¦null

false

none

»»»» height

body

integer(int32)¦null

false

none

»»»» legendPosition

body

string¦null

false

none

»»»» mapDisplayType

body

string¦null

false

none

»»»» mapValueRanges

body

[Varicent.RESTAPI.v1.DTOs.ColorValueRangeDTO]¦null

false

none

»»»»» label

body

string¦null

false

none

»»»»» min

body

number(double)

false

none

»»»»» max

body

number(double)

false

none

»»»»» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»»» showLegend

body

boolean¦null

false

none

»»»» width

body

integer(int32)¦null

false

none

»»»» ssChartDisplayType

body

string¦null

false

none

»»»» chartLink

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»» customColors

body

[Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO]¦null

false

none

»»»» msChartDisplayType

body

string¦null

false

none

»»»» syAxisName

body

string¦null

false

none

»»»» syNumberPrefix

body

string¦null

false

none

»»»» syNumberSuffix

body

string¦null

false

none

»»»» hideSyValues

body

boolean¦null

false

none

»»»» centerValues

body

boolean¦null

false

none

»»»» syDecimalSeparator

body

string¦null

false

none

»»»» syThousandSeparator

body

string¦null

false

none

»»»» isSyPercentage

body

string¦null

false

none

»»»» syNumDecimals

body

string¦null

false

none

»»»» syNumberScaling

body

string¦null

false

none

»»»» lowerLimitDisplayName

body

string¦null

false

none

»»»» upperLimitDisplayName

body

string¦null

false

none

»»»» valueToolTip

body

string¦null

false

none

»»»» gaugeDisplayType

body

string¦null

false

none

»»»» link

body

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

»»»» limitLabelFillColor

body

string¦null

false

none

»»»» gaugeValueRanges

body

[Varicent.RESTAPI.v1.DTOs.ColorValueRangeDTO]¦null

false

none

»»»» trendpoint

body

Varicent.RESTAPI.v1.DTOs.TrendpointDTO

false

none

»»»»» label

body

string¦null

false

none

»»»»» labelStyle

body

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

»»»»» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»»» gaugeStartAngle

body

number(double)¦null

false

none

»»»» gaugeEndAngle

body

number(double)¦null

false

none

»»»» fillColor

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»»» status

body

string¦null

false

none

»»»» enableHeaders

body

boolean¦null

false

none

»»»» workflowLinkDisplayStyle

body

Varicent.RESTAPI.v1.DTOs.WorkflowLinkDisplayStyleDTO

false

none

»»»»» headerStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» primaryStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» secondaryStyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»»» columns

body

[string]¦null

false

none

»» isLayoutLocked

body

boolean

false

none

»» name

body

string¦null

false

none

»» pdfOptions

body

Varicent.RESTAPI.v1.DTOs.WebReportPdfOptionsDTO

false

none

»»» autoScale

body

boolean

false

none

»»» customScaleValue

body

number(double)

false

none

»»» footerText

body

string¦null

false

none

»»» includePageNumber

body

boolean

false

none

»»» portraitOrientation

body

boolean

false

none

»»» showTotalPageNumber

body

boolean

false

none

»»» tableViewportWidth

body

number(double)¦null

false

none

»» sources

body

[Varicent.RESTAPI.v1.DTOs.ReportSourceDTO]¦null

false

none

»»» dependencies

body

[string]¦null

false

none

»»» name

body

string¦null

false

none

»»» type

body

string

false

none

»»» scalarType

body

string¦null

false

none

»»» value

body

any

false

none

»»» column

body

string¦null

false

none

»»» keyValues

body

object¦null

false

none

»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.ReportVariableDTO

false

none

»»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» variableName

body

string¦null

false

none

»»»»» variableType

body

string

false

none

»»» table

body

string¦null

false

none

»»» expression

body

string¦null

false

none

»»» variables

body

[string]¦null

false

none

»»» required

body

boolean

false

none

»»» useWebUser

body

boolean

false

none

»»» isParameterValueScalar

body

boolean

false

none

»»» parameterValue

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»» parameterId

body

integer(int32)

false

none

»»» columnNames

body

[string]¦null

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»» formula

body

string¦null

false

none

»»» partitionColumns

body

[string]¦null

false

none

»»» timeEnd

body

string(date-time)

false

none

»»» timeFrequency

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»» timePartition

body

string¦null

false

none

»»» timeStart

body

string(date-time)

false

none

»»» newColumnName

body

string¦null

false

none

»»» keyColumns

body

[string]¦null

false

none

»»» newColumns

body

[string]¦null

false

none

»»» transposeColumn

body

string¦null

false

none

»» trees

body

[Varicent.RESTAPI.v1.DTOs.ReportTreeNodeDTO]¦null

false

none

»»» name

body

string¦null

false

none

»»» parent

body

string¦null

false

none

»»» parentNodeType

body

string¦null

false

none

»»» treeNodeType

body

string

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» webReportId

body

integer(int32)

false

none

»» workflowObjectId

body

integer(int32)

false

none

»» element

body

Varicent.RESTAPI.v1.DTOs.IExpandableResourceDTO

false

none

»» styleCategory

body

string¦null

false

none

» isFull

body

boolean

false

none

» retrieveBPMParams

body

boolean

false

none

» bpmTokenID

body

integer(int32)

false

none

» forWorkflow

body

boolean

false

none

» workflowID

body

integer(int32)

false

none

» timeZoneOffsetMinutes

body

integer(int32)

false

none

» signatures

body

object¦null

false

none

»» additionalProperties

body

integer(int32)¦null

false

none

Enumerated Values

Parameter

Value

»»»»»»» dataType

Report

»»»»»»» dataType

Form

»»»»»»» dataType

String

»»»»»»» dataType

DateTime

»»»»»»» dataType

Decimal

»»»»»»» dataType

Integer

»»»»»»» type

Scalar

»»»»»»» type

RowValue

»»»»»»» type

Constant

»»»»» targetType

WebReport

»»»»» targetType

WebForm

»»»»» targetType

URL

»»» imageAttachment

Scroll

»»» imageAttachment

Fixed

»»» imagePosition

Absolute

»»» imagePosition

Percent

»»» imagePosition

LeftTop

»»» imagePosition

LeftCenter

»»» imagePosition

LeftBottom

»»» imagePosition

RightTop

»»» imagePosition

RightCenter

»»» imagePosition

RightBottom

»»» imagePosition

CenterTop

»»» imagePosition

CenterCenter

»»» imagePosition

CenterBottom

»»» imageTile

None

»»» imageTile

Vertical

»»» imageTile

Horizontal

»»» imageTile

Both

»»» horizontalAlign

Left

»»» horizontalAlign

Middle

»»» horizontalAlign

Right

»»» verticalAlign

Top

»»» verticalAlign

Middle

»»» verticalAlign

Bottom

»»» type

Frame

»»» type

Content

»»»» type

DataGridDisplay

»»»» type

FixedGridDisplay

»»»» type

ImageDisplay

»»»» type

MapDisplay

»»»» type

MultiSeriesChartDisplay

»»»» type

PickListControl

»»»» type

QuickTextDisplay

»»»» type

DocumentLinkDisplay

»»»» type

SingleSeriesChartDisplay

»»»» type

SubmitButtonDisplay

»»»» type

TextControl

»»»» type

SignatureControl

»»»» type

TextScalarDisplay

»»»» type

NumericScalarDisplay

»»»» type

DateScalarDisplay

»»»» type

CylinderGaugeDisplay

»»»» type

HLinearGaugeDisplay

»»»» type

AngularGaugeDisplay

»»»» type

WorkflowLinkControl

»»»»»»» style

Date

»»»»»»» style

DateTime

»»»»»»»»»» dataType

Int

»»»»»»»»»» dataType

Decimal

»»»»»»»»»» dataType

DateTime

»»»»»»»»»» dataType

None

»»»»»»»»»» dataType

String

»»»»»»»»»» type

SelectAll

»»»»»»»»»» type

SelectItem

»»»»»»»»»» type

SelectLiteral

»»»»»»»»»» type

SelectCustom

»»»»»»»»»» type

SelectExpression

»»»»»»»»»»» expressionType

caseExpression

»»»»»»»»»»» expressionType

dataField

»»»»»»»»»»» expressionType

function

»»»»»»»»»»» expressionType

ifExpression

»»»»»»»»»»» expressionType

literal

»»»»»»»»»»»» expressionType

caseExpression

»»»»»»»»»»»» expressionType

dataField

»»»»»»»»»»»» expressionType

function

»»»»»»»»»»»» expressionType

ifExpression

»»»»»»»»»»»» expressionType

literal

»»»»»»»»»»»»» constraintType

clause

»»»»»»»»»»»»» constraintType

constraint

»»»»»»»»»»»»» constraintType

expressionConstraint

»»»»»»»»»»»»» constraintType

likeConstraint

»»»»»»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»»»»»»» constraintType

subQueryConstraint

»»»»»»»»»»»»»» expressionType

caseExpression

»»»»»»»»»»»»»» expressionType

dataField

»»»»»»»»»»»»»» expressionType

function

»»»»»»»»»»»»»» expressionType

ifExpression

»»»»»»»»»»»»»» expressionType

literal

»»»»»»»»»»»»»» literalType

Integer

»»»»»»»»»»»»»» literalType

Decimal

»»»»»»»»»»»»»» literalType

Date

»»»»»»»»»»»»»» literalType

DateTime

»»»»»»»»»»»»»» literalType

String

»»»»»»»»»»»»»» literalType

Float

»»»»»»»»»»»»»» literalType

Long

»»»»»»»»»»»»»» literalType

Null

»»»»»»»»»»»»»» literalType

Parameter

»»»»»»»»»»»»»» literalType

Guid

»»»»»»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»»»»»»» literalType

Boolean

»»»»»»»»»»»» literalType

Integer

»»»»»»»»»»»» literalType

Decimal

»»»»»»»»»»»» literalType

Date

»»»»»»»»»»»» literalType

DateTime

»»»»»»»»»»»» literalType

String

»»»»»»»»»»»» literalType

Float

»»»»»»»»»»»» literalType

Long

»»»»»»»»»»»» literalType

Null

»»»»»»»»»»»» literalType

Parameter

»»»»»»»»»»»» literalType

Guid

»»»»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»»»»» literalType

Boolean

»»»»»»»»»»» literalType

Integer

»»»»»»»»»»» literalType

Decimal

»»»»»»»»»»» literalType

Date

»»»»»»»»»»» literalType

DateTime

»»»»»»»»»»» literalType

String

»»»»»»»»»»» literalType

Float

»»»»»»»»»»» literalType

Long

»»»»»»»»»»» literalType

Null

»»»»»»»»»»» literalType

Parameter

»»»»»»»»»»» literalType

Guid

»»»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»»»» literalType

Boolean

»»»»»»»»»» sourceType

Table

»»»»»»»»»» sourceType

Query

»»»»»»»»»» joinType

Inner

»»»»»»»»»» joinType

Left

»»»»»»»»»» joinType

Right

»»»»»»»»»» joinType

Cross

»»»»»»»»»» joinType

CrossApply

»»»»»»»»»» joinType

OuterApply

»»»»»»»»»»» constraintType

clause

»»»»»»»»»»» constraintType

constraint

»»»»»»»»»»» constraintType

expressionConstraint

»»»»»»»»»»» constraintType

likeConstraint

»»»»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»»»»» constraintType

subQueryConstraint

»»»»»»»»»» direction

Ascending

»»»»»»»»»» direction

Descending

»»»»»»»»»» direction

AscendingNullsFirst

»»»»»»»»»» direction

DescendingNullsLast

»»»»»»» order

Ascending

»»»»»»» order

Descending

»»»»»»» alignment

Justify

»»»»»»» alignment

Left

»»»»»»» alignment

Center

»»»»»»» alignment

Right

»»»»»»»»» style

Number

»»»»»»»»» style

Percent

»»»»»»»»» style

Dollars

»»»»»»»»» style

FrenchCanadianDollars

»»»»»»»»» style

Pounds

»»»»»»»»» style

Euro

»»»»»»»»» style

Yen

»»»»»»»»» style

Yuan

»»»»»»»»» style

Rand

»»»»»»»»» style

BrazilianReal

»»»»»»»»» style

Rupee

»»»»»»»»» style

SingaporeanDollar

»»»»»»»»» style

AustralianDollar

»»»»»»»»» style

Won

»»»»»» verticalAlignment

Top

»»»»»» verticalAlignment

Middle

»»»»»» verticalAlignment

Bottom

»»»»» verticalAlignment

Top

»»»»» verticalAlignment

Middle

»»»»» verticalAlignment

Bottom

»»»»»» valueType

Text

»»»»»» valueType

Formula

»»»»» operatorType

LessThan

»»»»» operatorType

LessThanEquals

»»»»» operatorType

Equals

»»»»» operatorType

NotEquals

»»»»» operatorType

GreaterThan

»»»»» operatorType

GreaterThanEquals

»»»»» operatorType

IsNull

»»»»» operatorType

IsNotNull

»»»»» valueType

String

»»»»» valueType

Numeric

»»»»» valueType

Date

»»»»» valueType

Field

»»»»» valueType

Scalar

»»»» dateDisplayMode

ShortDate

»»»» dateDisplayMode

LongDate

»»»» labelOrientation

Horizontal

»»»» labelOrientation

Vertical

»»»» labelOrientation

Slanted

»»»»» type

ComboSource

»»»»» type

DisplayValueSource

»»»»» type

DYComboSource

»»»»» type

MapSource

»»»»» type

MSComboSource

»»»»» type

MSDisplayValueSource

»»»»» type

MSDYComboSource

»»»»» type

MSXYSource

»»»»» type

MSXYZSource

»»»»» type

AngularGaugeSource

»»»»» type

HLinearGaugeSource

»»»»» type

CylinderGaugeSource

»»»»» type

XYSource

»»»»» type

XYZSource

»»»»» renderAs

Column

»»»»» renderAs

Area

»»»»» renderAs

Line

»»»»» type

SingleSeriesChartStyleSet

»»»»» type

MultiSeriesChartStyleSet

»»»»» type

MapStyleSet

»»»»» type

GaugeStyleSet

»»»» fusionTheme

Classic

»»»» fusionTheme

Solid

»»»» legendPosition

Bottom

»»»» legendPosition

Right

»»»» mapDisplayType

Afghanistan

»»»» mapDisplayType

Africa

»»»» mapDisplayType

Alabama

»»»» mapDisplayType

Alaska

»»»» mapDisplayType

Albania

»»»» mapDisplayType

Alberta

»»»» mapDisplayType

Algeria

»»»» mapDisplayType

Andorra

»»»» mapDisplayType

Angola

»»»» mapDisplayType

Antigua

»»»» mapDisplayType

Argentina

»»»» mapDisplayType

Arizona

»»»» mapDisplayType

Arkansas

»»»» mapDisplayType

Armenia

»»»» mapDisplayType

Asia

»»»» mapDisplayType

Asia3

»»»» mapDisplayType

AsiaGeorgia

»»»» mapDisplayType

Australia

»»»» mapDisplayType

Australia2

»»»» mapDisplayType

Austria

»»»» mapDisplayType

Azerbaijan

»»»» mapDisplayType

Bahamas

»»»» mapDisplayType

Bahrain

»»»» mapDisplayType

Bangladesh

»»»» mapDisplayType

Barbados

»»»» mapDisplayType

Belarus

»»»» mapDisplayType

Belgium

»»»» mapDisplayType

Belize

»»»» mapDisplayType

Benin

»»»» mapDisplayType

Bhutan

»»»» mapDisplayType

Bolivia

»»»» mapDisplayType

BosniaHerzegovina

»»»» mapDisplayType

Botswana

»»»» mapDisplayType

Brazil

»»»» mapDisplayType

BrazilRegion

»»»» mapDisplayType

BritishColumbia

»»»» mapDisplayType

Brunei

»»»» mapDisplayType

Bulgaria

»»»» mapDisplayType

BurkinaFaso

»»»» mapDisplayType

Burma

»»»» mapDisplayType

Burundi

»»»» mapDisplayType

California

»»»» mapDisplayType

Cambodia

»»»» mapDisplayType

Cameroon

»»»» mapDisplayType

Canada

»»»» mapDisplayType

CapeVerde

»»»» mapDisplayType

CaymanIslands

»»»» mapDisplayType

CentralAfricanRepublic

»»»» mapDisplayType

CentralAmerica

»»»» mapDisplayType

CentralAmerica2

»»»» mapDisplayType

CentralAmericawithCaribbean

»»»» mapDisplayType

CentralEuropeanRegion

»»»» mapDisplayType

Chad

»»»» mapDisplayType

Chile

»»»» mapDisplayType

China

»»»» mapDisplayType

China2

»»»» mapDisplayType

Colombia

»»»» mapDisplayType

Colorado

»»»» mapDisplayType

Comoros

»»»» mapDisplayType

Congo

»»»» mapDisplayType

Connecticut

»»»» mapDisplayType

CostaRica

»»»» mapDisplayType

CoteDivoire

»»»» mapDisplayType

Croatia

»»»» mapDisplayType

Cuba

»»»» mapDisplayType

Cyprus

»»»» mapDisplayType

Cyprus2

»»»» mapDisplayType

CzechRepublic

»»»» mapDisplayType

Delaware

»»»» mapDisplayType

DemocraticRepublicofCongo

»»»» mapDisplayType

Denmark

»»»» mapDisplayType

DenmarkRegion

»»»» mapDisplayType

DistrictofColumbia

»»»» mapDisplayType

Djibouti

»»»» mapDisplayType

Dominica

»»»» mapDisplayType

DominicanRepublic

»»»» mapDisplayType

EastEuropeanRegion

»»»» mapDisplayType

EastTimor

»»»» mapDisplayType

Ecuador

»»»» mapDisplayType

Egypt

»»»» mapDisplayType

ElSalvador

»»»» mapDisplayType

England

»»»» mapDisplayType

EnglandRegion

»»»» mapDisplayType

EquatorialGuinea

»»»» mapDisplayType

Eritrea

»»»» mapDisplayType

Estonia

»»»» mapDisplayType

Ethiopia

»»»» mapDisplayType

Europe

»»»» mapDisplayType

Europe2

»»»» mapDisplayType

EuropeRegion

»»»» mapDisplayType

Europewithcountries

»»»» mapDisplayType

FalklandIsland

»»»» mapDisplayType

Fiji

»»»» mapDisplayType

Finland

»»»» mapDisplayType

Florida

»»»» mapDisplayType

France

»»»» mapDisplayType

FranceDepartment

»»»» mapDisplayType

FrenchGuiana

»»»» mapDisplayType

Gabon

»»»» mapDisplayType

Gambia

»»»» mapDisplayType

Georgia

»»»» mapDisplayType

Germany

»»»» mapDisplayType

Ghana

»»»» mapDisplayType

Greece

»»»» mapDisplayType

Greenland

»»»» mapDisplayType

Grenada

»»»» mapDisplayType

Guatemala

»»»» mapDisplayType

Guinea

»»»» mapDisplayType

GuineaBissau

»»»» mapDisplayType

Guyana

»»»» mapDisplayType

Haiti

»»»» mapDisplayType

Hawaii

»»»» mapDisplayType

Honduras

»»»» mapDisplayType

HongKong

»»»» mapDisplayType

Hungary

»»»» mapDisplayType

HungaryRegions

»»»» mapDisplayType

Iceland

»»»» mapDisplayType

Idaho

»»»» mapDisplayType

Illinois

»»»» mapDisplayType

India

»»»» mapDisplayType

Indiana

»»»» mapDisplayType

Indonesia

»»»» mapDisplayType

Iowa

»»»» mapDisplayType

Iran

»»»» mapDisplayType

Iraq

»»»» mapDisplayType

Ireland

»»»» mapDisplayType

Israel

»»»» mapDisplayType

Italy

»»»» mapDisplayType

Jamaica

»»»» mapDisplayType

Japan

»»»» mapDisplayType

Jordan

»»»» mapDisplayType

Kansas

»»»» mapDisplayType

Kazakhstan

»»»» mapDisplayType

Kentucky

»»»» mapDisplayType

Kenya

»»»» mapDisplayType

Kiribati

»»»» mapDisplayType

KosovoDistricts

»»»» mapDisplayType

Kuwait

»»»» mapDisplayType

Kyrgyzstan

»»»» mapDisplayType

Laos

»»»» mapDisplayType

Latvia

»»»» mapDisplayType

Lebanon

»»»» mapDisplayType

Lesotho

»»»» mapDisplayType

Liberia

»»»» mapDisplayType

Libya

»»»» mapDisplayType

Liechtenstein

»»»» mapDisplayType

Lithuania

»»»» mapDisplayType

Louisiana

»»»» mapDisplayType

Luxembourg

»»»» mapDisplayType

Macau

»»»» mapDisplayType

Macedonia

»»»» mapDisplayType

Madagascar

»»»» mapDisplayType

MadagascarRegions

»»»» mapDisplayType

Maine

»»»» mapDisplayType

Malawi

»»»» mapDisplayType

Malaysia

»»»» mapDisplayType

Mali

»»»» mapDisplayType

Malta

»»»» mapDisplayType

Manitoba

»»»» mapDisplayType

MarshallIsland

»»»» mapDisplayType

Maryland

»»»» mapDisplayType

Massachusetts

»»»» mapDisplayType

Mauritania

»»»» mapDisplayType

Mauritius

»»»» mapDisplayType

Mexico

»»»» mapDisplayType

Michigan

»»»» mapDisplayType

Micronesia

»»»» mapDisplayType

MiddleEast

»»»» mapDisplayType

Minnesota

»»»» mapDisplayType

Mississippi

»»»» mapDisplayType

Missouri

»»»» mapDisplayType

Moldova

»»»» mapDisplayType

Monaco

»»»» mapDisplayType

Mongolia

»»»» mapDisplayType

Montana

»»»» mapDisplayType

Montenegro

»»»» mapDisplayType

Morocco

»»»» mapDisplayType

Mozambique

»»»» mapDisplayType

Namibia

»»»» mapDisplayType

Nauru

»»»» mapDisplayType

Nebraska

»»»» mapDisplayType

Nepal

»»»» mapDisplayType

Netherlands

»»»» mapDisplayType

Nevada

»»»» mapDisplayType

NewBrunswick

»»»» mapDisplayType

NewCaledonia

»»»» mapDisplayType

NewfoundlandandLabrador

»»»» mapDisplayType

NewHampshire

»»»» mapDisplayType

NewJersey

»»»» mapDisplayType

NewMexico

»»»» mapDisplayType

NewYork

»»»» mapDisplayType

NewZealand

»»»» mapDisplayType

Nicaragua

»»»» mapDisplayType

Niger

»»»» mapDisplayType

Nigeria

»»»» mapDisplayType

NorthAmerica

»»»» mapDisplayType

NorthAmericaWOCentral

»»»» mapDisplayType

NorthCarolina

»»»» mapDisplayType

NorthDakota

»»»» mapDisplayType

NorthEuropeanRegion

»»»» mapDisplayType

NorthernIreland

»»»» mapDisplayType

NorthKorea

»»»» mapDisplayType

NorthWestTerritories

»»»» mapDisplayType

Norway

»»»» mapDisplayType

NorwayRegion

»»»» mapDisplayType

NovaScotia

»»»» mapDisplayType

Nunavut

»»»» mapDisplayType

Oceania

»»»» mapDisplayType

Ohio

»»»» mapDisplayType

Oklahoma

»»»» mapDisplayType

Oman

»»»» mapDisplayType

Ontario

»»»» mapDisplayType

Oregon

»»»» mapDisplayType

Pakistan

»»»» mapDisplayType

Palau

»»»» mapDisplayType

Panama

»»»» mapDisplayType

PapuaNewGuinea

»»»» mapDisplayType

Paraguay

»»»» mapDisplayType

Pennsylvania

»»»» mapDisplayType

Peru

»»»» mapDisplayType

Philippines

»»»» mapDisplayType

Poland

»»»» mapDisplayType

PolandCounties

»»»» mapDisplayType

Portugal

»»»» mapDisplayType

PrinceEdwardIsland

»»»» mapDisplayType

PuertoRico

»»»» mapDisplayType

Qatar

»»»» mapDisplayType

Quebec

»»»» mapDisplayType

RhodeIsland

»»»» mapDisplayType

Romania

»»»» mapDisplayType

Russia

»»»» mapDisplayType

Rwanda

»»»» mapDisplayType

SaintKittsandNevis

»»»» mapDisplayType

SaintLucia

»»»» mapDisplayType

SaintVincentandtheGrenadines

»»»» mapDisplayType

Samoa

»»»» mapDisplayType

SanMarino

»»»» mapDisplayType

SaoTomeandPrincipe

»»»» mapDisplayType

Saskatchewan

»»»» mapDisplayType

SaudiArabia

»»»» mapDisplayType

Scotland

»»»» mapDisplayType

ScotlandRegion

»»»» mapDisplayType

Senegal

»»»» mapDisplayType

Serbia

»»»» mapDisplayType

SerbiaWoKosovo

»»»» mapDisplayType

Seychelles

»»»» mapDisplayType

SierraLeone

»»»» mapDisplayType

Singapore

»»»» mapDisplayType

Slovakia

»»»» mapDisplayType

Slovenia

»»»» mapDisplayType

SolomonIsland

»»»» mapDisplayType

Somalia

»»»» mapDisplayType

SouthAfrica

»»»» mapDisplayType

SouthAmerica

»»»» mapDisplayType

SouthCarolina

»»»» mapDisplayType

SouthDakota

»»»» mapDisplayType

SouthEuropeanRegion

»»»» mapDisplayType

SouthKorea

»»»» mapDisplayType

SouthSudan

»»»» mapDisplayType

Spain

»»»» mapDisplayType

SpainProvinces

»»»» mapDisplayType

SriLanka

»»»» mapDisplayType

Sudan

»»»» mapDisplayType

SudanWoSouthSudan

»»»» mapDisplayType

Suriname

»»»» mapDisplayType

Swaziland

»»»» mapDisplayType

Sweden

»»»» mapDisplayType

Switzerland

»»»» mapDisplayType

Syria

»»»» mapDisplayType

Taiwan

»»»» mapDisplayType

Tajikistan

»»»» mapDisplayType

Tanzania

»»»» mapDisplayType

Tennessee

»»»» mapDisplayType

Texas

»»»» mapDisplayType

Thailand

»»»» mapDisplayType

Tibet

»»»» mapDisplayType

Togo

»»»» mapDisplayType

Tonga

»»»» mapDisplayType

TrinidadandTobago

»»»» mapDisplayType

Tunisia

»»»» mapDisplayType

Turkey

»»»» mapDisplayType

Turkmenistan

»»»» mapDisplayType

Tuvalu

»»»» mapDisplayType

UAE

»»»» mapDisplayType

Uganda

»»»» mapDisplayType

UK

»»»» mapDisplayType

UK7

»»»» mapDisplayType

Ukraine

»»»» mapDisplayType

Uruguay

»»»» mapDisplayType

USA

»»»» mapDisplayType

USACentralRegion

»»»» mapDisplayType

USANorthEastRegion

»»»» mapDisplayType

USANorthWestRegion

»»»» mapDisplayType

USARegion

»»»» mapDisplayType

USASouthEastRegion

»»»» mapDisplayType

USASouthWestRegion

»»»» mapDisplayType

Utah

»»»» mapDisplayType

Uzbekistan

»»»» mapDisplayType

Vanuatu

»»»» mapDisplayType

VaticanCity

»»»» mapDisplayType

Venezuela

»»»» mapDisplayType

Vermont

»»»» mapDisplayType

Vietnam

»»»» mapDisplayType

Virginia

»»»» mapDisplayType

Wales

»»»» mapDisplayType

Washington

»»»» mapDisplayType

WesternSahara

»»»» mapDisplayType

WestEuropeanRegion

»»»» mapDisplayType

WestVirginia

»»»» mapDisplayType

Wisconsin

»»»» mapDisplayType

World

»»»» mapDisplayType

World8

»»»» mapDisplayType

World8WithAntarctica

»»»» mapDisplayType

WorldWithAntarctica

»»»» mapDisplayType

WorldwithCountries

»»»» mapDisplayType

Wyoming

»»»» mapDisplayType

Yemen

»»»» mapDisplayType

YukonTerritory

»»»» mapDisplayType

Zambia

»»»» mapDisplayType

Zimbabwe

»»»» ssChartDisplayType

Area2D

»»»» ssChartDisplayType

Bar2D

»»»» ssChartDisplayType

Column2D

»»»» ssChartDisplayType

Column3D

»»»» ssChartDisplayType

Doughnut2D

»»»» ssChartDisplayType

Doughnut3D

»»»» ssChartDisplayType

Funnel

»»»» ssChartDisplayType

Pyramid

»»»» ssChartDisplayType

Line

»»»» ssChartDisplayType

Pie2D

»»»» ssChartDisplayType

Pie3D

»»»» ssChartDisplayType

Spline

»»»» ssChartDisplayType

SplineArea

»»»» ssChartDisplayType

Waterfall2D

»»»» ssChartDisplayType

Kagi

»»»» msChartDisplayType

MSArea

»»»» msChartDisplayType

InverseMSArea

»»»» msChartDisplayType

ScrollArea2D

»»»» msChartDisplayType

MSBar2D

»»»» msChartDisplayType

MSColumn2D

»»»» msChartDisplayType

InverseMSColumn2D

»»»» msChartDisplayType

ScrollColumn2D

»»»» msChartDisplayType

LogMSColumn2D

»»»» msChartDisplayType

MSColumn3D

»»»» msChartDisplayType

MSLine

»»»» msChartDisplayType

InverseMSLine

»»»» msChartDisplayType

ScrollLine2D

»»»» msChartDisplayType

LogMSLine

»»»» msChartDisplayType

StackedArea2D

»»»» msChartDisplayType

StackedBar2D

»»»» msChartDisplayType

StackedBar3D

»»»» msChartDisplayType

StackedColumn2D

»»»» msChartDisplayType

ScrollStackedColumn2D

»»»» msChartDisplayType

StackedColumn3D

»»»» msChartDisplayType

MSSpline

»»»» msChartDisplayType

MSSplineArea

»»»» msChartDisplayType

Radar

»»»» msChartDisplayType

Scatter

»»»» msChartDisplayType

Bubble

»»»» msChartDisplayType

MSCombi2D

»»»» msChartDisplayType

MSCombi3D

»»»» msChartDisplayType

MSColumnLine3D

»»»» msChartDisplayType

MSCombiDY2D

»»»» msChartDisplayType

MSColumn3DLineDY

»»»» msChartDisplayType

StackedColumn3DLineDY

»»»» gaugeDisplayType

AngularGauge

»»»» gaugeDisplayType

Cylinder

»»»» gaugeDisplayType

HLinearGauge

»»»» status

Available

»»»» status

Pending

»»»» status

Closed

»»»» columns

WorkflowID

»»»» columns

WorkflowName

»»»» columns

WorkflowDescription

»»»» columns

ReportName

»»»» columns

WebReportID

»»»» columns

ActionName

»»»» columns

SubmittedBy

»»»» columns

SubmittedByName

»»»» columns

DateReceived

»»»» columns

TokenID

»»»» columns

Initiator

»»»» columns

InitiatorName

»»»» columns

DateOfInitiation

»»»» columns

DateOfCompletion

»»» type

AggregateTransformation

»»» type

ComputedColumn

»»» type

InputRowSource

»»» type

QuerySource

»»» type

TransposedSource

»»» type

StaticScalar

»»» type

ValueScalar

»»» type

ComputedScalar

»»» type

Parameter

»»»»» variableType

Literal

»»»»» variableType

Parameter

»»»»» variableType

Scalar

»»» treeNodeType

Folder

»»» treeNodeType

Source

»»» treeNodeType

ParameterRoot

»»» treeNodeType

ScalarRoot

»»» treeNodeType

SourceRoot

»»» treeNodeType

EditableSourceRoot

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.WebReportHtmlPreviewDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/webreports/{id}/htmlpreview", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webreports/{id}/htmlpreview");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "payeeId": "string",
  "parameters": {
    "property1": "string",
    "property2": "string"
  },
  "webReport": {
    "allowPdfExport": true,
    "showInquiry": true,
    "batchExportDetails": {
      "canBatchExport": true,
      "picklistRefParam": "string"
    },
    "background": {
      "color": {},
      "image": {},
      "imageAttachment": "Scroll",
      "imagePosition": "Absolute",
      "imageTile": "None",
      "webreportId": 0,
      "x": 0,
      "y": 0,
      "opacity": 0
    },
    "defaultStyle": {
      "color": {},
      "font": {}
    },
    "directlyAccessible": true,
    "frameLayout": {
      "horizontalAlign": "Left",
      "verticalAlign": "Top",
      "type": "Frame",
      "childHeightPercents": [],
      "childWidthPercents": [],
      "frames": [],
      "name": "string",
      "numColumns": 0,
      "numRows": 0,
      "display": {}
    },
    "isLayoutLocked": true,
    "name": "string",
    "pdfOptions": {
      "autoScale": true,
      "customScaleValue": 0.1,
      "footerText": "string",
      "includePageNumber": true,
      "portraitOrientation": true,
      "showTotalPageNumber": true,
      "tableViewportWidth": 0.1
    },
    "sources": [
      {}
    ],
    "trees": [
      {}
    ],
    "version": {
      "rowVersion": 0
    },
    "webReportId": 0,
    "workflowObjectId": 0,
    "element": {},
    "styleCategory": "string"
  },
  "isFull": true,
  "retrieveBPMParams": true,
  "bpmTokenID": 0,
  "forWorkflow": true,
  "workflowID": 0,
  "timeZoneOffsetMinutes": 0,
  "signatures": {
    "property1": 0,
    "property2": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webreports/{id}/htmlpreview',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/webreports/{id}/htmlpreview', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/webreports/{id}/htmlpreview',
  params: {
  }, headers: headers

p JSON.parse(result)

Returns the list of transpose columns for creating transpose.

Body parameter

{
  "sources": [
    {
      "dependencies": [],
      "name": "string",
      "type": "AggregateTransformation",
      "scalarType": "string",
      "value": null,
      "column": "string",
      "keyValues": {},
      "table": "string",
      "expression": "string",
      "variables": [],
      "required": true,
      "useWebUser": true,
      "isParameterValueScalar": true,
      "parameterValue": {},
      "parameterId": 0,
      "columnNames": [],
      "source": {},
      "formula": "string",
      "partitionColumns": [],
      "timeEnd": "2019-08-24T14:15:22Z",
      "timeFrequency": {},
      "timePartition": "string",
      "timeStart": "2019-08-24T14:15:22Z",
      "newColumnName": "string",
      "keyColumns": [],
      "newColumns": [],
      "transposeColumn": "string"
    }
  ],
  "transposeSourceName": "string",
  "transposeColumn": "string"
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

ID of an existing web report in the model.

body

body

RESTAPI.v1.DTOs.WebReportTransposeDTO

false

Sources, transpose source name and column name.

» sources

body

[Varicent.RESTAPI.v1.DTOs.ReportSourceDTO]¦null

false

none

»» dependencies

body

[string]¦null

false

none

»» name

body

string¦null

false

none

»» type

body

string

false

none

»» scalarType

body

string¦null

false

none

»» value

body

any

false

none

»» column

body

string¦null

false

none

»» keyValues

body

object¦null

false

none

»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.ReportVariableDTO

false

none

»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»» expressionType

body

string

false

none

»»»»»» cases

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» arguments

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»» constraintType

body

string

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» condition

body

any

false

none

»»»»»»»» trueValue

body

any

false

none

»»»»»»»» falseValue

body

any

false

none

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»» constraints

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» literalRight

body

any

false

none

»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» right

body

any

false

none

»»»»»»» expressionLeft

body

any

false

none

»»»»»»» expressionRight

body

any

false

none

»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»» like

body

string¦null

false

none

»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»» trueValue

body

any

false

none

»»»»»» falseValue

body

any

false

none

»»»»»» isDate

body

boolean

false

none

»»»»»» literalType

body

string

false

none

»»»»»» value

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»»» variableName

body

string¦null

false

none

»»»» variableType

body

string

false

none

»» table

body

string¦null

false

none

»» expression

body

string¦null

false

none

»» variables

body

[string]¦null

false

none

»» required

body

boolean

false

none

»» useWebUser

body

boolean

false

none

»» isParameterValueScalar

body

boolean

false

none

»» parameterValue

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»» parameterId

body

integer(int32)

false

none

»» columnNames

body

[string]¦null

false

none

»» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»»» alias

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» table

body

string¦null

false

none

»»»»» customSelect

body

string¦null

false

none

»»»»» dataType

body

string

false

none

»»»»» type

body

string

false

none

»»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»»» m_namespace

body

string¦null

false

none

»»»»»» name

body

string¦null

false

none

»»»»» query

body

any

false

none

»»»»» alias

body

string¦null

false

none

»»»»» sourceType

body

string

false

none

»»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»» joinType

body

string

false

none

»»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»» constraintType

body

string

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»» caseSensitive

body

boolean

false

none

»»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»» like

body

string¦null

false

none

»»»»»» escapeWildcards

body

boolean

false

none

»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» queryDefinitionRight

body

any

false

none

»»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» direction

body

string

false

none

»»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»» distinct

body

boolean

false

none

»»»» unionWith

body

any

false

none

»»»» exceptWith

body

any

false

none

»»» sourceNames

body

object¦null

false

none

»»»» additionalProperties

body

string¦null

false

none

»» formula

body

string¦null

false

none

»» partitionColumns

body

[string]¦null

false

none

»» timeEnd

body

string(date-time)

false

none

»» timeFrequency

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»» levelId

body

string¦null

false

none

»»» timeId

body

string¦null

false

none

»» timePartition

body

string¦null

false

none

»» timeStart

body

string(date-time)

false

none

»» newColumnName

body

string¦null

false

none

»» keyColumns

body

[string]¦null

false

none

»» newColumns

body

[string]¦null

false

none

»» transposeColumn

body

string¦null

false

none

» transposeSourceName

body

string¦null

false

none

» transposeColumn

body

string¦null

false

none

Enumerated Values

Parameter

Value

»» type

AggregateTransformation

»» type

ComputedColumn

»» type

InputRowSource

»» type

QuerySource

»» type

TransposedSource

»» type

StaticScalar

»» type

ValueScalar

»» type

ComputedScalar

»» type

Parameter

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» expressionType

caseExpression

»»»»»» expressionType

dataField

»»»»»» expressionType

function

»»»»»» expressionType

ifExpression

»»»»»» expressionType

literal

»»»»»»» constraintType

clause

»»»»»»» constraintType

constraint

»»»»»»» constraintType

expressionConstraint

»»»»»»» constraintType

likeConstraint

»»»»»»» constraintType

rowVersionConstraint

»»»»»»» constraintType

subQueryConstraint

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»» literalType

Integer

»»»»»» literalType

Decimal

»»»»»» literalType

Date

»»»»»» literalType

DateTime

»»»»»» literalType

String

»»»»»» literalType

Float

»»»»»» literalType

Long

»»»»»» literalType

Null

»»»»»» literalType

Parameter

»»»»»» literalType

Guid

»»»»»» literalType

SystemUtcTime

»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» variableType

Literal

»»»» variableType

Parameter

»»»» variableType

Scalar

»»»»» dataType

Int

»»»»» dataType

Decimal

»»»»» dataType

DateTime

»»»»» dataType

None

»»»»» dataType

String

»»»»» type

SelectAll

»»»»» type

SelectItem

»»»»» type

SelectLiteral

»»»»» type

SelectCustom

»»»»» type

SelectExpression

»»»»» sourceType

Table

»»»»» sourceType

Query

»»»»» joinType

Inner

»»»»» joinType

Left

»»»»» joinType

Right

»»»»» joinType

Cross

»»»»» joinType

CrossApply

»»»»» joinType

OuterApply

»»»»»» constraintType

clause

»»»»»» constraintType

constraint

»»»»»» constraintType

expressionConstraint

»»»»»» constraintType

likeConstraint

»»»»»» constraintType

rowVersionConstraint

»»»»»» constraintType

subQueryConstraint

»»»»» direction

Ascending

»»»»» direction

Descending

»»»»» direction

AscendingNullsFirst

»»»»» direction

DescendingNullsLast

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/webreports/{id}/transposecolumns", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webreports/{id}/transposecolumns");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "sources": [
    {
      "dependencies": [],
      "name": "string",
      "type": "AggregateTransformation",
      "scalarType": "string",
      "value": null,
      "column": "string",
      "keyValues": {},
      "table": "string",
      "expression": "string",
      "variables": [],
      "required": true,
      "useWebUser": true,
      "isParameterValueScalar": true,
      "parameterValue": {},
      "parameterId": 0,
      "columnNames": [],
      "source": {},
      "formula": "string",
      "partitionColumns": [],
      "timeEnd": "2019-08-24T14:15:22Z",
      "timeFrequency": {},
      "timePartition": "string",
      "timeStart": "2019-08-24T14:15:22Z",
      "newColumnName": "string",
      "keyColumns": [],
      "newColumns": [],
      "transposeColumn": "string"
    }
  ],
  "transposeSourceName": "string",
  "transposeColumn": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webreports/{id}/transposecolumns',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/webreports/{id}/transposecolumns', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/webreports/{id}/transposecolumns',
  params: {
  }, headers: headers

p JSON.parse(result)

Return a set of the values to be populated on the combobox/picklist mapped to a parameter (currently used for fill parameters).

Body parameter

{
  "sources": [
    {
      "dependencies": [],
      "name": "string",
      "type": "AggregateTransformation",
      "scalarType": "string",
      "value": null,
      "column": "string",
      "keyValues": {},
      "table": "string",
      "expression": "string",
      "variables": [],
      "required": true,
      "useWebUser": true,
      "isParameterValueScalar": true,
      "parameterValue": {},
      "parameterId": 0,
      "columnNames": [],
      "source": {},
      "formula": "string",
      "partitionColumns": [],
      "timeEnd": "2019-08-24T14:15:22Z",
      "timeFrequency": {},
      "timePartition": "string",
      "timeStart": "2019-08-24T14:15:22Z",
      "newColumnName": "string",
      "keyColumns": [],
      "newColumns": [],
      "transposeColumn": "string"
    }
  ],
  "pickLists": [
    {
      "displayBorders": {},
      "displayPadding": {},
      "displayTypeLabel": "string",
      "fontstyle": {},
      "gridtype": "string",
      "hideIdValues": true,
      "hideValueForExport": true,
      "idColumn": "string",
      "name": "string",
      "nameColumn": "string",
      "refParameter": "string",
      "sortascending": true,
      "sortById": true,
      "source": {},
      "style": {}
    }
  ]
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.FillParametersDTO

false

none

» sources

body

[Varicent.RESTAPI.v1.DTOs.ReportSourceDTO]¦null

false

none

»» dependencies

body

[string]¦null

false

none

»» name

body

string¦null

false

none

»» type

body

string

false

none

»» scalarType

body

string¦null

false

none

»» value

body

any

false

none

»» column

body

string¦null

false

none

»» keyValues

body

object¦null

false

none

»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.ReportVariableDTO

false

none

»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»» expressionType

body

string

false

none

»»»»»» cases

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» arguments

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»» constraintType

body

string

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» condition

body

any

false

none

»»»»»»»» trueValue

body

any

false

none

»»»»»»»» falseValue

body

any

false

none

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»» constraints

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» literalRight

body

any

false

none

»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» right

body

any

false

none

»»»»»»» expressionLeft

body

any

false

none

»»»»»»» expressionRight

body

any

false

none

»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»» like

body

string¦null

false

none

»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»» trueValue

body

any

false

none

»»»»»» falseValue

body

any

false

none

»»»»»» isDate

body

boolean

false

none

»»»»»» literalType

body

string

false

none

»»»»»» value

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»»» variableName

body

string¦null

false

none

»»»» variableType

body

string

false

none

»» table

body

string¦null

false

none

»» expression

body

string¦null

false

none

»» variables

body

[string]¦null

false

none

»» required

body

boolean

false

none

»» useWebUser

body

boolean

false

none

»» isParameterValueScalar

body

boolean

false

none

»» parameterValue

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»» parameterId

body

integer(int32)

false

none

»» columnNames

body

[string]¦null

false

none

»» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»»» alias

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» table

body

string¦null

false

none

»»»»» customSelect

body

string¦null

false

none

»»»»» dataType

body

string

false

none

»»»»» type

body

string

false

none

»»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»»» m_namespace

body

string¦null

false

none

»»»»»» name

body

string¦null

false

none

»»»»» query

body

any

false

none

»»»»» alias

body

string¦null

false

none

»»»»» sourceType

body

string

false

none

»»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»» joinType

body

string

false

none

»»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»» constraintType

body

string

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»» caseSensitive

body

boolean

false

none

»»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»» like

body

string¦null

false

none

»»»»»» escapeWildcards

body

boolean

false

none

»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» queryDefinitionRight

body

any

false

none

»»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» direction

body

string

false

none

»»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»» distinct

body

boolean

false

none

»»»» unionWith

body

any

false

none

»»»» exceptWith

body

any

false

none

»»» sourceNames

body

object¦null

false

none

»»»» additionalProperties

body

string¦null

false

none

»» formula

body

string¦null

false

none

»» partitionColumns

body

[string]¦null

false

none

»» timeEnd

body

string(date-time)

false

none

»» timeFrequency

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»» levelId

body

string¦null

false

none

»»» timeId

body

string¦null

false

none

»» timePartition

body

string¦null

false

none

»» timeStart

body

string(date-time)

false

none

»» newColumnName

body

string¦null

false

none

»» keyColumns

body

[string]¦null

false

none

»» newColumns

body

[string]¦null

false

none

»» transposeColumn

body

string¦null

false

none

» pickLists

body

[Varicent.RESTAPI.v1.DTOs.PickListControlDTO]¦null

false

none

»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»» bottom

body

Varicent.RESTAPI.v1.DTOs.BorderDTO

false

none

»»»» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»»»» a

body

integer(int32)

false

none

»»»»» b

body

integer(int32)

false

none

»»»»» g

body

integer(int32)

false

none

»»»»» r

body

integer(int32)

false

none

»»»» width

body

number(float)

false

none

»»» left

body

Varicent.RESTAPI.v1.DTOs.BorderDTO

false

none

»»» right

body

Varicent.RESTAPI.v1.DTOs.BorderDTO

false

none

»»» top

body

Varicent.RESTAPI.v1.DTOs.BorderDTO

false

none

»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

»»» bottom

body

number(float)

false

none

»»» left

body

number(float)

false

none

»»» right

body

number(float)

false

none

»»» top

body

number(float)

false

none

»» displayTypeLabel

body

string¦null

false

none

»» fontstyle

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»» alignment

body

string

false

none

»»» backColor

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»»» font

body

Varicent.RESTAPI.v1.DTOs.FontDefinitionDTO

false

none

»»»» family

body

string¦null

false

none

»»»» size

body

number(float)

false

none

»»»» unit

body

string¦null

false

none

»»»» bold

body

boolean

false

none

»»»» italic

body

boolean

false

none

»»»» underline

body

boolean

false

none

»»»» strikeout

body

boolean

false

none

»»» foreColor

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»» gridtype

body

string¦null

false

none

»» hideIdValues

body

boolean

false

none

»» hideValueForExport

body

boolean

false

none

»» idColumn

body

string¦null

false

none

»» name

body

string¦null

false

none

»» nameColumn

body

string¦null

false

none

»» refParameter

body

string¦null

false

none

»» sortascending

body

boolean

false

none

»» sortById

body

boolean

false

none

»» source

body

Varicent.RESTAPI.v1.DTOs.DisplaySourceDTO

false

none

»»» name

body

string¦null

false

none

»» style

body

Varicent.RESTAPI.v1.DTOs.ControlDisplayStyleDTO

false

none

»»» style

body

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

»»» displayBorders

body

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

»»» displayPadding

body

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

Enumerated Values

Parameter

Value

»» type

AggregateTransformation

»» type

ComputedColumn

»» type

InputRowSource

»» type

QuerySource

»» type

TransposedSource

»» type

StaticScalar

»» type

ValueScalar

»» type

ComputedScalar

»» type

Parameter

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» expressionType

caseExpression

»»»»»» expressionType

dataField

»»»»»» expressionType

function

»»»»»» expressionType

ifExpression

»»»»»» expressionType

literal

»»»»»»» constraintType

clause

»»»»»»» constraintType

constraint

»»»»»»» constraintType

expressionConstraint

»»»»»»» constraintType

likeConstraint

»»»»»»» constraintType

rowVersionConstraint

»»»»»»» constraintType

subQueryConstraint

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»» literalType

Integer

»»»»»» literalType

Decimal

»»»»»» literalType

Date

»»»»»» literalType

DateTime

»»»»»» literalType

String

»»»»»» literalType

Float

»»»»»» literalType

Long

»»»»»» literalType

Null

»»»»»» literalType

Parameter

»»»»»» literalType

Guid

»»»»»» literalType

SystemUtcTime

»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» variableType

Literal

»»»» variableType

Parameter

»»»» variableType

Scalar

»»»»» dataType

Int

»»»»» dataType

Decimal

»»»»» dataType

DateTime

»»»»» dataType

None

»»»»» dataType

String

»»»»» type

SelectAll

»»»»» type

SelectItem

»»»»» type

SelectLiteral

»»»»» type

SelectCustom

»»»»» type

SelectExpression

»»»»» sourceType

Table

»»»»» sourceType

Query

»»»»» joinType

Inner

»»»»» joinType

Left

»»»»» joinType

Right

»»»»» joinType

Cross

»»»»» joinType

CrossApply

»»»»» joinType

OuterApply

»»»»»» constraintType

clause

»»»»»» constraintType

constraint

»»»»»» constraintType

expressionConstraint

»»»»»» constraintType

likeConstraint

»»»»»» constraintType

rowVersionConstraint

»»»»»» constraintType

subQueryConstraint

»»»»» direction

Ascending

»»»»» direction

Descending

»»»»» direction

AscendingNullsFirst

»»»»» direction

DescendingNullsLast

»»» alignment

Justify

»»» alignment

Left

»»» alignment

Center

»»» alignment

Right

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.ResultSetDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/webreports/parametervalues", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webreports/parametervalues");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "sources": [
    {
      "dependencies": [],
      "name": "string",
      "type": "AggregateTransformation",
      "scalarType": "string",
      "value": null,
      "column": "string",
      "keyValues": {},
      "table": "string",
      "expression": "string",
      "variables": [],
      "required": true,
      "useWebUser": true,
      "isParameterValueScalar": true,
      "parameterValue": {},
      "parameterId": 0,
      "columnNames": [],
      "source": {},
      "formula": "string",
      "partitionColumns": [],
      "timeEnd": "2019-08-24T14:15:22Z",
      "timeFrequency": {},
      "timePartition": "string",
      "timeStart": "2019-08-24T14:15:22Z",
      "newColumnName": "string",
      "keyColumns": [],
      "newColumns": [],
      "transposeColumn": "string"
    }
  ],
  "pickLists": [
    {
      "displayBorders": {},
      "displayPadding": {},
      "displayTypeLabel": "string",
      "fontstyle": {},
      "gridtype": "string",
      "hideIdValues": true,
      "hideValueForExport": true,
      "idColumn": "string",
      "name": "string",
      "nameColumn": "string",
      "refParameter": "string",
      "sortascending": true,
      "sortById": true,
      "source": {},
      "style": {}
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webreports/parametervalues',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/webreports/parametervalues', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/webreports/parametervalues',
  params: {
  }, headers: headers

p JSON.parse(result)

Web Tab

WebTabsControllerV1_GetAllForWebReport

Parameters

Name

In

Type

Required

Description

webReportId

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

302

Found

Redirect

Inline

Response Schema

Status Code 302

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.PortalAccess.WebTabDTO]

false

none

none

» name

string¦null

false

none

none

» tabType

string

false

none

none

» externalURL

string¦null

false

none

none

» objectId

string¦null

false

none

none

» objectName

string¦null

false

none

none

» objectType

string¦null

false

none

none

» workflowObjectId

integer(int32)

false

none

none

» nameEnum

string¦null

false

none

none

» mobileEnabled

boolean¦null

false

none

none

» mobileWebAccess

string¦null

false

none

none

» slackEnabled

boolean¦null

false

none

none

» headerEnabled

boolean¦null

false

none

none

» footerEnabled

boolean¦null

false

none

none

» id

integer(int32)

false

none

none

» parent

integer(int32)¦null

false

none

none

» oldParent

integer(int32)¦null

false

none

none

» prev

integer(int32)¦null

false

none

none

» oldPrev

integer(int32)¦null

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

Enumerated Values

Property

Value

tabType

WebModule

tabType

TabGroup

tabType

CompensationPlan

tabType

TailoredReport

tabType

WebForm

tabType

PresenterReport

tabType

None

tabType

ExternalURL

tabType

CompPlanManager

tabType

RapidReport

tabType

DDE

tabType

DDEInfographic

tabType

PresenterAdaptive

tabType

DirectLink

tabType

AdaptiveForm

tabType

StandardReport

tabType

SalesPlanningMap

nameEnum

PayeeLedger

nameEnum

Inquiries

nameEnum

DataEdit

nameEnum

WebForms

nameEnum

Reporting

nameEnum

CompPlanManager

mobileWebAccess

WebOnly

mobileWebAccess

MobileAndWeb

mobileWebAccess

MobileOnly

mobileWebAccess

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/webreports/{webReportId}/webtabs", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webreports/{webReportId}/webtabs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webreports/{webReportId}/webtabs',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/webreports/{webReportId}/webtabs', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/webreports/{webReportId}/webtabs',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "name": "string",
    "tabType": "WebModule",
    "externalURL": "string",
    "objectId": "string",
    "objectName": "string",
    "objectType": "string",
    "workflowObjectId": 0,
    "nameEnum": "PayeeLedger",
    "mobileEnabled": true,
    "mobileWebAccess": "WebOnly",
    "slackEnabled": true,
    "headerEnabled": true,
    "footerEnabled": true,
    "id": 0,
    "parent": 0,
    "oldParent": 0,
    "prev": 0,
    "oldPrev": 0,
    "version": {
      "rowVersion": 0
    }
  }
]
[{"name":"string","tabType":"WebModule","externalURL":"string","objectId":"string","objectName":"string","objectType":"string","workflowObjectId":0,"nameEnum":"PayeeLedger","mobileEnabled":true,"mobileWebAccess":"WebOnly","slackEnabled":true,"headerEnabled":true,"footerEnabled":true,"id":0,"parent":0,"oldParent":0,"prev":0,"oldPrev":0,"version":{"rowVersion":0}}]

Calendar

Get all calendars.

Responses

Status

Meaning

Description

Schema

200

OK

Get all Calendars

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Time.CalendarDTO]

false

none

none

» definition

Varicent.RESTAPI.v1.DTOs.Time.CalendarDefinitionDTO

false

none

none

»» timeId

string¦null

false

none

none

»» name

string¦null

false

none

none

»» levels

[string]¦null

false

none

none

» tree

Varicent.RESTAPI.v1.DTOs.Time.PeriodDTO

false

none

none

»» name

string¦null

false

none

none

»» level

string¦null

false

none

none

»» start

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

»» end

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

»» children

array¦null

false

none

none

»»» anonymous

any

false

none

none

» locked

string¦null

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/migration/calendars", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/migration/calendars");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/migration/calendars',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/migration/calendars', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/migration/calendars',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "definition": {
      "timeId": "string",
      "name": "string",
      "levels": []
    },
    "tree": {
      "name": "string",
      "level": "string",
      "start": {},
      "end": {},
      "children": []
    },
    "locked": "string",
    "version": {
      "rowVersion": 0
    }
  }
]
[{"definition":{"timeId":"string","name":"string","levels":[]},"tree":{"name":"string","level":"string","start":{},"end":{},"children":[]},"locked":"string","version":{"rowVersion":0}}]

Add a calendar by Calendar.

Body parameter

{
  "definition": {
    "timeId": "string",
    "name": "string",
    "levels": [
      "string"
    ]
  },
  "tree": {
    "name": "string",
    "level": "string",
    "start": {},
    "end": {},
    "children": []
  },
  "locked": "string",
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Time.CalendarDTO

false

none

» definition

body

Varicent.RESTAPI.v1.DTOs.Time.CalendarDefinitionDTO

false

none

»» timeId

body

string¦null

false

none

»» name

body

string¦null

false

none

»» levels

body

[string]¦null

false

none

» tree

body

Varicent.RESTAPI.v1.DTOs.Time.PeriodDTO

false

none

»» name

body

string¦null

false

none

»» level

body

string¦null

false

none

»» start

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»» end

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»» children

body

array¦null

false

none

»»» anonymous

body

any

false

none

» locked

body

string¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Add calendar by Calendar

Varicent.RESTAPI.v1.DTOs.Time.CalendarDTO

404

Not Found

Calendar was not found

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/calendars", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/calendars");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "definition": {
    "timeId": "string",
    "name": "string",
    "levels": [
      "string"
    ]
  },
  "tree": {
    "name": "string",
    "level": "string",
    "start": {},
    "end": {},
    "children": []
  },
  "locked": "string",
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/calendars',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/calendars', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/calendars',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "definition": {
    "timeId": "string",
    "name": "string",
    "levels": [
      "string"
    ]
  },
  "tree": {
    "name": "string",
    "level": "string",
    "start": {},
    "end": {},
    "children": []
  },
  "locked": "string",
  "version": {
    "rowVersion": 0
  }
}
{"definition":{"timeId":"string","name":"string","levels":["string"]},"tree":{"name":"string","level":"string","start":{},"end":{},"children":[]},"locked":"string","version":{"rowVersion":0}}

Get all non-sensitive calendar information without checking calendar view permissions.

Responses

Status

Meaning

Description

Schema

200

OK

Get the basic info for all calendars.

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Time.CompactCalendarDTO]

false

none

none

» locked

string¦null

false

none

none

» levelLockedDates

[string]¦null

false

none

none

» calendarStart

string(date-time)

false

none

none

» defaultStartDate

string(date-time)

false

none

none

» calendarEnd

string(date-time)

false

none

none

» definition

Varicent.RESTAPI.v1.DTOs.Time.CalendarDefinitionDTO

false

none

none

»» timeId

string¦null

false

none

none

»» name

string¦null

false

none

none

»» levels

[string]¦null

false

none

none

» levelPeriodCounts

object¦null

false

none

none

»» additionalProperties

integer(int32)¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/calendarscompact", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/calendarscompact");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/calendarscompact',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/calendarscompact', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/calendarscompact',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "locked": "string",
    "levelLockedDates": [
      "2019-08-24T14:15:22Z"
    ],
    "calendarStart": "2019-08-24T14:15:22Z",
    "defaultStartDate": "2019-08-24T14:15:22Z",
    "calendarEnd": "2019-08-24T14:15:22Z",
    "definition": {
      "timeId": "string",
      "name": "string",
      "levels": []
    },
    "levelPeriodCounts": {
      "property1": 0,
      "property2": 0
    }
  }
]
[{"locked":"string","levelLockedDates":["2019-08-24T14:15:22Z"],"calendarStart":"2019-08-24T14:15:22Z","defaultStartDate":"2019-08-24T14:15:22Z","calendarEnd":"2019-08-24T14:15:22Z","definition":{"timeId":"string","name":"string","levels":[]},"levelPeriodCounts":{"property1":0,"property2":0}}]

Get all periods for a specific calendar and level.

Parameters

Name

In

Type

Required

Description

timeId

path

string

true

none

levelId

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get all Periods for a calendar and level

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Time.PeriodDTO]

false

none

none

» name

string¦null

false

none

none

» level

string¦null

false

none

none

» start

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

» end

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

» children

array¦null

false

none

none

»» anonymous

any

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/calendars/{timeId}/levelperiods/{levelId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/calendars/{timeId}/levelperiods/{levelId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/calendars/{timeId}/levelperiods/{levelId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/calendars/{timeId}/levelperiods/{levelId}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/calendars/{timeId}/levelperiods/{levelId}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "name": "string",
    "level": "string",
    "start": {},
    "end": {},
    "children": []
  }
]
[{"name":"string","level":"string","start":{},"end":{},"children":[]}]

Delete a calendar by ID.

Parameters

Name

In

Type

Required

Description

id

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Delete calendar by ID

None

404

Not Found

Calendar does not exist

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/calendars/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/calendars/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/calendars/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/calendars/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/calendars/{id}',
  params: {
  }

p JSON.parse(result)

Update a calendar by Calendar and ID.

Body parameter

{
  "definition": {
    "timeId": "string",
    "name": "string",
    "levels": [
      "string"
    ]
  },
  "tree": {
    "name": "string",
    "level": "string",
    "start": {},
    "end": {},
    "children": []
  },
  "locked": "string",
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

id

path

string

true

none

body

body

Varicent.RESTAPI.v1.DTOs.Time.CalendarDTO

false

none

» definition

body

Varicent.RESTAPI.v1.DTOs.Time.CalendarDefinitionDTO

false

none

»» timeId

body

string¦null

false

none

»» name

body

string¦null

false

none

»» levels

body

[string]¦null

false

none

» tree

body

Varicent.RESTAPI.v1.DTOs.Time.PeriodDTO

false

none

»» name

body

string¦null

false

none

»» level

body

string¦null

false

none

»» start

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»» end

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»» children

body

array¦null

false

none

»»» anonymous

body

any

false

none

» locked

body

string¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Update calendar by Calendar and ID

Inline

400

Bad Request

Invalid ID Parameter for Calendar

None

404

Not Found

Calendar/ID could not be found

None

409

Conflict

Could be caused by either a generic concurrency exception or trying to lock a calendar without calculating it first.

None

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Time.CalendarDTO]

false

none

none

» definition

Varicent.RESTAPI.v1.DTOs.Time.CalendarDefinitionDTO

false

none

none

»» timeId

string¦null

false

none

none

»» name

string¦null

false

none

none

»» levels

[string]¦null

false

none

none

» tree

Varicent.RESTAPI.v1.DTOs.Time.PeriodDTO

false

none

none

»» name

string¦null

false

none

none

»» level

string¦null

false

none

none

»» start

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

»» end

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

»» children

array¦null

false

none

none

»»» anonymous

any

false

none

none

» locked

string¦null

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/calendars/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/calendars/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "definition": {
    "timeId": "string",
    "name": "string",
    "levels": [
      "string"
    ]
  },
  "tree": {
    "name": "string",
    "level": "string",
    "start": {},
    "end": {},
    "children": []
  },
  "locked": "string",
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/calendars/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/calendars/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/calendars/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "definition": {
      "timeId": "string",
      "name": "string",
      "levels": []
    },
    "tree": {
      "name": "string",
      "level": "string",
      "start": {},
      "end": {},
      "children": []
    },
    "locked": "string",
    "version": {
      "rowVersion": 0
    }
  }
]
[{"definition":{"timeId":"string","name":"string","levels":[]},"tree":{"name":"string","level":"string","start":{},"end":{},"children":[]},"locked":"string","version":{"rowVersion":0}}]

Get a calendar year with start date and template.

Parameters

Name

In

Type

Required

Description

template

path

string

true

none

startDate

path

string(date-time)

true

none

Enumerated Values

Parameter

Value

template

Monthly

template

HalfMonths

template

Biweekly

template

FourWeekPeriod

template

Weekly

template

Standard445

template

Standard454

template

Standard544

Responses

Status

Meaning

Description

Schema

200

OK

Get calendar by template

Varicent.RESTAPI.v1.DTOs.Time.PeriodDTOVaricent.RESTAPI.v1.DTOs.Time.PeriodDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/calendartemplate/{template}/periods/{startDate}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/calendartemplate/{template}/periods/{startDate}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/calendartemplate/{template}/periods/{startDate}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/calendartemplate/{template}/periods/{startDate}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/calendartemplate/{template}/periods/{startDate}',
  params: {
  }, headers: headers

p JSON.parse(result)

Get a calendar year with start date, template and yearname. This endpoint specifies what year should be used in period name

Parameters

Name

In

Type

Required

Description

template

path

string

true

none

startDate

path

string(date-time)

true

none

yearName

path

string

true

none

Enumerated Values

Parameter

Value

template

Monthly

template

HalfMonths

template

Biweekly

template

FourWeekPeriod

template

Weekly

template

Standard445

template

Standard454

template

Standard544

Responses

Status

Meaning

Description

Schema

200

OK

Get calendar by template with specified yearname

Varicent.RESTAPI.v1.DTOs.Time.PeriodDTOVaricent.RESTAPI.v1.DTOs.Time.PeriodDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/calendartemplate/{template}/periods/{startDate}/{yearName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/calendartemplate/{template}/periods/{startDate}/{yearName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/calendartemplate/{template}/periods/{startDate}/{yearName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/calendartemplate/{template}/periods/{startDate}/{yearName}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/calendartemplate/{template}/periods/{startDate}/{yearName}',
  params: {
  }, headers: headers

p JSON.parse(result)

Get a calendar template with levels.

Parameters

Name

In

Type

Required

Description

filter

query

string

false

####Supported operations

Detailed descriptions

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

level

Responses

Status

Meaning

Description

Schema

200

OK

Get template by levels

RESTAPI.v1.DTOs.Time.CalendarTemplateDTORESTAPI.v1.DTOs.Time.CalendarTemplateDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/calendartemplate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/calendartemplate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/calendartemplate',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/calendartemplate', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/calendartemplate',
  params: {
  }, headers: headers

p JSON.parse(result)

Returns the number of calculations affected by calendar changes.

Body parameter

{
  "definition": {
    "timeId": "string",
    "name": "string",
    "levels": [
      "string"
    ]
  },
  "tree": {
    "name": "string",
    "level": "string",
    "start": {},
    "end": {},
    "children": []
  },
  "locked": "string",
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

id

path

string

true

none

body

body

Varicent.RESTAPI.v1.DTOs.Time.CalendarDTO

false

none

» definition

body

Varicent.RESTAPI.v1.DTOs.Time.CalendarDefinitionDTO

false

none

»» timeId

body

string¦null

false

none

»» name

body

string¦null

false

none

»» levels

body

[string]¦null

false

none

» tree

body

Varicent.RESTAPI.v1.DTOs.Time.PeriodDTO

false

none

»» name

body

string¦null

false

none

»» level

body

string¦null

false

none

»» start

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»» end

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»» children

body

array¦null

false

none

»»» anonymous

body

any

false

none

» locked

body

string¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Update calendar by Calendar and ID

Inline

400

Bad Request

Invalid ID Parameter for Calendar

None

404

Not Found

Calendar/ID could not be found

None

409

Conflict

Could be caused by either a generic concurrency exception or trying to lock a calendar without calculating it first.

None

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Time.CalendarDTO]

false

none

none

» definition

Varicent.RESTAPI.v1.DTOs.Time.CalendarDefinitionDTO

false

none

none

»» timeId

string¦null

false

none

none

»» name

string¦null

false

none

none

»» levels

[string]¦null

false

none

none

» tree

Varicent.RESTAPI.v1.DTOs.Time.PeriodDTO

false

none

none

»» name

string¦null

false

none

none

»» level

string¦null

false

none

none

»» start

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

»» end

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

»» children

array¦null

false

none

none

»»» anonymous

any

false

none

none

» locked

string¦null

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/calendars/{id}/affectedCalcs", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/calendars/{id}/affectedCalcs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "definition": {
    "timeId": "string",
    "name": "string",
    "levels": [
      "string"
    ]
  },
  "tree": {
    "name": "string",
    "level": "string",
    "start": {},
    "end": {},
    "children": []
  },
  "locked": "string",
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/calendars/{id}/affectedCalcs',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/calendars/{id}/affectedCalcs', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/calendars/{id}/affectedCalcs',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "definition": {
      "timeId": "string",
      "name": "string",
      "levels": []
    },
    "tree": {
      "name": "string",
      "level": "string",
      "start": {},
      "end": {},
      "children": []
    },
    "locked": "string",
    "version": {
      "rowVersion": 0
    }
  }
]
[{"definition":{"timeId":"string","name":"string","levels":[]},"tree":{"name":"string","level":"string","start":{},"end":{},"children":[]},"locked":"string","version":{"rowVersion":0}}]

Update a calendar by Calendar and ID asynchronously.

Body parameter

{
  "definition": {
    "timeId": "string",
    "name": "string",
    "levels": [
      "string"
    ]
  },
  "tree": {
    "name": "string",
    "level": "string",
    "start": {},
    "end": {},
    "children": []
  },
  "locked": "string",
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

id

path

string

true

none

body

body

Varicent.RESTAPI.v1.DTOs.Time.CalendarDTO

false

none

» definition

body

Varicent.RESTAPI.v1.DTOs.Time.CalendarDefinitionDTO

false

none

»» timeId

body

string¦null

false

none

»» name

body

string¦null

false

none

»» levels

body

[string]¦null

false

none

» tree

body

Varicent.RESTAPI.v1.DTOs.Time.PeriodDTO

false

none

»» name

body

string¦null

false

none

»» level

body

string¦null

false

none

»» start

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»» end

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»» children

body

array¦null

false

none

»»» anonymous

body

any

false

none

» locked

body

string¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Update calendar by Calendar and ID

Inline

400

Bad Request

Invalid ID Parameter for Calendar

None

404

Not Found

Calendar/ID could not be found

None

409

Conflict

Could be caused by either a generic concurrency exception or trying to lock a calendar without calculating it first.

None

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Time.CalendarDTO]

false

none

none

» definition

Varicent.RESTAPI.v1.DTOs.Time.CalendarDefinitionDTO

false

none

none

»» timeId

string¦null

false

none

none

»» name

string¦null

false

none

none

»» levels

[string]¦null

false

none

none

» tree

Varicent.RESTAPI.v1.DTOs.Time.PeriodDTO

false

none

none

»» name

string¦null

false

none

none

»» level

string¦null

false

none

none

»» start

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

»» end

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

»» children

array¦null

false

none

none

»»» anonymous

any

false

none

none

» locked

string¦null

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/calendars/{id}/async", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/calendars/{id}/async");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "definition": {
    "timeId": "string",
    "name": "string",
    "levels": [
      "string"
    ]
  },
  "tree": {
    "name": "string",
    "level": "string",
    "start": {},
    "end": {},
    "children": []
  },
  "locked": "string",
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/calendars/{id}/async',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/calendars/{id}/async', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/calendars/{id}/async',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "definition": {
      "timeId": "string",
      "name": "string",
      "levels": []
    },
    "tree": {
      "name": "string",
      "level": "string",
      "start": {},
      "end": {},
      "children": []
    },
    "locked": "string",
    "version": {
      "rowVersion": 0
    }
  }
]
[{"definition":{"timeId":"string","name":"string","levels":[]},"tree":{"name":"string","level":"string","start":{},"end":{},"children":[]},"locked":"string","version":{"rowVersion":0}}]

Lock and unlock periods from a calendar.

Body parameter

{
  "definition": {
    "timeId": "string",
    "name": "string",
    "levels": [
      "string"
    ]
  },
  "tree": {
    "name": "string",
    "level": "string",
    "start": {},
    "end": {},
    "children": []
  },
  "locked": "string",
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

id

path

string

true

none

body

body

Varicent.RESTAPI.v1.DTOs.Time.CalendarDTO

false

none

» definition

body

Varicent.RESTAPI.v1.DTOs.Time.CalendarDefinitionDTO

false

none

»» timeId

body

string¦null

false

none

»» name

body

string¦null

false

none

»» levels

body

[string]¦null

false

none

» tree

body

Varicent.RESTAPI.v1.DTOs.Time.PeriodDTO

false

none

»» name

body

string¦null

false

none

»» level

body

string¦null

false

none

»» start

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»» end

body

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

»» children

body

array¦null

false

none

»»» anonymous

body

any

false

none

» locked

body

string¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Responses

Status

Meaning

Description

Schema

202

Accepted

Start process to lock and unlock calendar by period and ID

Inline

400

Bad Request

Invalid ID Parameter for Calendar

None

404

Not Found

Calendar/ID could not be found

None

409

Conflict

Could be caused by either a generic concurrency exception or trying to lock a calendar without calculating it first.

None

Response Schema

Status Code 202

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Time.CalendarDTO]

false

none

none

» definition

Varicent.RESTAPI.v1.DTOs.Time.CalendarDefinitionDTO

false

none

none

»» timeId

string¦null

false

none

none

»» name

string¦null

false

none

none

»» levels

[string]¦null

false

none

none

» tree

Varicent.RESTAPI.v1.DTOs.Time.PeriodDTO

false

none

none

»» name

string¦null

false

none

none

»» level

string¦null

false

none

none

»» start

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

»» end

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

»» children

array¦null

false

none

none

»»» anonymous

any

false

none

none

» locked

string¦null

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/calendars/{id}/lock", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/calendars/{id}/lock");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "definition": {
    "timeId": "string",
    "name": "string",
    "levels": [
      "string"
    ]
  },
  "tree": {
    "name": "string",
    "level": "string",
    "start": {},
    "end": {},
    "children": []
  },
  "locked": "string",
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/calendars/{id}/lock',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/calendars/{id}/lock', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/calendars/{id}/lock',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "definition": {
      "timeId": "string",
      "name": "string",
      "levels": []
    },
    "tree": {
      "name": "string",
      "level": "string",
      "start": {},
      "end": {},
      "children": []
    },
    "locked": "string",
    "version": {
      "rowVersion": 0
    }
  }
]
[{"definition":{"timeId":"string","name":"string","levels":[]},"tree":{"name":"string","level":"string","start":{},"end":{},"children":[]},"locked":"string","version":{"rowVersion":0}}]

Get the names of affected calculations from a calendar.

Parameters

Name

In

Type

Required

Description

id

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get affected calculations

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/calendars/{id}/calculations", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/calendars/{id}/calculations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/calendars/{id}/calculations',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/calendars/{id}/calculations', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/calendars/{id}/calculations',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  "string"
]
["string"]

Get the names of tables using calendar.

Parameters

Name

In

Type

Required

Description

id

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get tables using calendar

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/calendars/{id}/dependenttables", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/calendars/{id}/dependenttables");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/calendars/{id}/dependenttables',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/calendars/{id}/dependenttables', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/calendars/{id}/dependenttables',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  "string"
]
["string"]

Get the names of calculations using calendar.

Parameters

Name

In

Type

Required

Description

id

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get calcs using calendar

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Composer.CalculationCompactDTO]

false

none

none

» name

string¦null

false

none

none

» id

integer(int32)

false

none

none

» calcType

string

false

none

none

Enumerated Values

Property

Value

calcType

Mathematical

calcType

Sorting

calcType

TimeShift

calcType

Category

calcType

Symon

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/calendars/{id}/dependentcalculations", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/calendars/{id}/dependentcalculations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/calendars/{id}/dependentcalculations',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/calendars/{id}/dependentcalculations', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/calendars/{id}/dependentcalculations',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "name": "string",
    "id": 0,
    "calcType": "Mathematical"
  }
]
[{"name":"string","id":0,"calcType":"Mathematical"}]

Port

Get a port definition.

Parameters

Name

In

Type

Required

Description

portId

path

integer(int32)

true

Port definition ID

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.PortDefinitionDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/ports/{portId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/ports/{portId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/ports/{portId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/ports/{portId}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/ports/{portId}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "portId": 0,
  "name": "string",
  "portType": "Input",
  "sourceTable": "string",
  "referencedTable": "string",
  "columns": [
    {
      "portId": 0,
      "name": "string",
      "dataType": "String",
      "order": 0,
      "isKey": true,
      "sourceColumn": "string"
    }
  ],
  "references": {
    "property1": "string",
    "property2": "string"
  },
  "timeReferences": {
    "property1": {
      "levelId": "string",
      "timeId": "string"
    },
    "property2": {
      "levelId": "string",
      "timeId": "string"
    }
  },
  "isWaypoint": true,
  "migrationDisplayName": "string",
  "version": {
    "rowVersion": 0
  }
}
{"portId":0,"name":"string","portType":"Input","sourceTable":"string","referencedTable":"string","columns":[{"portId":0,"name":"string","dataType":"String","order":0,"isKey":true,"sourceColumn":"string"}],"references":{"property1":"string","property2":"string"},"timeReferences":{"property1":{"levelId":"string","timeId":"string"},"property2":{"levelId":"string","timeId":"string"}},"isWaypoint":true,"migrationDisplayName":"string","version":{"rowVersion":0}}

Overwrites an entire port definition.

Body parameter

{
  "portId": 0,
  "name": "string",
  "portType": "Input",
  "sourceTable": "string",
  "referencedTable": "string",
  "columns": [
    {
      "portId": 0,
      "name": "string",
      "dataType": "String",
      "order": 0,
      "isKey": true,
      "sourceColumn": "string"
    }
  ],
  "references": {
    "property1": "string",
    "property2": "string"
  },
  "timeReferences": {
    "property1": {
      "levelId": "string",
      "timeId": "string"
    },
    "property2": {
      "levelId": "string",
      "timeId": "string"
    }
  },
  "isWaypoint": true,
  "migrationDisplayName": "string",
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

portId

path

integer(int32)

true

Port definition ID

body

body

Varicent.RESTAPI.v1.DTOs.PortDefinitionDTO

false

New port definition to replace the old one

» portId

body

integer(int32)

false

none

» name

body

string¦null

false

none

» portType

body

string

false

none

» sourceTable

body

string¦null

false

none

» referencedTable

body

string¦null

false

none

» columns

body

[varicent.RESTAPI.v1.DTOs.PortColumnDTO]¦null

false

none

»» portId

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» dataType

body

string

false

none

»» order

body

integer(int32)

false

none

»» isKey

body

boolean

false

none

»» sourceColumn

body

string¦null

false

none

» references

body

object¦null

false

none

»» additionalProperties

body

string

false

none

» timeReferences

body

object¦null

false

none

»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»» levelId

body

string¦null

false

none

»»» timeId

body

string¦null

false

none

» isWaypoint

body

boolean

false

none

» migrationDisplayName

body

string¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Enumerated Values

Parameter

Value

» portType

Input

» portType

Output

»» dataType

String

»» dataType

Date

»» dataType

Numeric

»» dataType

Int

»» dataType

LongString

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.PortDefinitionDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/ports/{portId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/ports/{portId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "portId": 0,
  "name": "string",
  "portType": "Input",
  "sourceTable": "string",
  "referencedTable": "string",
  "columns": [
    {
      "portId": 0,
      "name": "string",
      "dataType": "String",
      "order": 0,
      "isKey": true,
      "sourceColumn": "string"
    }
  ],
  "references": {
    "property1": "string",
    "property2": "string"
  },
  "timeReferences": {
    "property1": {
      "levelId": "string",
      "timeId": "string"
    },
    "property2": {
      "levelId": "string",
      "timeId": "string"
    }
  },
  "isWaypoint": true,
  "migrationDisplayName": "string",
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/ports/{portId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/ports/{portId}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/ports/{portId}',
  params: {
  }, headers: headers

p JSON.parse(result)

Update the source table and source columns of a port definition, or remove a port’s mapping to the source.

Body parameter

{
  "source": "string",
  "columns": [
    {
      "name": "string",
      "sourceColumn": "string"
    }
  ],
  "portDefinitionVersion": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

portId

path

integer(int32)

true

Port definition ID

body

body

Varicent.RESTAPI.v1.DTOs.Composer.Ports.PortDefinitionPatchDTO

false

“source” should contain the name of the table to which the port is mapped.

» source

body

string¦null

false

none

» columns

body

[Varicent.RESTAPI.v1.DTOs.Composer.Ports.PortColumnPatchDTO]¦null

false

none

»» name

body

string¦null

false

none

»» sourceColumn

body

string¦null

false

none

» portDefinitionVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Detailed descriptions

body: “source” should contain the name of the table to which the port is mapped. If mapping to another port, this field should be of the form “_PortX”, where X is the port definition ID of the source port. To unmap the port from its source, set “source” to null, or do not include “source” in the request.

Responses

Status

Meaning

Description

Schema

200

OK

Remapping the port to the new source has been successful.

Varicent.RESTAPI.v1.DTOs.PortDefinitionDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/ports/{portId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/ports/{portId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "source": "string",
  "columns": [
    {
      "name": "string",
      "sourceColumn": "string"
    }
  ],
  "portDefinitionVersion": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/ports/{portId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/ports/{portId}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/ports/{portId}',
  params: {
  }, headers: headers

p JSON.parse(result)

Delete a port definition with the corresponding port element.

Parameters

Name

In

Type

Required

Description

portId

path

integer(int32)

true

Port definition ID

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/ports/{portId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/ports/{portId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/ports/{portId}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/ports/{portId}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/ports/{portId}',
  params: {
  }

p JSON.parse(result)

Get detailed port definitions of a component.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Component ID

expand

query

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

404

Not Found

Component with specified ID was not found.

string

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Composer.Ports.PortElementDTO]

false

none

none

» portDefinition

Varicent.RESTAPI.v1.DTOs.PortDefinitionDTO

false

none

none

»» portId

integer(int32)

false

none

none

»» name

string¦null

false

none

none

»» portType

string

false

none

none

»» sourceTable

string¦null

false

none

none

»» referencedTable

string¦null

false

none

none

»» columns

[varicent.RESTAPI.v1.DTOs.PortColumnDTO]¦null

false

none

none

»»» portId

integer(int32)

false

none

none

»»» name

string¦null

false

none

none

»»» dataType

string

false

none

none

»»» order

integer(int32)

false

none

none

»»» isKey

boolean

false

none

none

»»» sourceColumn

string¦null

false

none

none

»» references

object¦null

false

none

none

»»» additionalProperties

string

false

none

none

»» timeReferences

object¦null

false

none

none

»»» additionalProperties

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

none

»»»» levelId

string¦null

false

none

none

»»»» timeId

string¦null

false

none

none

»» isWaypoint

boolean

false

none

none

»» migrationDisplayName

string¦null

false

none

none

»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»» rowVersion

integer(int64)

false

none

none

» connection

Varicent.RESTAPI.v1.DTOs.IExpandableResourceDTO

false

none

none

» elementId

integer(int32)

false

none

none

» parentBlockId

integer(int32)¦null

false

none

none

» bounds

System.Drawing.RectangleF

false

none

none

»» location

System.Drawing.PointF

false

none

none

»»» isEmpty

boolean

false

read-only

none

»»» x

number(float)

false

none

none

»»» y

number(float)

false

none

none

»» size

string

false

none

none

»» x

number(float)

false

none

none

»» y

number(float)

false

none

none

»» width

number(float)

false

none

none

»» height

number(float)

false

none

none

»» left

number(float)

false

read-only

none

»» top

number(float)

false

read-only

none

»» right

number(float)

false

read-only

none

»» bottom

number(float)

false

read-only

none

»» isEmpty

boolean

false

read-only

none

» color

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

none

»» a

integer(int32)

false

none

none

»» b

integer(int32)

false

none

none

»» g

integer(int32)

false

none

none

»» r

integer(int32)

false

none

none

» name

string¦null

false

none

none

» parentBlock

Varicent.RESTAPI.v1.DTOs.Composer.ExpandableBlockElementDTO

false

none

none

»» id

integer(int32)

false

none

none

»» name

string¦null

false

none

none

»» href

string¦null

false

none

none

» isVisible

boolean

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

portType

Input

portType

Output

dataType

String

dataType

Date

dataType

Numeric

dataType

Int

dataType

LongString

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/components/{id}/ports", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/components/{id}/ports");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/components/{id}/ports',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/components/{id}/ports', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/components/{id}/ports',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "portDefinition": {
      "portId": 0,
      "name": "string",
      "portType": "Input",
      "sourceTable": "string",
      "referencedTable": "string",
      "columns": [],
      "references": {},
      "timeReferences": {},
      "isWaypoint": true,
      "migrationDisplayName": "string",
      "version": {}
    },
    "connection": {},
    "elementId": 0,
    "parentBlockId": 0,
    "bounds": {
      "location": {},
      "size": "string",
      "x": 0.1,
      "y": 0.1,
      "width": 0.1,
      "height": 0.1,
      "left": 0.1,
      "top": 0.1,
      "right": 0.1,
      "bottom": 0.1,
      "isEmpty": true
    },
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "name": "string",
    "parentBlock": {
      "id": 0,
      "name": "string",
      "href": "string"
    },
    "isVisible": true,
    "version": {
      "rowVersion": 0
    }
  }
]
[{"portDefinition":{"portId":0,"name":"string","portType":"Input","sourceTable":"string","referencedTable":"string","columns":[],"references":{},"timeReferences":{},"isWaypoint":true,"migrationDisplayName":"string","version":{}},"connection":{},"elementId":0,"parentBlockId":0,"bounds":{"location":{},"size":"string","x":0.1,"y":0.1,"width":0.1,"height":0.1,"left":0.1,"top":0.1,"right":0.1,"bottom":0.1,"isEmpty":true},"color":{"a":0,"b":0,"g":0,"r":0},"name":"string","parentBlock":{"id":0,"name":"string","href":"string"},"isVisible":true,"version":{"rowVersion":0}}]

Create a port element.

Body parameter

{
  "portDefinition": {
    "portId": 0,
    "name": "string",
    "portType": "Input",
    "sourceTable": "string",
    "referencedTable": "string",
    "columns": [
      {}
    ],
    "references": {
      "property1": "string",
      "property2": "string"
    },
    "timeReferences": {
      "property1": {},
      "property2": {}
    },
    "isWaypoint": true,
    "migrationDisplayName": "string",
    "version": {
      "rowVersion": 0
    }
  },
  "connection": {},
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Composer.Ports.PortElementDTO

false

The port element to create. A valid port definition should be contained inside it.

» portDefinition

body

Varicent.RESTAPI.v1.DTOs.PortDefinitionDTO

false

none

»» portId

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» portType

body

string

false

none

»» sourceTable

body

string¦null

false

none

»» referencedTable

body

string¦null

false

none

»» columns

body

[varicent.RESTAPI.v1.DTOs.PortColumnDTO]¦null

false

none

»»» portId

body

integer(int32)

false

none

»»» name

body

string¦null

false

none

»»» dataType

body

string

false

none

»»» order

body

integer(int32)

false

none

»»» isKey

body

boolean

false

none

»»» sourceColumn

body

string¦null

false

none

»» references

body

object¦null

false

none

»»» additionalProperties

body

string

false

none

»» timeReferences

body

object¦null

false

none

»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»»» levelId

body

string¦null

false

none

»»»» timeId

body

string¦null

false

none

»» isWaypoint

body

boolean

false

none

»» migrationDisplayName

body

string¦null

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» rowVersion

body

integer(int64)

false

none

» connection

body

Varicent.RESTAPI.v1.DTOs.IExpandableResourceDTO

false

none

» elementId

body

integer(int32)

false

none

» parentBlockId

body

integer(int32)¦null

false

none

» bounds

body

System.Drawing.RectangleF

false

none

»» location

body

System.Drawing.PointF

false

none

»»» isEmpty

body

boolean

false

none

»»» x

body

number(float)

false

none

»»» y

body

number(float)

false

none

»» size

body

string

false

none

»» x

body

number(float)

false

none

»» y

body

number(float)

false

none

»» width

body

number(float)

false

none

»» height

body

number(float)

false

none

»» left

body

number(float)

false

none

»» top

body

number(float)

false

none

»» right

body

number(float)

false

none

»» bottom

body

number(float)

false

none

»» isEmpty

body

boolean

false

none

» color

body

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

»» a

body

integer(int32)

false

none

»» b

body

integer(int32)

false

none

»» g

body

integer(int32)

false

none

»» r

body

integer(int32)

false

none

» name

body

string¦null

false

none

» parentBlock

body

Varicent.RESTAPI.v1.DTOs.Composer.ExpandableBlockElementDTO

false

none

»» id

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» href

body

string¦null

false

none

» isVisible

body

boolean

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

»» portType

Input

»» portType

Output

»»» dataType

String

»»» dataType

Date

»»» dataType

Numeric

»»» dataType

Int

»»» dataType

LongString

Responses

Status

Meaning

Description

Schema

201

Created

Port element and definition were created successfully

Varicent.RESTAPI.v1.DTOs.Composer.Ports.PortElementDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/ports", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/ports");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "portDefinition": {
    "portId": 0,
    "name": "string",
    "portType": "Input",
    "sourceTable": "string",
    "referencedTable": "string",
    "columns": [
      {}
    ],
    "references": {
      "property1": "string",
      "property2": "string"
    },
    "timeReferences": {
      "property1": {},
      "property2": {}
    },
    "isWaypoint": true,
    "migrationDisplayName": "string",
    "version": {
      "rowVersion": 0
    }
  },
  "connection": {},
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/ports',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/ports', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/ports',
  params: {
  }, headers: headers

p JSON.parse(result)

Get a list of global tables compatible with a given port.

Parameters

Name

In

Type

Required

Description

portId

path

integer(int32)

true

Port definition ID

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/ports/{portId}/compatibleglobaltables", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/ports/{portId}/compatibleglobaltables");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/ports/{portId}/compatibleglobaltables',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/ports/{portId}/compatibleglobaltables', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/ports/{portId}/compatibleglobaltables',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  "string"
]
["string"]

Replace a given port with a global table.

Parameters

Name

In

Type

Required

Description

portId

path

integer(int32)

true

Port definition ID

tableName

path

string

true

Name of the global table

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.DataEventDTO]

false

none

none

» type

string

false

none

none

» current

any

false

none

none

» original

any

false

none

none

Enumerated Values

Property

Value

type

Added

type

Deleted

type

Modified

type

Unchanged

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/ports/{portId}/replacebyglobaltable/{tableName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/ports/{portId}/replacebyglobaltable/{tableName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/ports/{portId}/replacebyglobaltable/{tableName}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/ports/{portId}/replacebyglobaltable/{tableName}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/ports/{portId}/replacebyglobaltable/{tableName}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "type": "Added",
    "current": null,
    "original": null
  }
]
[{"type":"Added","current":null,"original":null}]

Get table name for the root source of a port.

Parameters

Name

In

Type

Required

Description

portId

path

integer(int32)

true

Port definition ID

Responses

Status

Meaning

Description

Schema

200

OK

Success

string

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/ports/{portId}/rootsource", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/ports/{portId}/rootsource");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/ports/{portId}/rootsource',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/ports/{portId}/rootsource', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/ports/{portId}/rootsource',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
"string"
"string"

Table

Bulk delete rows in a table using a query.

Body parameter

{
  "name": "string",
  "sourceDefinition": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "dependencies": [
    "string"
  ],
  "columns": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "references": {
    "property1": "string",
    "property2": "string"
  },
  "timeReferences": {
    "property1": {
      "levelId": "string",
      "timeId": "string"
    },
    "property2": {
      "levelId": "string",
      "timeId": "string"
    }
  }
}

Parameters

Name

In

Type

Required

Description

table

path

string

true

The custom table name in which to delete rows.

body

body

Varicent.RESTAPI.v1.DTOs.QuerySourceDefinitionDTO

false

Where a clause definition is used to bulk delete rows.

» name

body

string¦null

false

none

» sourceDefinition

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»» alias

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» table

body

string¦null

false

none

»»»» customSelect

body

string¦null

false

none

»»»» dataType

body

string

false

none

»»»» type

body

string

false

none

»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»» expressionType

body

string

false

none

»»»»»» cases

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» arguments

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»» constraintType

body

string

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» condition

body

any

false

none

»»»»»»»» trueValue

body

any

false

none

»»»»»»»» falseValue

body

any

false

none

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»» constraints

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» literalRight

body

any

false

none

»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» right

body

any

false

none

»»»»»»» expressionLeft

body

any

false

none

»»»»»»» expressionRight

body

any

false

none

»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»» like

body

string¦null

false

none

»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»» trueValue

body

any

false

none

»»»»»» falseValue

body

any

false

none

»»»»»» isDate

body

boolean

false

none

»»»»»» literalType

body

string

false

none

»»»»»» value

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»» m_namespace

body

string¦null

false

none

»»»»» name

body

string¦null

false

none

»»»» query

body

any

false

none

»»»» alias

body

string¦null

false

none

»»»» sourceType

body

string

false

none

»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» joinType

body

string

false

none

»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» constraintType

body

string

false

none

»»»»» op

body

string¦null

false

none

»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» caseSensitive

body

boolean

false

none

»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isPreciseDecimal

body

boolean

false

none

»»»»» like

body

string¦null

false

none

»»»»» escapeWildcards

body

boolean

false

none

»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»» table

body

string¦null

false

none

»»»»» queryDefinitionRight

body

any

false

none

»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» direction

body

string

false

none

»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» distinct

body

boolean

false

none

»»» unionWith

body

any

false

none

»»» exceptWith

body

any

false

none

»» sourceNames

body

object¦null

false

none

»»» additionalProperties

body

string¦null

false

none

» dependencies

body

[string]¦null

false

none

» columns

body

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

»» name

body

string¦null

false

none

»» type

body

string

false

none

»» isKey

body

boolean

false

none

»» nullable

body

boolean

false

none

»» values

body

string¦null

false

none

»» lockedPeriod

body

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

»»» start

body

string(date-time)

false

none

»»» end

body

string(date-time)

false

none

»» referencedCol

body

string¦null

false

none

»» picklistFilter

body

string¦null

false

none

»» displayName

body

string¦null

false

none

»» isELTPeriod

body

boolean¦null

false

none

» references

body

object¦null

false

none

»» additionalProperties

body

string

false

none

» timeReferences

body

object¦null

false

none

»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»» levelId

body

string¦null

false

none

»»» timeId

body

string¦null

false

none

Enumerated Values

Parameter

Value

»»»» dataType

Int

»»»» dataType

Decimal

»»»» dataType

DateTime

»»»» dataType

None

»»»» dataType

String

»»»» type

SelectAll

»»»» type

SelectItem

»»»» type

SelectLiteral

»»»» type

SelectCustom

»»»» type

SelectExpression

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» expressionType

caseExpression

»»»»»» expressionType

dataField

»»»»»» expressionType

function

»»»»»» expressionType

ifExpression

»»»»»» expressionType

literal

»»»»»»» constraintType

clause

»»»»»»» constraintType

constraint

»»»»»»» constraintType

expressionConstraint

»»»»»»» constraintType

likeConstraint

»»»»»»» constraintType

rowVersionConstraint

»»»»»»» constraintType

subQueryConstraint

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»» literalType

Integer

»»»»»» literalType

Decimal

»»»»»» literalType

Date

»»»»»» literalType

DateTime

»»»»»» literalType

String

»»»»»» literalType

Float

»»»»»» literalType

Long

»»»»»» literalType

Null

»»»»»» literalType

Parameter

»»»»»» literalType

Guid

»»»»»» literalType

SystemUtcTime

»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» sourceType

Table

»»»» sourceType

Query

»»»» joinType

Inner

»»»» joinType

Left

»»»» joinType

Right

»»»» joinType

Cross

»»»» joinType

CrossApply

»»»» joinType

OuterApply

»»»»» constraintType

clause

»»»»» constraintType

constraint

»»»»» constraintType

expressionConstraint

»»»»» constraintType

likeConstraint

»»»»» constraintType

rowVersionConstraint

»»»»» constraintType

subQueryConstraint

»»»» direction

Ascending

»»»» direction

Descending

»»»» direction

AscendingNullsFirst

»»»» direction

DescendingNullsLast

»» type

String

»» type

LongString

»» type

MaxString

»» type

Date

»» type

DateTime

»» type

Decimal

»» type

Int

»» type

Long

»» type

Float

»» type

BLOB

»» type

Identity

»» type

CLOB

»» type

RowVersion

»» type

UID

»» type

VarCharMax

»» type

Boolean

Responses

Status

Meaning

Description

Schema

200

OK

Bulk deletion was successful.

None

400

Bad Request

Query definition was not defined.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/customtables/{table}/data", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/customtables/{table}/data");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "name": "string",
  "sourceDefinition": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "dependencies": [
    "string"
  ],
  "columns": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "references": {
    "property1": "string",
    "property2": "string"
  },
  "timeReferences": {
    "property1": {
      "levelId": "string",
      "timeId": "string"
    },
    "property2": {
      "levelId": "string",
      "timeId": "string"
    }
  }
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/customtables/{table}/data',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/customtables/{table}/data', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/customtables/{table}/data',
  params: {
  }, headers: headers

p JSON.parse(result)

Enable web data viewable on datastore

Parameters

Name

In

Type

Required

Description

datastoreId

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Update web data viewable state to enabled

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/datastores/enablewebdataviewable/{dataStoreId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/datastores/enablewebdataviewable/{dataStoreId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/datastores/enablewebdataviewable/{dataStoreId}',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/v1/datastores/enablewebdataviewable/{dataStoreId}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/v1/datastores/enablewebdataviewable/{dataStoreId}',
  params: {
  }

p JSON.parse(result)

Disable web data viewable on datastore

Parameters

Name

In

Type

Required

Description

datastoreId

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Update web data viewable state to disabled

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/datastores/disablewebdataviewable/{dataStoreId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/datastores/disablewebdataviewable/{dataStoreId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/datastores/disablewebdataviewable/{dataStoreId}',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/v1/datastores/disablewebdataviewable/{dataStoreId}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/v1/datastores/disablewebdataviewable/{dataStoreId}',
  params: {
  }

p JSON.parse(result)

Get global system tables.

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.TableDefinitionDTO]

false

none

none

» table

Varicent.RESTAPI.v1.DTOs.CustomTableDTO

false

none

none

»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»» rowVersion

integer(int64)

false

none

none

»» name

string¦null

false

none

none

»» tableType

string

false

none

none

»» effectiveDated

boolean

false

none

none

»» workflowObjectID

integer(int32)

false

none

none

»» hierarchyMetadata

RESTAPI.v1.DTOs.Hierarchy.HierarchyMetadataDTO

false

none

none

»»» tableName

string¦null

false

none

none

»»» idColumnName

string¦null

false

none

none

»»» parentColumnName

string¦null

false

none

none

»» lastUpdatedTracking

boolean¦null

false

none

none

» columns

[Varicent.RESTAPI.v1.DTOs.ColumnDefinitionDTO]¦null

false

none

none

»» column

Varicent.RESTAPI.v1.DTOs.CustomColumnDTO

false

none

none

»»» name

string¦null

false

none

none

»»» type

string

false

none

none

»»» referencedTable

string¦null

false

none

none

»»» referencedName

string¦null

false

none

none

»»» source

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

»»»» query

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

»»»»» selectItems

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

none

»»»»»» alias

string¦null

false

none

none

»»»»»» column

string¦null

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» customSelect

string¦null

false

none

none

»»»»»» dataType

string

false

none

none

»»»»»» type

string

false

none

none

»»»»»» value

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»»»» expressionType

string

false

none

none

»»»»»»» cases

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» column

string¦null

false

none

none

»»»»»»» op

string¦null

false

none

none

»»»»»»» arguments

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

none

[DTO version of IExpression]

»»»»»»»» expressionType

string

false

none

none

»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» table

string¦null

false

none

none

»»»»»»»» column

string¦null

false

none

none

»»»»»»»» op

string¦null

false

none

none

»»»»»»»» arguments

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»»»»» constraintType

string

false

none

none

»»»»»»»»» op

string¦null

false

none

none

»»»»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»»»» expressionType

string

false

none

none

»»»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»»» table

string¦null

false

none

none

»»»»»»»»»» column

string¦null

false

none

none

»»»»»»»»»» op

string¦null

false

none

none

»»»»»»»»»» arguments

array¦null

false

none

none

»»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»»» condition

any

false

none

none

»»»»»»»»»» trueValue

any

false

none

none

»»»»»»»»»» falseValue

any

false

none

none

»»»»»»»»»» isDate

boolean

false

none

none

»»»»»»»»»» literalType

string

false

none

none

»»»»»»»»»» value

any

false

none

none

»»»»»»»»» caseSensitive

boolean

false

none

none

»»»»»»»»» constraints

array¦null

false

none

none

»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»» literalRight

any

false

none

none

»»»»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»»» right

any

false

none

none

»»»»»»»»» expressionLeft

any

false

none

none

»»»»»»»»» expressionRight

any

false

none

none

»»»»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»»»»» like

string¦null

false

none

none

»»»»»»»»» escapeWildcards

boolean

false

none

none

»»»»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»»»» table

string¦null

false

none

none

»»»»»»»»» queryDefinitionRight

any

false

none

none

»»»»»»»» trueValue

any

false

none

none

»»»»»»»» falseValue

any

false

none

none

»»»»»»»» isDate

boolean

false

none

none

»»»»»»»» literalType

string

false

none

none

»»»»»»»» value

any

false

none

none

»»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»»» trueValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»» falseValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»» isDate

boolean

false

none

none

»»»»»»» literalType

string

false

none

none

»»»»»»» value

any

false

none

none

»»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»»»» namespaceTable

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

none

»»»»»»» m_namespace

string¦null

false

none

none

»»»»»»» name

string¦null

false

none

none

»»»»»» query

any

false

none

none

»»»»»» alias

string¦null

false

none

none

»»»»»» sourceType

string

false

none

none

»»»»» joins

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

none

»»»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»»»» joinType

string

false

none

none

»»»»»» onClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»»»» constraintType

string

false

none

none

»»»»»»» op

string¦null

false

none

none

»»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»» caseSensitive

boolean

false

none

none

»»»»»»» constraints

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

none

[DTO version of IConstraint]

»»»»»»» literalRight

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»» right

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»» expressionLeft

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»» expressionRight

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»»» like

string¦null

false

none

none

»»»»»»» escapeWildcards

boolean

false

none

none

»»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» queryDefinitionRight

any

false

none

none

»»»»» whereClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»» order

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» column

string¦null

false

none

none

»»»»»» direction

string

false

none

none

»»»»» group

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» column

string¦null

false

none

none

»»»»» havingClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»» distinct

boolean

false

none

none

»»»»» unionWith

any

false

none

none

»»»»» exceptWith

any

false

none

none

»»»» sourceNames

object¦null

false

none

none

»»»»» additionalProperties

string¦null

false

none

none

»»» pickListParams

[Varicent.RESTAPI.v1.DTOs.PickListParamDTO]¦null

false

none

none

»»»» joinAlias

string¦null

false

none

none

»»»» joinColumn

string¦null

false

none

none

»»»» op

string

false

none

none

»»» isKey

boolean

false

none

none

»» isRemovable

boolean

false

none

none

»» isNullable

boolean

false

none

none

»» referencedColumn

string¦null

false

none

none

» time

Varicent.RESTAPI.v1.DTOs.TableTimeDTO

false

none

none

»» timeId

string¦null

false

none

none

»» dateColumn

string¦null

false

none

none

»» lockedOn

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

»» min

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

»» max

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

Enumerated Values

Property

Value

tableType

System

tableType

Dimension

tableType

Structural

tableType

Lookup

tableType

Data

tableType

View

tableType

Custom

tableType

StarSchema

tableType

ExportTable

tableType

CreditingRule

tableType

AssignTable

tableType

PlcmCustomTable

tableType

PlcmStructuralTable

tableType

PlcmTable

tableType

DataSource

tableType

Cached

tableType

MaterializedView

type

Text

type

Date

type

List

type

Numeric

type

Email

type

Url

type

Comment

type

DateTime

dataType

Int

dataType

Decimal

dataType

DateTime

dataType

None

dataType

String

type

SelectAll

type

SelectItem

type

SelectLiteral

type

SelectCustom

type

SelectExpression

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

sourceType

Table

sourceType

Query

joinType

Inner

joinType

Left

joinType

Right

joinType

Cross

joinType

CrossApply

joinType

OuterApply

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

direction

Ascending

direction

Descending

direction

AscendingNullsFirst

direction

DescendingNullsLast

op

LessThan

op

LessThanEquals

op

Equals

op

NotEquals

op

GreaterThan

op

GreaterThanEquals

op

IsNull

op

IsNotNull

op

In

op

NotIn

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/globalsystemtables", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/globalsystemtables");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/globalsystemtables',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/globalsystemtables', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/globalsystemtables',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "table": {
      "version": {},
      "name": "string",
      "tableType": "System",
      "effectiveDated": true,
      "workflowObjectID": 0,
      "hierarchyMetadata": {},
      "lastUpdatedTracking": true
    },
    "columns": [
      {}
    ],
    "time": {
      "timeId": "string",
      "dateColumn": "string",
      "lockedOn": {},
      "min": {},
      "max": {}
    }
  }
]
[{"table":{"version":{},"name":"string","tableType":"System","effectiveDated":true,"workflowObjectID":0,"hierarchyMetadata":{},"lastUpdatedTracking":true},"columns":[{}],"time":{"timeId":"string","dateColumn":"string","lockedOn":{},"min":{},"max":{}}}]

Get a global system table by name.

Parameters

Name

In

Type

Required

Description

name

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.TableDefinitionDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/globalsystemtables/{name}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/globalsystemtables/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/globalsystemtables/{name}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/globalsystemtables/{name}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/globalsystemtables/{name}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "table": {
    "version": {
      "rowVersion": 0
    },
    "name": "string",
    "tableType": "System",
    "effectiveDated": true,
    "workflowObjectID": 0,
    "hierarchyMetadata": {
      "tableName": "string",
      "idColumnName": "string",
      "parentColumnName": "string"
    },
    "lastUpdatedTracking": true
  },
  "columns": [
    {
      "column": {},
      "isRemovable": true,
      "isNullable": true,
      "referencedColumn": "string"
    }
  ],
  "time": {
    "timeId": "string",
    "dateColumn": "string",
    "lockedOn": {},
    "min": {},
    "max": {}
  }
}
{"table":{"version":{"rowVersion":0},"name":"string","tableType":"System","effectiveDated":true,"workflowObjectID":0,"hierarchyMetadata":{"tableName":"string","idColumnName":"string","parentColumnName":"string"},"lastUpdatedTracking":true},"columns":[{"column":{},"isRemovable":true,"isNullable":true,"referencedColumn":"string"}],"time":{"timeId":"string","dateColumn":"string","lockedOn":{},"min":{},"max":{}}}

Get user visible system tables.

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.CustomTableDTO]

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

» name

string¦null

false

none

none

» tableType

string

false

none

none

» effectiveDated

boolean

false

none

none

» workflowObjectID

integer(int32)

false

none

none

» hierarchyMetadata

RESTAPI.v1.DTOs.Hierarchy.HierarchyMetadataDTO

false

none

none

»» tableName

string¦null

false

none

none

»» idColumnName

string¦null

false

none

none

»» parentColumnName

string¦null

false

none

none

» lastUpdatedTracking

boolean¦null

false

none

none

Enumerated Values

Property

Value

tableType

System

tableType

Dimension

tableType

Structural

tableType

Lookup

tableType

Data

tableType

View

tableType

Custom

tableType

StarSchema

tableType

ExportTable

tableType

CreditingRule

tableType

AssignTable

tableType

PlcmCustomTable

tableType

PlcmStructuralTable

tableType

PlcmTable

tableType

DataSource

tableType

Cached

tableType

MaterializedView

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/uservisiblesystemtables", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/uservisiblesystemtables");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/uservisiblesystemtables',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/uservisiblesystemtables', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/uservisiblesystemtables',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "version": {
      "rowVersion": 0
    },
    "name": "string",
    "tableType": "System",
    "effectiveDated": true,
    "workflowObjectID": 0,
    "hierarchyMetadata": {
      "tableName": "string",
      "idColumnName": "string",
      "parentColumnName": "string"
    },
    "lastUpdatedTracking": true
  }
]
[{"version":{"rowVersion":0},"name":"string","tableType":"System","effectiveDated":true,"workflowObjectID":0,"hierarchyMetadata":{"tableName":"string","idColumnName":"string","parentColumnName":"string"},"lastUpdatedTracking":true}]

Get a user visible system table by name.

Parameters

Name

In

Type

Required

Description

table

path

string

true

User visible system table name

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.TableDefinitionDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/uservisiblesystemtables/{table}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/uservisiblesystemtables/{table}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/uservisiblesystemtables/{table}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/uservisiblesystemtables/{table}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/uservisiblesystemtables/{table}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "table": {
    "version": {
      "rowVersion": 0
    },
    "name": "string",
    "tableType": "System",
    "effectiveDated": true,
    "workflowObjectID": 0,
    "hierarchyMetadata": {
      "tableName": "string",
      "idColumnName": "string",
      "parentColumnName": "string"
    },
    "lastUpdatedTracking": true
  },
  "columns": [
    {
      "column": {},
      "isRemovable": true,
      "isNullable": true,
      "referencedColumn": "string"
    }
  ],
  "time": {
    "timeId": "string",
    "dateColumn": "string",
    "lockedOn": {},
    "min": {},
    "max": {}
  }
}
{"table":{"version":{"rowVersion":0},"name":"string","tableType":"System","effectiveDated":true,"workflowObjectID":0,"hierarchyMetadata":{"tableName":"string","idColumnName":"string","parentColumnName":"string"},"lastUpdatedTracking":true},"columns":[{"column":{},"isRemovable":true,"isNullable":true,"referencedColumn":"string"}],"time":{"timeId":"string","dateColumn":"string","lockedOn":{},"min":{},"max":{}}}

Get data from a system table.

Parameters

Name

In

Type

Required

Description

table

path

string

true

The table name.

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

filter

query

string

false

####Supported operations

fields

query

string

false

Comma delimited list of fields to display. Used to limit the output results to selected columns.

unique

query

boolean

false

Boolean value to select only unique values. Default value is false.

orderBy

query

string

false

none

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

Any column

fields: Comma delimited list of fields to display. Used to limit the output results to selected columns.

Defaults to all available fields.

Examples

fields=PayeeID_

unique: Boolean value to select only unique values. Default value is false. When enabled, must specify exactly one column field.

Responses

Status

Meaning

Description

Schema

200

OK

Get data for given system table (filter, limit, offset supported)

Varicent.RESTAPI.v1.DTOs.ResultSetDTOVaricent.RESTAPI.v1.DTOs.ResultSetDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/uservisiblesystemtables/{table}/data", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/uservisiblesystemtables/{table}/data");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/uservisiblesystemtables/{table}/data',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/uservisiblesystemtables/{table}/data', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/uservisiblesystemtables/{table}/data',
  params: {
  }, headers: headers

p JSON.parse(result)

Get data from the audit table.

Parameters

Name

In

Type

Required

Description

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

filter

query

string

false

####Supported operations

unique

query

boolean

false

Boolean value to select only unique values. Default value is false.

orderBy

query

string

false

none

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

Any column

unique: Boolean value to select only unique values. Default value is false. When enabled, must specify exactly one column field.

Responses

Status

Meaning

Description

Schema

200

OK

Get data from the audit table (filter, limit, offset supported)

Varicent.RESTAPI.v1.DTOs.ResultSetDTOVaricent.RESTAPI.v1.DTOs.ResultSetDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/uservisiblesystemtables/Audit_/data", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/uservisiblesystemtables/Audit_/data");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/uservisiblesystemtables/Audit_/data',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/uservisiblesystemtables/Audit_/data', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/uservisiblesystemtables/Audit_/data',
  params: {
  }, headers: headers

p JSON.parse(result)

Get additional data for a table.

Parameters

Name

In

Type

Required

Description

tableName

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get additional data for a table

Varicent.RESTAPI.v1.DTOs.TableAdditionalDataDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/tableadditionaldata/{tableName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/tableadditionaldata/{tableName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/tableadditionaldata/{tableName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/tableadditionaldata/{tableName}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/tableadditionaldata/{tableName}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "isWebEnabled": true,
  "isHistoryEnabled": true,
  "comment": "string",
  "isGlobal": true,
  "directEdit": true,
  "isWebDataEditEditable": true,
  "arePendingEditsActionable": true,
  "isWebDataViewable": true,
  "isReadOnly": true,
  "isOptimizedEditEnabled": true
}
{"isWebEnabled":true,"isHistoryEnabled":true,"comment":"string","isGlobal":true,"directEdit":true,"isWebDataEditEditable":true,"arePendingEditsActionable":true,"isWebDataViewable":true,"isReadOnly":true,"isOptimizedEditEnabled":true}

Update additional data for a table.

Body parameter

{
  "isWebEnabled": true,
  "isHistoryEnabled": true,
  "comment": "string",
  "isGlobal": true,
  "directEdit": true,
  "isWebDataEditEditable": true,
  "arePendingEditsActionable": true,
  "isWebDataViewable": true,
  "isReadOnly": true,
  "isOptimizedEditEnabled": true
}

Parameters

Name

In

Type

Required

Description

tableName

path

string

true

none

body

body

Varicent.RESTAPI.v1.DTOs.TableAdditionalDataDTO

false

none

» isWebEnabled

body

boolean

false

none

» isHistoryEnabled

body

boolean

false

none

» comment

body

string¦null

false

none

» isGlobal

body

boolean

false

none

» directEdit

body

boolean

false

none

» isWebDataEditEditable

body

boolean

false

none

» arePendingEditsActionable

body

boolean

false

none

» isWebDataViewable

body

boolean

false

none

» isReadOnly

body

boolean

false

none

» isOptimizedEditEnabled

body

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Update additional data for a table

Varicent.RESTAPI.v1.DTOs.TableAdditionalDataDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/tableadditionaldata/{tableName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/tableadditionaldata/{tableName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "isWebEnabled": true,
  "isHistoryEnabled": true,
  "comment": "string",
  "isGlobal": true,
  "directEdit": true,
  "isWebDataEditEditable": true,
  "arePendingEditsActionable": true,
  "isWebDataViewable": true,
  "isReadOnly": true,
  "isOptimizedEditEnabled": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/tableadditionaldata/{tableName}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/tableadditionaldata/{tableName}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/tableadditionaldata/{tableName}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "isWebEnabled": true,
  "isHistoryEnabled": true,
  "comment": "string",
  "isGlobal": true,
  "directEdit": true,
  "isWebDataEditEditable": true,
  "arePendingEditsActionable": true,
  "isWebDataViewable": true,
  "isReadOnly": true,
  "isOptimizedEditEnabled": true
}
{"isWebEnabled":true,"isHistoryEnabled":true,"comment":"string","isGlobal":true,"directEdit":true,"isWebDataEditEditable":true,"arePendingEditsActionable":true,"isWebDataViewable":true,"isReadOnly":true,"isOptimizedEditEnabled":true}

Update additional data for a table asynchronously.

Body parameter

{
  "isWebEnabled": true,
  "isHistoryEnabled": true,
  "comment": "string",
  "isGlobal": true,
  "directEdit": true,
  "isWebDataEditEditable": true,
  "arePendingEditsActionable": true,
  "isWebDataViewable": true,
  "isReadOnly": true,
  "isOptimizedEditEnabled": true
}

Parameters

Name

In

Type

Required

Description

tableName

path

string

true

none

body

body

Varicent.RESTAPI.v1.DTOs.TableAdditionalDataDTO

false

none

» isWebEnabled

body

boolean

false

none

» isHistoryEnabled

body

boolean

false

none

» comment

body

string¦null

false

none

» isGlobal

body

boolean

false

none

» directEdit

body

boolean

false

none

» isWebDataEditEditable

body

boolean

false

none

» arePendingEditsActionable

body

boolean

false

none

» isWebDataViewable

body

boolean

false

none

» isReadOnly

body

boolean

false

none

» isOptimizedEditEnabled

body

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Update additional data for a table

Varicent.RESTAPI.v1.DTOs.TableAdditionalDataDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/tableadditionaldata/{tableName}/async", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/tableadditionaldata/{tableName}/async");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "isWebEnabled": true,
  "isHistoryEnabled": true,
  "comment": "string",
  "isGlobal": true,
  "directEdit": true,
  "isWebDataEditEditable": true,
  "arePendingEditsActionable": true,
  "isWebDataViewable": true,
  "isReadOnly": true,
  "isOptimizedEditEnabled": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/tableadditionaldata/{tableName}/async',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/tableadditionaldata/{tableName}/async', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/tableadditionaldata/{tableName}/async',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "isWebEnabled": true,
  "isHistoryEnabled": true,
  "comment": "string",
  "isGlobal": true,
  "directEdit": true,
  "isWebDataEditEditable": true,
  "arePendingEditsActionable": true,
  "isWebDataViewable": true,
  "isReadOnly": true,
  "isOptimizedEditEnabled": true
}
{"isWebEnabled":true,"isHistoryEnabled":true,"comment":"string","isGlobal":true,"directEdit":true,"isWebDataEditEditable":true,"arePendingEditsActionable":true,"isWebDataViewable":true,"isReadOnly":true,"isOptimizedEditEnabled":true}

Update the isHistoryEnabled parameter for multiple tables.

Body parameter

{
  "enableTables": [
    "string"
  ],
  "disableTables": [
    "string"
  ]
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.TableAdditionalDataPatchDTO

false

none

» enableTables

body

[string]¦null

false

none

» disableTables

body

[string]¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

The isHistoryEnabled parameter has been updated for multiple tables

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/rpc/tableadditionaldata", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/tableadditionaldata");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "enableTables": [
    "string"
  ],
  "disableTables": [
    "string"
  ]
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/tableadditionaldata',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/rpc/tableadditionaldata', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/rpc/tableadditionaldata',
  params: {
  }, headers: headers

p JSON.parse(result)

Update the isHistoryEnabled parameter for a single table.

Body parameter

{
  "isWebEnabled": true,
  "isHistoryEnabled": true,
  "comment": "string",
  "isGlobal": true,
  "directEdit": true,
  "isWebDataEditEditable": true,
  "arePendingEditsActionable": true,
  "isWebDataViewable": true,
  "isReadOnly": true,
  "isOptimizedEditEnabled": true
}

Parameters

Name

In

Type

Required

Description

tableName

path

string

true

none

body

body

Varicent.RESTAPI.v1.DTOs.TableAdditionalDataDTO

false

none

» isWebEnabled

body

boolean

false

none

» isHistoryEnabled

body

boolean

false

none

» comment

body

string¦null

false

none

» isGlobal

body

boolean

false

none

» directEdit

body

boolean

false

none

» isWebDataEditEditable

body

boolean

false

none

» arePendingEditsActionable

body

boolean

false

none

» isWebDataViewable

body

boolean

false

none

» isReadOnly

body

boolean

false

none

» isOptimizedEditEnabled

body

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Update additional data for a table

Varicent.RESTAPI.v1.DTOs.TableAdditionalDataDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/tableadditionaldata/historytracking/{tableName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/tableadditionaldata/historytracking/{tableName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "isWebEnabled": true,
  "isHistoryEnabled": true,
  "comment": "string",
  "isGlobal": true,
  "directEdit": true,
  "isWebDataEditEditable": true,
  "arePendingEditsActionable": true,
  "isWebDataViewable": true,
  "isReadOnly": true,
  "isOptimizedEditEnabled": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/tableadditionaldata/historytracking/{tableName}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/tableadditionaldata/historytracking/{tableName}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/tableadditionaldata/historytracking/{tableName}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "isWebEnabled": true,
  "isHistoryEnabled": true,
  "comment": "string",
  "isGlobal": true,
  "directEdit": true,
  "isWebDataEditEditable": true,
  "arePendingEditsActionable": true,
  "isWebDataViewable": true,
  "isReadOnly": true,
  "isOptimizedEditEnabled": true
}
{"isWebEnabled":true,"isHistoryEnabled":true,"comment":"string","isGlobal":true,"directEdit":true,"isWebDataEditEditable":true,"arePendingEditsActionable":true,"isWebDataViewable":true,"isReadOnly":true,"isOptimizedEditEnabled":true}

Get affected tables for the table table that is being cleared

Parameters

Name

In

Type

Required

Description

tableName

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Return tables affected by current table clear

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/getdeleteactionreferencedtables/{tablename}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/getdeleteactionreferencedtables/{tablename}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/getdeleteactionreferencedtables/{tablename}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/getdeleteactionreferencedtables/{tablename}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/getdeleteactionreferencedtables/{tablename}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  "string"
]
["string"]

Task Manager

Get all groups.

Responses

Status

Meaning

Description

Schema

200

OK

Get all groups

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.TaskManager.TaskGroupTreeListNodeItemDTO]

false

none

none

» name

string¦null

false

none

none

» comment

string¦null

false

none

none

» resourceId

integer(int32)¦null

false

none

none

» type

string

false

none

none

» group

Varicent.RESTAPI.v1.DTOs.TaskManager.TaskGroupDTO

false

none

none

»» groupId

integer(int32)

false

none

none

»» name

string¦null

false

none

none

»» source

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

»»» query

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

»»»» selectItems

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

none

»»»»» alias

string¦null

false

none

none

»»»»» column

string¦null

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» customSelect

string¦null

false

none

none

»»»»» dataType

string

false

none

none

»»»»» type

string

false

none

none

»»»»» value

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»»» expressionType

string

false

none

none

»»»»»» cases

array¦null

false

none

none

»»»»»»» anonymous

any

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» column

string¦null

false

none

none

»»»»»» op

string¦null

false

none

none

»»»»»» arguments

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

none

[DTO version of IExpression]

»»»»»»» expressionType

string

false

none

none

»»»»»»» cases

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» column

string¦null

false

none

none

»»»»»»» op

string¦null

false

none

none

»»»»»»» arguments

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»»»» constraintType

string

false

none

none

»»»»»»»» op

string¦null

false

none

none

»»»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»»» expressionType

string

false

none

none

»»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»» table

string¦null

false

none

none

»»»»»»»»» column

string¦null

false

none

none

»»»»»»»»» op

string¦null

false

none

none

»»»»»»»»» arguments

array¦null

false

none

none

»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»» condition

any

false

none

none

»»»»»»»»» trueValue

any

false

none

none

»»»»»»»»» falseValue

any

false

none

none

»»»»»»»»» isDate

boolean

false

none

none

»»»»»»»»» literalType

string

false

none

none

»»»»»»»»» value

any

false

none

none

»»»»»»»» caseSensitive

boolean

false

none

none

»»»»»»»» constraints

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» literalRight

any

false

none

none

»»»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»» right

any

false

none

none

»»»»»»»» expressionLeft

any

false

none

none

»»»»»»»» expressionRight

any

false

none

none

»»»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»»»» like

string¦null

false

none

none

»»»»»»»» escapeWildcards

boolean

false

none

none

»»»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»»»» rowVersion

integer(int64)

false

none

none

»»»»»»»» table

string¦null

false

none

none

»»»»»»»» queryDefinitionRight

any

false

none

none

»»»»»»» trueValue

any

false

none

none

»»»»»»» falseValue

any

false

none

none

»»»»»»» isDate

boolean

false

none

none

»»»»»»» literalType

string

false

none

none

»»»»»»» value

any

false

none

none

»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»» trueValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»» falseValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»» isDate

boolean

false

none

none

»»»»»» literalType

string

false

none

none

»»»»»» value

any

false

none

none

»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»»» namespaceTable

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

none

»»»»»» m_namespace

string¦null

false

none

none

»»»»»» name

string¦null

false

none

none

»»»»» query

any

false

none

none

»»»»» alias

string¦null

false

none

none

»»»»» sourceType

string

false

none

none

»»»» joins

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

none

»»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»»» joinType

string

false

none

none

»»»»» onClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»»» constraintType

string

false

none

none

»»»»»» op

string¦null

false

none

none

»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»» caseSensitive

boolean

false

none

none

»»»»»» constraints

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

none

[DTO version of IConstraint]

»»»»»» literalRight

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»» right

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»» expressionLeft

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»» expressionRight

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»» like

string¦null

false

none

none

»»»»»» escapeWildcards

boolean

false

none

none

»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» queryDefinitionRight

any

false

none

none

»»»» whereClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»» order

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» column

string¦null

false

none

none

»»»»» direction

string

false

none

none

»»»» group

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» column

string¦null

false

none

none

»»»» havingClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»» distinct

boolean

false

none

none

»»»» unionWith

any

false

none

none

»»»» exceptWith

any

false

none

none

»»» sourceNames

object¦null

false

none

none

»»»» additionalProperties

string¦null

false

none

none

» id

integer(int32)

false

none

none

» parent

integer(int32)¦null

false

none

none

» oldParent

integer(int32)¦null

false

none

none

» prev

integer(int32)¦null

false

none

none

» oldPrev

integer(int32)¦null

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

type

Group

type

Folder

dataType

Int

dataType

Decimal

dataType

DateTime

dataType

None

dataType

String

type

SelectAll

type

SelectItem

type

SelectLiteral

type

SelectCustom

type

SelectExpression

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

sourceType

Table

sourceType

Query

joinType

Inner

joinType

Left

joinType

Right

joinType

Cross

joinType

CrossApply

joinType

OuterApply

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

direction

Ascending

direction

Descending

direction

AscendingNullsFirst

direction

DescendingNullsLast

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/task-manager/groups", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/task-manager/groups");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/task-manager/groups',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/task-manager/groups', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/task-manager/groups',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "name": "string",
    "comment": "string",
    "resourceId": 0,
    "type": "Group",
    "group": {
      "groupId": 0,
      "name": "string",
      "source": {}
    },
    "id": 0,
    "parent": 0,
    "oldParent": 0,
    "prev": 0,
    "oldPrev": 0,
    "version": {
      "rowVersion": 0
    }
  }
]
[{"name":"string","comment":"string","resourceId":0,"type":"Group","group":{"groupId":0,"name":"string","source":{}},"id":0,"parent":0,"oldParent":0,"prev":0,"oldPrev":0,"version":{"rowVersion":0}}]

Add a new group.

Body parameter

{
  "name": "string",
  "comment": "string",
  "resourceId": 0,
  "type": "Group",
  "group": {
    "groupId": 0,
    "name": "string",
    "source": {
      "query": {},
      "sourceNames": {}
    }
  },
  "id": 0,
  "parent": 0,
  "oldParent": 0,
  "prev": 0,
  "oldPrev": 0,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.TaskManager.TaskGroupTreeListNodeItemDTO

false

none

» name

body

string¦null

false

none

» comment

body

string¦null

false

none

» resourceId

body

integer(int32)¦null

false

none

» type

body

string

false

none

» group

body

Varicent.RESTAPI.v1.DTOs.TaskManager.TaskGroupDTO

false

none

»» groupId

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»»» alias

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» table

body

string¦null

false

none

»»»»» customSelect

body

string¦null

false

none

»»»»» dataType

body

string

false

none

»»»»» type

body

string

false

none

»»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»» expressionType

body

string

false

none

»»»»»» cases

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»»» expressionType

body

string

false

none

»»»»»»» cases

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» arguments

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»» constraintType

body

string

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»» condition

body

any

false

none

»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»» literalType

body

string

false

none

»»»»»»»»» value

body

any

false

none

»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»» constraints

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» literalRight

body

any

false

none

»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» right

body

any

false

none

»»»»»»»» expressionLeft

body

any

false

none

»»»»»»»» expressionRight

body

any

false

none

»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»» like

body

string¦null

false

none

»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»»» trueValue

body

any

false

none

»»»»»»» falseValue

body

any

false

none

»»»»»»» isDate

body

boolean

false

none

»»»»»»» literalType

body

string

false

none

»»»»»»» value

body

any

false

none

»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» isDate

body

boolean

false

none

»»»»»» literalType

body

string

false

none

»»»»»» value

body

any

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»»» m_namespace

body

string¦null

false

none

»»»»»» name

body

string¦null

false

none

»»»»» query

body

any

false

none

»»»»» alias

body

string¦null

false

none

»»»»» sourceType

body

string

false

none

»»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»» joinType

body

string

false

none

»»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»» constraintType

body

string

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»» caseSensitive

body

boolean

false

none

»»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»» like

body

string¦null

false

none

»»»»»» escapeWildcards

body

boolean

false

none

»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» queryDefinitionRight

body

any

false

none

»»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» direction

body

string

false

none

»»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»» distinct

body

boolean

false

none

»»»» unionWith

body

any

false

none

»»»» exceptWith

body

any

false

none

»»» sourceNames

body

object¦null

false

none

»»»» additionalProperties

body

string¦null

false

none

» id

body

integer(int32)

false

none

» parent

body

integer(int32)¦null

false

none

» oldParent

body

integer(int32)¦null

false

none

» prev

body

integer(int32)¦null

false

none

» oldPrev

body

integer(int32)¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

» type

Group

» type

Folder

»»»»» dataType

Int

»»»»» dataType

Decimal

»»»»» dataType

DateTime

»»»»» dataType

None

»»»»» dataType

String

»»»»» type

SelectAll

»»»»» type

SelectItem

»»»»» type

SelectLiteral

»»»»» type

SelectCustom

»»»»» type

SelectExpression

»»»»»» expressionType

caseExpression

»»»»»» expressionType

dataField

»»»»»» expressionType

function

»»»»»» expressionType

ifExpression

»»»»»» expressionType

literal

»»»»»»» expressionType

caseExpression

»»»»»»» expressionType

dataField

»»»»»»» expressionType

function

»»»»»»» expressionType

ifExpression

»»»»»»» expressionType

literal

»»»»»»»» constraintType

clause

»»»»»»»» constraintType

constraint

»»»»»»»» constraintType

expressionConstraint

»»»»»»»» constraintType

likeConstraint

»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»» constraintType

subQueryConstraint

»»»»»»»»» expressionType

caseExpression

»»»»»»»»» expressionType

dataField

»»»»»»»»» expressionType

function

»»»»»»»»» expressionType

ifExpression

»»»»»»»»» expressionType

literal

»»»»»»»»» literalType

Integer

»»»»»»»»» literalType

Decimal

»»»»»»»»» literalType

Date

»»»»»»»»» literalType

DateTime

»»»»»»»»» literalType

String

»»»»»»»»» literalType

Float

»»»»»»»»» literalType

Long

»»»»»»»»» literalType

Null

»»»»»»»»» literalType

Parameter

»»»»»»»»» literalType

Guid

»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»» literalType

Boolean

»»»»»»» literalType

Integer

»»»»»»» literalType

Decimal

»»»»»»» literalType

Date

»»»»»»» literalType

DateTime

»»»»»»» literalType

String

»»»»»»» literalType

Float

»»»»»»» literalType

Long

»»»»»»» literalType

Null

»»»»»»» literalType

Parameter

»»»»»»» literalType

Guid

»»»»»»» literalType

SystemUtcTime

»»»»»»» literalType

Boolean

»»»»»» literalType

Integer

»»»»»» literalType

Decimal

»»»»»» literalType

Date

»»»»»» literalType

DateTime

»»»»»» literalType

String

»»»»»» literalType

Float

»»»»»» literalType

Long

»»»»»» literalType

Null

»»»»»» literalType

Parameter

»»»»»» literalType

Guid

»»»»»» literalType

SystemUtcTime

»»»»»» literalType

Boolean

»»»»» sourceType

Table

»»»»» sourceType

Query

»»»»» joinType

Inner

»»»»» joinType

Left

»»»»» joinType

Right

»»»»» joinType

Cross

»»»»» joinType

CrossApply

»»»»» joinType

OuterApply

»»»»»» constraintType

clause

»»»»»» constraintType

constraint

»»»»»» constraintType

expressionConstraint

»»»»»» constraintType

likeConstraint

»»»»»» constraintType

rowVersionConstraint

»»»»»» constraintType

subQueryConstraint

»»»»» direction

Ascending

»»»»» direction

Descending

»»»»» direction

AscendingNullsFirst

»»»»» direction

DescendingNullsLast

Responses

Status

Meaning

Description

Schema

200

OK

Add a new group

Varicent.RESTAPI.v1.DTOs.TaskManager.TaskGroupTreeListNodeItemDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/task-manager/groups", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/task-manager/groups");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "name": "string",
  "comment": "string",
  "resourceId": 0,
  "type": "Group",
  "group": {
    "groupId": 0,
    "name": "string",
    "source": {
      "query": {},
      "sourceNames": {}
    }
  },
  "id": 0,
  "parent": 0,
  "oldParent": 0,
  "prev": 0,
  "oldPrev": 0,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/task-manager/groups',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/task-manager/groups', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/task-manager/groups',
  params: {
  }, headers: headers

p JSON.parse(result)

Get a group.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get a group

Varicent.RESTAPI.v1.DTOs.TaskManager.TaskGroupTreeListNodeItemDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/task-manager/groups/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/task-manager/groups/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/task-manager/groups/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/task-manager/groups/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/task-manager/groups/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "name": "string",
  "comment": "string",
  "resourceId": 0,
  "type": "Group",
  "group": {
    "groupId": 0,
    "name": "string",
    "source": {
      "query": {},
      "sourceNames": {}
    }
  },
  "id": 0,
  "parent": 0,
  "oldParent": 0,
  "prev": 0,
  "oldPrev": 0,
  "version": {
    "rowVersion": 0
  }
}
{"name":"string","comment":"string","resourceId":0,"type":"Group","group":{"groupId":0,"name":"string","source":{"query":{},"sourceNames":{}}},"id":0,"parent":0,"oldParent":0,"prev":0,"oldPrev":0,"version":{"rowVersion":0}}

Update an existing group.

Body parameter

{
  "name": "string",
  "comment": "string",
  "resourceId": 0,
  "type": "Group",
  "group": {
    "groupId": 0,
    "name": "string",
    "source": {
      "query": {},
      "sourceNames": {}
    }
  },
  "id": 0,
  "parent": 0,
  "oldParent": 0,
  "prev": 0,
  "oldPrev": 0,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.TaskManager.TaskGroupTreeListNodeItemDTO

false

none

» name

body

string¦null

false

none

» comment

body

string¦null

false

none

» resourceId

body

integer(int32)¦null

false

none

» type

body

string

false

none

» group

body

Varicent.RESTAPI.v1.DTOs.TaskManager.TaskGroupDTO

false

none

»» groupId

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»»» alias

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» table

body

string¦null

false

none

»»»»» customSelect

body

string¦null

false

none

»»»»» dataType

body

string

false

none

»»»»» type

body

string

false

none

»»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»» expressionType

body

string

false

none

»»»»»» cases

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»»» expressionType

body

string

false

none

»»»»»»» cases

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» arguments

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»» constraintType

body

string

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»» condition

body

any

false

none

»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»» literalType

body

string

false

none

»»»»»»»»» value

body

any

false

none

»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»» constraints

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» literalRight

body

any

false

none

»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» right

body

any

false

none

»»»»»»»» expressionLeft

body

any

false

none

»»»»»»»» expressionRight

body

any

false

none

»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»» like

body

string¦null

false

none

»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»»» trueValue

body

any

false

none

»»»»»»» falseValue

body

any

false

none

»»»»»»» isDate

body

boolean

false

none

»»»»»»» literalType

body

string

false

none

»»»»»»» value

body

any

false

none

»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» isDate

body

boolean

false

none

»»»»»» literalType

body

string

false

none

»»»»»» value

body

any

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»»» m_namespace

body

string¦null

false

none

»»»»»» name

body

string¦null

false

none

»»»»» query

body

any

false

none

»»»»» alias

body

string¦null

false

none

»»»»» sourceType

body

string

false

none

»»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»» joinType

body

string

false

none

»»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»» constraintType

body

string

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»» caseSensitive

body

boolean

false

none

»»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»» like

body

string¦null

false

none

»»»»»» escapeWildcards

body

boolean

false

none

»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» queryDefinitionRight

body

any

false

none

»»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» direction

body

string

false

none

»»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»» distinct

body

boolean

false

none

»»»» unionWith

body

any

false

none

»»»» exceptWith

body

any

false

none

»»» sourceNames

body

object¦null

false

none

»»»» additionalProperties

body

string¦null

false

none

» id

body

integer(int32)

false

none

» parent

body

integer(int32)¦null

false

none

» oldParent

body

integer(int32)¦null

false

none

» prev

body

integer(int32)¦null

false

none

» oldPrev

body

integer(int32)¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

» type

Group

» type

Folder

»»»»» dataType

Int

»»»»» dataType

Decimal

»»»»» dataType

DateTime

»»»»» dataType

None

»»»»» dataType

String

»»»»» type

SelectAll

»»»»» type

SelectItem

»»»»» type

SelectLiteral

»»»»» type

SelectCustom

»»»»» type

SelectExpression

»»»»»» expressionType

caseExpression

»»»»»» expressionType

dataField

»»»»»» expressionType

function

»»»»»» expressionType

ifExpression

»»»»»» expressionType

literal

»»»»»»» expressionType

caseExpression

»»»»»»» expressionType

dataField

»»»»»»» expressionType

function

»»»»»»» expressionType

ifExpression

»»»»»»» expressionType

literal

»»»»»»»» constraintType

clause

»»»»»»»» constraintType

constraint

»»»»»»»» constraintType

expressionConstraint

»»»»»»»» constraintType

likeConstraint

»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»» constraintType

subQueryConstraint

»»»»»»»»» expressionType

caseExpression

»»»»»»»»» expressionType

dataField

»»»»»»»»» expressionType

function

»»»»»»»»» expressionType

ifExpression

»»»»»»»»» expressionType

literal

»»»»»»»»» literalType

Integer

»»»»»»»»» literalType

Decimal

»»»»»»»»» literalType

Date

»»»»»»»»» literalType

DateTime

»»»»»»»»» literalType

String

»»»»»»»»» literalType

Float

»»»»»»»»» literalType

Long

»»»»»»»»» literalType

Null

»»»»»»»»» literalType

Parameter

»»»»»»»»» literalType

Guid

»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»» literalType

Boolean

»»»»»»» literalType

Integer

»»»»»»» literalType

Decimal

»»»»»»» literalType

Date

»»»»»»» literalType

DateTime

»»»»»»» literalType

String

»»»»»»» literalType

Float

»»»»»»» literalType

Long

»»»»»»» literalType

Null

»»»»»»» literalType

Parameter

»»»»»»» literalType

Guid

»»»»»»» literalType

SystemUtcTime

»»»»»»» literalType

Boolean

»»»»»» literalType

Integer

»»»»»» literalType

Decimal

»»»»»» literalType

Date

»»»»»» literalType

DateTime

»»»»»» literalType

String

»»»»»» literalType

Float

»»»»»» literalType

Long

»»»»»» literalType

Null

»»»»»» literalType

Parameter

»»»»»» literalType

Guid

»»»»»» literalType

SystemUtcTime

»»»»»» literalType

Boolean

»»»»» sourceType

Table

»»»»» sourceType

Query

»»»»» joinType

Inner

»»»»» joinType

Left

»»»»» joinType

Right

»»»»» joinType

Cross

»»»»» joinType

CrossApply

»»»»» joinType

OuterApply

»»»»»» constraintType

clause

»»»»»» constraintType

constraint

»»»»»» constraintType

expressionConstraint

»»»»»» constraintType

likeConstraint

»»»»»» constraintType

rowVersionConstraint

»»»»»» constraintType

subQueryConstraint

»»»»» direction

Ascending

»»»»» direction

Descending

»»»»» direction

AscendingNullsFirst

»»»»» direction

DescendingNullsLast

Responses

Status

Meaning

Description

Schema

200

OK

Update an existing group

Varicent.RESTAPI.v1.DTOs.TaskManager.TaskGroupTreeListNodeItemDTO

400

Bad Request

Bad Request

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/task-manager/groups/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/task-manager/groups/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "name": "string",
  "comment": "string",
  "resourceId": 0,
  "type": "Group",
  "group": {
    "groupId": 0,
    "name": "string",
    "source": {
      "query": {},
      "sourceNames": {}
    }
  },
  "id": 0,
  "parent": 0,
  "oldParent": 0,
  "prev": 0,
  "oldPrev": 0,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/task-manager/groups/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/task-manager/groups/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/task-manager/groups/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

Delete an existing group.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Delete an existing group

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/task-manager/groups/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/task-manager/groups/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/task-manager/groups/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/task-manager/groups/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/task-manager/groups/{id}',
  params: {
  }

p JSON.parse(result)

Get all rules.

Responses

Status

Meaning

Description

Schema

200

OK

Get all rules

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.TaskManager.TaskRuleTreeListNodeItemDTO]

false

none

none

» resourceId

integer(int32)¦null

false

none

none

» name

string¦null

false

none

none

» comment

string¦null

false

none

none

» type

string

false

none

none

» rule

Varicent.RESTAPI.v1.DTOs.TaskManager.TaskRuleDTO

false

none

none

»» id

integer(int32)

false

none

none

»» name

string¦null

false

none

none

»» action

Varicent.RESTAPI.v1.DTOs.TaskManager.TaskActionDTO

false

none

none

»»» id

integer(int32)

false

none

none

»»» type

string

false

none

none

»»» parameters

[Varicent.RESTAPI.v1.DTOs.TaskManager.ParameterPairDTO]¦null

false

none

none

»»»» displayText

string¦null

false

none

none

»»»» value

string¦null

false

none

none

»»»» type

string¦null

false

none

none

»» roleIds

[integer]¦null

false

none

none

»» columns

[string]¦null

false

none

none

» isVisible

boolean

false

none

none

» id

integer(int32)

false

none

none

» parent

integer(int32)¦null

false

none

none

» oldParent

integer(int32)¦null

false

none

none

» prev

integer(int32)¦null

false

none

none

» oldPrev

integer(int32)¦null

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

Enumerated Values

Property

Value

type

Rule

type

Folder

type

Alert

type

Alert

type

PayeeGroupAdd

type

PayeeGroupRemove

type

WorkflowAddToGroup

type

WorkflowRemoveFromGroup

type

WorkflowEnableAndNotifyGroupForWeb

type

AlertTailoredReportNotEmpty

type

PayeeGroupSetEndDate

type

PayeeGroupAddAsOfToday

type

WorkflowMaintainGroup

type

WorkflowEnableGroupForWebDataEdit

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/task-manager/rules", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/task-manager/rules");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/task-manager/rules',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/task-manager/rules', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/task-manager/rules',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "resourceId": 0,
    "name": "string",
    "comment": "string",
    "type": "Rule",
    "rule": {
      "id": 0,
      "name": "string",
      "action": {},
      "roleIds": [],
      "columns": []
    },
    "isVisible": true,
    "id": 0,
    "parent": 0,
    "oldParent": 0,
    "prev": 0,
    "oldPrev": 0,
    "version": {
      "rowVersion": 0
    }
  }
]
[{"resourceId":0,"name":"string","comment":"string","type":"Rule","rule":{"id":0,"name":"string","action":{},"roleIds":[],"columns":[]},"isVisible":true,"id":0,"parent":0,"oldParent":0,"prev":0,"oldPrev":0,"version":{"rowVersion":0}}]

Add a new rule.

Body parameter

{
  "resourceId": 0,
  "name": "string",
  "comment": "string",
  "type": "Rule",
  "rule": {
    "id": 0,
    "name": "string",
    "action": {
      "id": 0,
      "type": "Alert",
      "parameters": []
    },
    "roleIds": [
      0
    ],
    "columns": [
      "string"
    ]
  },
  "isVisible": true,
  "id": 0,
  "parent": 0,
  "oldParent": 0,
  "prev": 0,
  "oldPrev": 0,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.TaskManager.TaskRuleTreeListNodeItemDTO

false

none

» resourceId

body

integer(int32)¦null

false

none

» name

body

string¦null

false

none

» comment

body

string¦null

false

none

» type

body

string

false

none

» rule

body

Varicent.RESTAPI.v1.DTOs.TaskManager.TaskRuleDTO

false

none

»» id

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» action

body

Varicent.RESTAPI.v1.DTOs.TaskManager.TaskActionDTO

false

none

»»» id

body

integer(int32)

false

none

»»» type

body

string

false

none

»»» parameters

body

[Varicent.RESTAPI.v1.DTOs.TaskManager.ParameterPairDTO]¦null

false

none

»»»» displayText

body

string¦null

false

none

»»»» value

body

string¦null

false

none

»»»» type

body

string¦null

false

none

»» roleIds

body

[integer]¦null

false

none

»» columns

body

[string]¦null

false

none

» isVisible

body

boolean

false

none

» id

body

integer(int32)

false

none

» parent

body

integer(int32)¦null

false

none

» oldParent

body

integer(int32)¦null

false

none

» prev

body

integer(int32)¦null

false

none

» oldPrev

body

integer(int32)¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Enumerated Values

Parameter

Value

» type

Rule

» type

Folder

» type

Alert

»»» type

Alert

»»» type

PayeeGroupAdd

»»» type

PayeeGroupRemove

»»» type

WorkflowAddToGroup

»»» type

WorkflowRemoveFromGroup

»»» type

WorkflowEnableAndNotifyGroupForWeb

»»» type

AlertTailoredReportNotEmpty

»»» type

PayeeGroupSetEndDate

»»» type

PayeeGroupAddAsOfToday

»»» type

WorkflowMaintainGroup

»»» type

WorkflowEnableGroupForWebDataEdit

Responses

Status

Meaning

Description

Schema

200

OK

Add a new rule

Varicent.RESTAPI.v1.DTOs.TaskManager.TaskRuleTreeListNodeItemDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/task-manager/rules", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/task-manager/rules");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "resourceId": 0,
  "name": "string",
  "comment": "string",
  "type": "Rule",
  "rule": {
    "id": 0,
    "name": "string",
    "action": {
      "id": 0,
      "type": "Alert",
      "parameters": []
    },
    "roleIds": [
      0
    ],
    "columns": [
      "string"
    ]
  },
  "isVisible": true,
  "id": 0,
  "parent": 0,
  "oldParent": 0,
  "prev": 0,
  "oldPrev": 0,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/task-manager/rules',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/task-manager/rules', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/task-manager/rules',
  params: {
  }, headers: headers

p JSON.parse(result)

Get a rule.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get a rule

Varicent.RESTAPI.v1.DTOs.TaskManager.TaskRuleTreeListNodeItemDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/task-manager/rules/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/task-manager/rules/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/task-manager/rules/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/task-manager/rules/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/task-manager/rules/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "resourceId": 0,
  "name": "string",
  "comment": "string",
  "type": "Rule",
  "rule": {
    "id": 0,
    "name": "string",
    "action": {
      "id": 0,
      "type": "Alert",
      "parameters": []
    },
    "roleIds": [
      0
    ],
    "columns": [
      "string"
    ]
  },
  "isVisible": true,
  "id": 0,
  "parent": 0,
  "oldParent": 0,
  "prev": 0,
  "oldPrev": 0,
  "version": {
    "rowVersion": 0
  }
}
{"resourceId":0,"name":"string","comment":"string","type":"Rule","rule":{"id":0,"name":"string","action":{"id":0,"type":"Alert","parameters":[]},"roleIds":[0],"columns":["string"]},"isVisible":true,"id":0,"parent":0,"oldParent":0,"prev":0,"oldPrev":0,"version":{"rowVersion":0}}

Update an existing rule.

Body parameter

{
  "resourceId": 0,
  "name": "string",
  "comment": "string",
  "type": "Rule",
  "rule": {
    "id": 0,
    "name": "string",
    "action": {
      "id": 0,
      "type": "Alert",
      "parameters": []
    },
    "roleIds": [
      0
    ],
    "columns": [
      "string"
    ]
  },
  "isVisible": true,
  "id": 0,
  "parent": 0,
  "oldParent": 0,
  "prev": 0,
  "oldPrev": 0,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.TaskManager.TaskRuleTreeListNodeItemDTO

false

none

» resourceId

body

integer(int32)¦null

false

none

» name

body

string¦null

false

none

» comment

body

string¦null

false

none

» type

body

string

false

none

» rule

body

Varicent.RESTAPI.v1.DTOs.TaskManager.TaskRuleDTO

false

none

»» id

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» action

body

Varicent.RESTAPI.v1.DTOs.TaskManager.TaskActionDTO

false

none

»»» id

body

integer(int32)

false

none

»»» type

body

string

false

none

»»» parameters

body

[Varicent.RESTAPI.v1.DTOs.TaskManager.ParameterPairDTO]¦null

false

none

»»»» displayText

body

string¦null

false

none

»»»» value

body

string¦null

false

none

»»»» type

body

string¦null

false

none

»» roleIds

body

[integer]¦null

false

none

»» columns

body

[string]¦null

false

none

» isVisible

body

boolean

false

none

» id

body

integer(int32)

false

none

» parent

body

integer(int32)¦null

false

none

» oldParent

body

integer(int32)¦null

false

none

» prev

body

integer(int32)¦null

false

none

» oldPrev

body

integer(int32)¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Enumerated Values

Parameter

Value

» type

Rule

» type

Folder

» type

Alert

»»» type

Alert

»»» type

PayeeGroupAdd

»»» type

PayeeGroupRemove

»»» type

WorkflowAddToGroup

»»» type

WorkflowRemoveFromGroup

»»» type

WorkflowEnableAndNotifyGroupForWeb

»»» type

AlertTailoredReportNotEmpty

»»» type

PayeeGroupSetEndDate

»»» type

PayeeGroupAddAsOfToday

»»» type

WorkflowMaintainGroup

»»» type

WorkflowEnableGroupForWebDataEdit

Responses

Status

Meaning

Description

Schema

200

OK

Update an existing rule

Varicent.RESTAPI.v1.DTOs.TaskManager.TaskRuleTreeListNodeItemDTO

400

Bad Request

Bad Request

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/task-manager/rules/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/task-manager/rules/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "resourceId": 0,
  "name": "string",
  "comment": "string",
  "type": "Rule",
  "rule": {
    "id": 0,
    "name": "string",
    "action": {
      "id": 0,
      "type": "Alert",
      "parameters": []
    },
    "roleIds": [
      0
    ],
    "columns": [
      "string"
    ]
  },
  "isVisible": true,
  "id": 0,
  "parent": 0,
  "oldParent": 0,
  "prev": 0,
  "oldPrev": 0,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/task-manager/rules/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/task-manager/rules/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/task-manager/rules/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

Delete an existing rule.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Delete an existing rule

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/task-manager/rules/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/task-manager/rules/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/task-manager/rules/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/task-manager/rules/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/task-manager/rules/{id}',
  params: {
  }

p JSON.parse(result)

Generate tasks.

Responses

Status

Meaning

Description

Schema

200

OK

Generate tasks

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.TaskManager.TaskDTO]

false

none

none

» id

integer(int32)

false

none

none

» actionType

string

false

none

none

» alertType

string

false

none

none

» parameters

[string]¦null

false

none

none

» createdAt

string(date-time)

false

none

none

» deferred

string(date-time)¦null

false

none

none

» rule

string¦null

false

none

none

» values

[string]¦null

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

Enumerated Values

Property

Value

actionType

Alert

actionType

PayeeGroupAdd

actionType

PayeeGroupRemove

actionType

WorkflowAddToGroup

actionType

WorkflowRemoveFromGroup

actionType

WorkflowEnableAndNotifyGroupForWeb

actionType

AlertTailoredReportNotEmpty

actionType

PayeeGroupSetEndDate

actionType

PayeeGroupAddAsOfToday

actionType

WorkflowMaintainGroup

actionType

WorkflowEnableGroupForWebDataEdit

alertType

Invalid

alertType

PayeeMoreThanOnePlan

alertType

PayeeNotInPlan

alertType

TerminatedPayeeActive

alertType

TailoredReportEmpty

alertType

TerminationBeforeEndDate

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/task-manager/tasks", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/task-manager/tasks");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/task-manager/tasks',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/task-manager/tasks', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/task-manager/tasks',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "actionType": "Alert",
    "alertType": "Invalid",
    "parameters": [
      "string"
    ],
    "createdAt": "2019-08-24T14:15:22Z",
    "deferred": "2019-08-24T14:15:22Z",
    "rule": "string",
    "values": [
      "string"
    ],
    "version": {
      "rowVersion": 0
    }
  }
]
[{"id":0,"actionType":"Alert","alertType":"Invalid","parameters":["string"],"createdAt":"2019-08-24T14:15:22Z","deferred":"2019-08-24T14:15:22Z","rule":"string","values":["string"],"version":{"rowVersion":0}}]

Get all tasks.

Parameters

Name

In

Type

Required

Description

filter

query

string

false

none

offset

query

integer(int32)

false

none

limit

query

integer(int32)

false

none

unique

query

boolean

false

none

fields

query

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Get all tasks

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.TaskManager.TaskDTO]

false

none

none

» id

integer(int32)

false

none

none

» actionType

string

false

none

none

» alertType

string

false

none

none

» parameters

[string]¦null

false

none

none

» createdAt

string(date-time)

false

none

none

» deferred

string(date-time)¦null

false

none

none

» rule

string¦null

false

none

none

» values

[string]¦null

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

Enumerated Values

Property

Value

actionType

Alert

actionType

PayeeGroupAdd

actionType

PayeeGroupRemove

actionType

WorkflowAddToGroup

actionType

WorkflowRemoveFromGroup

actionType

WorkflowEnableAndNotifyGroupForWeb

actionType

AlertTailoredReportNotEmpty

actionType

PayeeGroupSetEndDate

actionType

PayeeGroupAddAsOfToday

actionType

WorkflowMaintainGroup

actionType

WorkflowEnableGroupForWebDataEdit

alertType

Invalid

alertType

PayeeMoreThanOnePlan

alertType

PayeeNotInPlan

alertType

TerminatedPayeeActive

alertType

TailoredReportEmpty

alertType

TerminationBeforeEndDate

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/task-manager/tasks", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/task-manager/tasks");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/task-manager/tasks',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/task-manager/tasks', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/task-manager/tasks',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "actionType": "Alert",
    "alertType": "Invalid",
    "parameters": [
      "string"
    ],
    "createdAt": "2019-08-24T14:15:22Z",
    "deferred": "2019-08-24T14:15:22Z",
    "rule": "string",
    "values": [
      "string"
    ],
    "version": {
      "rowVersion": 0
    }
  }
]
[{"id":0,"actionType":"Alert","alertType":"Invalid","parameters":["string"],"createdAt":"2019-08-24T14:15:22Z","deferred":"2019-08-24T14:15:22Z","rule":"string","values":["string"],"version":{"rowVersion":0}}]

Generate tasks asynchronously.

Responses

Status

Meaning

Description

Schema

200

OK

Generate tasks asynchronously

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/task-manager/tasks/async", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/task-manager/tasks/async");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/task-manager/tasks/async',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/task-manager/tasks/async', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/task-manager/tasks/async',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "property1": "string",
  "property2": "string"
}
{"property1":"string","property2":"string"}

Get all deferred tasks.

Parameters

Name

In

Type

Required

Description

filter

query

string

false

none

offset

query

integer(int32)

false

none

limit

query

integer(int32)

false

none

unique

query

boolean

false

none

fields

query

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Get all deferred tasks

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.TaskManager.TaskDTO]

false

none

none

» id

integer(int32)

false

none

none

» actionType

string

false

none

none

» alertType

string

false

none

none

» parameters

[string]¦null

false

none

none

» createdAt

string(date-time)

false

none

none

» deferred

string(date-time)¦null

false

none

none

» rule

string¦null

false

none

none

» values

[string]¦null

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

Enumerated Values

Property

Value

actionType

Alert

actionType

PayeeGroupAdd

actionType

PayeeGroupRemove

actionType

WorkflowAddToGroup

actionType

WorkflowRemoveFromGroup

actionType

WorkflowEnableAndNotifyGroupForWeb

actionType

AlertTailoredReportNotEmpty

actionType

PayeeGroupSetEndDate

actionType

PayeeGroupAddAsOfToday

actionType

WorkflowMaintainGroup

actionType

WorkflowEnableGroupForWebDataEdit

alertType

Invalid

alertType

PayeeMoreThanOnePlan

alertType

PayeeNotInPlan

alertType

TerminatedPayeeActive

alertType

TailoredReportEmpty

alertType

TerminationBeforeEndDate

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/task-manager/deferredtasks", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/task-manager/deferredtasks");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/task-manager/deferredtasks',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/task-manager/deferredtasks', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/task-manager/deferredtasks',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "actionType": "Alert",
    "alertType": "Invalid",
    "parameters": [
      "string"
    ],
    "createdAt": "2019-08-24T14:15:22Z",
    "deferred": "2019-08-24T14:15:22Z",
    "rule": "string",
    "values": [
      "string"
    ],
    "version": {
      "rowVersion": 0
    }
  }
]
[{"id":0,"actionType":"Alert","alertType":"Invalid","parameters":["string"],"createdAt":"2019-08-24T14:15:22Z","deferred":"2019-08-24T14:15:22Z","rule":"string","values":["string"],"version":{"rowVersion":0}}]

Run a task.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Run a task

Varicent.RESTAPI.v1.DTOs.Exceptions.ErrorListDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/task-manager/tasks/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/task-manager/tasks/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/task-manager/tasks/{id}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/task-manager/tasks/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/task-manager/tasks/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "errors": 0,
  "warnings": 0,
  "messages": [
    "string"
  ]
}
{"errors":0,"warnings":0,"messages":["string"]}

Defer or un-defer a task.

Body parameter

null

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

any

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Defer or un-defer a task

Varicent.RESTAPI.v1.DTOs.TaskManager.TaskDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/task-manager/tasks/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/task-manager/tasks/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/task-manager/tasks/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/task-manager/tasks/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/task-manager/tasks/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "actionType": "Alert",
  "alertType": "Invalid",
  "parameters": [
    "string"
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "deferred": "2019-08-24T14:15:22Z",
  "rule": "string",
  "values": [
    "string"
  ],
  "version": {
    "rowVersion": 0
  }
}
{"id":0,"actionType":"Alert","alertType":"Invalid","parameters":["string"],"createdAt":"2019-08-24T14:15:22Z","deferred":"2019-08-24T14:15:22Z","rule":"string","values":["string"],"version":{"rowVersion":0}}

Dismiss a task.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Dismiss a task

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/task-manager/tasks/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/task-manager/tasks/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/task-manager/tasks/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/task-manager/tasks/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/task-manager/tasks/{id}',
  params: {
  }

p JSON.parse(result)

Get all alerts.

Responses

Status

Meaning

Description

Schema

200

OK

Get all alerts

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.TaskManager.TaskAlertTreeListNodeItemDTO]

false

none

none

» resourceId

integer(int32)¦null

false

none

none

» name

string¦null

false

none

none

» enabled

boolean

false

none

none

» query

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

»» selectItems

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

none

»»» alias

string¦null

false

none

none

»»» column

string¦null

false

none

none

»»» table

string¦null

false

none

none

»»» customSelect

string¦null

false

none

none

»»» dataType

string

false

none

none

»»» type

string

false

none

none

»»» value

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»» expressionType

string

false

none

none

»»»» cases

array¦null

false

none

none

»»»»» anonymous

any

false

none

none

»»»» table

string¦null

false

none

none

»»»» column

string¦null

false

none

none

»»»» op

string¦null

false

none

none

»»»» arguments

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

none

[DTO version of IExpression]

»»»»» expressionType

string

false

none

none

»»»»» cases

array¦null

false

none

none

»»»»»» anonymous

any

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» column

string¦null

false

none

none

»»»»» op

string¦null

false

none

none

»»»»» arguments

array¦null

false

none

none

»»»»»» anonymous

any

false

none

none

»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»» constraintType

string

false

none

none

»»»»»» op

string¦null

false

none

none

»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»» expressionType

string

false

none

none

»»»»»»» cases

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» column

string¦null

false

none

none

»»»»»»» op

string¦null

false

none

none

»»»»»»» arguments

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»»» condition

any

false

none

none

»»»»»»» trueValue

any

false

none

none

»»»»»»» falseValue

any

false

none

none

»»»»»»» isDate

boolean

false

none

none

»»»»»»» literalType

string

false

none

none

»»»»»»» value

any

false

none

none

»»»»»» caseSensitive

boolean

false

none

none

»»»»»» constraints

array¦null

false

none

none

»»»»»»» anonymous

any

false

none

none

»»»»»» literalRight

any

false

none

none

»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»» right

any

false

none

none

»»»»»» expressionLeft

any

false

none

none

»»»»»» expressionRight

any

false

none

none

»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»» like

string¦null

false

none

none

»»»»»» escapeWildcards

boolean

false

none

none

»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»» rowVersion

integer(int64)

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» queryDefinitionRight

any

false

none

none

»»»»» trueValue

any

false

none

none

»»»»» falseValue

any

false

none

none

»»»»» isDate

boolean

false

none

none

»»»»» literalType

string

false

none

none

»»»»» value

any

false

none

none

»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»» trueValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»» falseValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»» isDate

boolean

false

none

none

»»»» literalType

string

false

none

none

»»»» value

any

false

none

none

»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»» namespaceTable

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

none

»»»» m_namespace

string¦null

false

none

none

»»»» name

string¦null

false

none

none

»»» query

any

false

none

none

»»» alias

string¦null

false

none

none

»»» sourceType

string

false

none

none

»» joins

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

none

»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»» joinType

string

false

none

none

»»» onClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»» constraintType

string

false

none

none

»»»» op

string¦null

false

none

none

»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»» caseSensitive

boolean

false

none

none

»»»» constraints

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

none

[DTO version of IConstraint]

»»»» literalRight

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»» right

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»» expressionLeft

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»» expressionRight

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»» isPreciseDecimal

boolean

false

none

none

»»»» like

string¦null

false

none

none

»»»» escapeWildcards

boolean

false

none

none

»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»» table

string¦null

false

none

none

»»»» queryDefinitionRight

any

false

none

none

»» whereClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»» order

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

none

»»» table

string¦null

false

none

none

»»» column

string¦null

false

none

none

»»» direction

string

false

none

none

»» group

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

none

»»» table

string¦null

false

none

none

»»» column

string¦null

false

none

none

»» havingClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»» distinct

boolean

false

none

none

»» unionWith

any

false

none

none

»» exceptWith

any

false

none

none

» id

integer(int32)

false

none

none

» parent

integer(int32)¦null

false

none

none

» oldParent

integer(int32)¦null

false

none

none

» prev

integer(int32)¦null

false

none

none

» oldPrev

integer(int32)¦null

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

dataType

Int

dataType

Decimal

dataType

DateTime

dataType

None

dataType

String

type

SelectAll

type

SelectItem

type

SelectLiteral

type

SelectCustom

type

SelectExpression

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

sourceType

Table

sourceType

Query

joinType

Inner

joinType

Left

joinType

Right

joinType

Cross

joinType

CrossApply

joinType

OuterApply

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

direction

Ascending

direction

Descending

direction

AscendingNullsFirst

direction

DescendingNullsLast

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/task-manager/alerts", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/task-manager/alerts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/task-manager/alerts',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/task-manager/alerts', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/task-manager/alerts',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "resourceId": 0,
    "name": "string",
    "enabled": true,
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "id": 0,
    "parent": 0,
    "oldParent": 0,
    "prev": 0,
    "oldPrev": 0,
    "version": {
      "rowVersion": 0
    }
  }
]
[{"resourceId":0,"name":"string","enabled":true,"query":{"selectItems":[],"source":{},"joins":[],"whereClause":{},"order":[],"group":[],"havingClause":{},"distinct":true,"unionWith":null,"exceptWith":null},"id":0,"parent":0,"oldParent":0,"prev":0,"oldPrev":0,"version":{"rowVersion":0}}]

Enable or disable an alert.

Body parameter

null

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

any

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Enable or disable an alert

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/task-manager/alerts/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/task-manager/alerts/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = 'null';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/task-manager/alerts/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/task-manager/alerts/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/task-manager/alerts/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

Get all rule IDs and names.

Responses

Status

Meaning

Description

Schema

200

OK

Get all rules

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/task-manager/email/rules", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/task-manager/email/rules");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/task-manager/email/rules',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/task-manager/email/rules', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/task-manager/email/rules',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "property1": "string",
  "property2": "string"
}
{"property1":"string","property2":"string"}

Get all rules for a role.

Parameters

Name

In

Type

Required

Description

roleId

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get all rules for a role

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.TaskManager.TaskRuleDTO]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» action

Varicent.RESTAPI.v1.DTOs.TaskManager.TaskActionDTO

false

none

none

»» id

integer(int32)

false

none

none

»» type

string

false

none

none

»» parameters

[Varicent.RESTAPI.v1.DTOs.TaskManager.ParameterPairDTO]¦null

false

none

none

»»» displayText

string¦null

false

none

none

»»» value

string¦null

false

none

none

»»» type

string¦null

false

none

none

» roleIds

[integer]¦null

false

none

none

» columns

[string]¦null

false

none

none

Enumerated Values

Property

Value

type

Alert

type

PayeeGroupAdd

type

PayeeGroupRemove

type

WorkflowAddToGroup

type

WorkflowRemoveFromGroup

type

WorkflowEnableAndNotifyGroupForWeb

type

AlertTailoredReportNotEmpty

type

PayeeGroupSetEndDate

type

PayeeGroupAddAsOfToday

type

WorkflowMaintainGroup

type

WorkflowEnableGroupForWebDataEdit

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/task-manager/email/{roleId}/rules", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/task-manager/email/{roleId}/rules");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/task-manager/email/{roleId}/rules',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/task-manager/email/{roleId}/rules', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/task-manager/email/{roleId}/rules',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "name": "string",
    "action": {
      "id": 0,
      "type": "Alert",
      "parameters": []
    },
    "roleIds": [
      0
    ],
    "columns": [
      "string"
    ]
  }
]
[{"id":0,"name":"string","action":{"id":0,"type":"Alert","parameters":[]},"roleIds":[0],"columns":["string"]}]

Select rules for a role.

Body parameter

null

Parameters

Name

In

Type

Required

Description

roleId

path

integer(int32)

true

none

body

body

any

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Select rules for a role

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.TaskManager.TaskRuleDTO]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» action

Varicent.RESTAPI.v1.DTOs.TaskManager.TaskActionDTO

false

none

none

»» id

integer(int32)

false

none

none

»» type

string

false

none

none

»» parameters

[Varicent.RESTAPI.v1.DTOs.TaskManager.ParameterPairDTO]¦null

false

none

none

»»» displayText

string¦null

false

none

none

»»» value

string¦null

false

none

none

»»» type

string¦null

false

none

none

» roleIds

[integer]¦null

false

none

none

» columns

[string]¦null

false

none

none

Enumerated Values

Property

Value

type

Alert

type

PayeeGroupAdd

type

PayeeGroupRemove

type

WorkflowAddToGroup

type

WorkflowRemoveFromGroup

type

WorkflowEnableAndNotifyGroupForWeb

type

AlertTailoredReportNotEmpty

type

PayeeGroupSetEndDate

type

PayeeGroupAddAsOfToday

type

WorkflowMaintainGroup

type

WorkflowEnableGroupForWebDataEdit

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/task-manager/email/{roleId}/rules", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/task-manager/email/{roleId}/rules");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/task-manager/email/{roleId}/rules',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/task-manager/email/{roleId}/rules', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/task-manager/email/{roleId}/rules',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "name": "string",
    "action": {
      "id": 0,
      "type": "Alert",
      "parameters": []
    },
    "roleIds": [
      0
    ],
    "columns": [
      "string"
    ]
  }
]
[{"id":0,"name":"string","action":{"id":0,"type":"Alert","parameters":[]},"roleIds":[0],"columns":["string"]}]

Pulse

Get the chart data for the main overview page.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get the data for the main chart on the overview page

Varicent.RESTAPI.v1.DTOs.ResultSetDTO

404

Not Found

No data for selected plan.

None

409

Conflict

Plan with given ID does not exist.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/pulseplans/overview/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/pulseplans/overview/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/pulseplans/overview/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/pulseplans/overview/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/pulseplans/overview/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "columnDefinitions": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "data": [
    null
  ],
  "columnSourceMap": {
    "property1": "string",
    "property2": "string"
  },
  "isDataSynced": true,
  "hierarchyMetadata": {
    "tableName": "string",
    "idColumnName": "string",
    "parentColumnName": "string"
  }
}
{"columnDefinitions":[{"name":"string","type":"String","isKey":true,"nullable":true,"values":"string","lockedPeriod":{},"referencedCol":"string","picklistFilter":"string","displayName":"string","isELTPeriod":true}],"data":[null],"columnSourceMap":{"property1":"string","property2":"string"},"isDataSynced":true,"hierarchyMetadata":{"tableName":"string","idColumnName":"string","parentColumnName":"string"}}

Get the chart data for the payee versus the performance chart.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get the data for the payee vs. performance chart

Varicent.RESTAPI.v1.DTOs.ResultSetDTO

404

Not Found

No data for selected plan.

None

409

Conflict

Plan with given ID does not exist.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/pulseplans/payeeperformance/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/pulseplans/payeeperformance/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/pulseplans/payeeperformance/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/pulseplans/payeeperformance/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/pulseplans/payeeperformance/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "columnDefinitions": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "data": [
    null
  ],
  "columnSourceMap": {
    "property1": "string",
    "property2": "string"
  },
  "isDataSynced": true,
  "hierarchyMetadata": {
    "tableName": "string",
    "idColumnName": "string",
    "parentColumnName": "string"
  }
}
{"columnDefinitions":[{"name":"string","type":"String","isKey":true,"nullable":true,"values":"string","lockedPeriod":{},"referencedCol":"string","picklistFilter":"string","displayName":"string","isELTPeriod":true}],"data":[null],"columnSourceMap":{"property1":"string","property2":"string"},"isDataSynced":true,"hierarchyMetadata":{"tableName":"string","idColumnName":"string","parentColumnName":"string"}}

Get the chart data for the performance against OTE chart.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get the data for the performance vs. OTE chart

Inline

404

Not Found

No data for selected plan.

None

409

Conflict

Plan with given ID does not exist.

None

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.ResultSetDTO]

false

none

none

» columnDefinitions

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

none

»» name

string¦null

false

none

none

»» type

string

false

none

none

»» isKey

boolean

false

none

none

»» nullable

boolean

false

none

none

»» values

string¦null

false

none

none

»» lockedPeriod

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

none

»»» start

string(date-time)

false

none

none

»»» end

string(date-time)

false

none

none

»» referencedCol

string¦null

false

none

none

»» picklistFilter

string¦null

false

none

none

»» displayName

string¦null

false

none

none

»» isELTPeriod

boolean¦null

false

none

none

» data

[any]¦null

false

none

none

» columnSourceMap

object¦null

false

none

none

»» additionalProperties

string¦null

false

none

none

» isDataSynced

boolean¦null

false

none

none

» hierarchyMetadata

RESTAPI.v1.DTOs.Hierarchy.HierarchyMetadataDTO

false

none

none

»» tableName

string¦null

false

none

none

»» idColumnName

string¦null

false

none

none

»» parentColumnName

string¦null

false

none

none

Enumerated Values

Property

Value

type

String

type

LongString

type

MaxString

type

Date

type

DateTime

type

Decimal

type

Int

type

Long

type

Float

type

BLOB

type

Identity

type

CLOB

type

RowVersion

type

UID

type

VarCharMax

type

Boolean

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/pulseplans/performanceote/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/pulseplans/performanceote/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/pulseplans/performanceote/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/pulseplans/performanceote/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/pulseplans/performanceote/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "columnDefinitions": [
      {}
    ],
    "data": [
      null
    ],
    "columnSourceMap": {
      "property1": "string",
      "property2": "string"
    },
    "isDataSynced": true,
    "hierarchyMetadata": {
      "tableName": "string",
      "idColumnName": "string",
      "parentColumnName": "string"
    }
  }
]
[{"columnDefinitions":[{}],"data":[null],"columnSourceMap":{"property1":"string","property2":"string"},"isDataSynced":true,"hierarchyMetadata":{"tableName":"string","idColumnName":"string","parentColumnName":"string"}}]

Get all metrics for the pulse plan.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get all metrics for the pulse plan

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.Pulse.PulseMetricDTO]

false

none

none

» planId

integer(int32)

false

none

none

» metricType

string

false

none

none

» value

any

false

none

none

Enumerated Values

Property

Value

metricType

PayeeNumberOf

metricType

PayeeExceedQuota

metricType

PayeeWithTransactions

metricType

OperationalDaysToPayday

metricType

PayPeriodStartDate

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/pulseplans/{id}/metrics", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/pulseplans/{id}/metrics");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/pulseplans/{id}/metrics',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/pulseplans/{id}/metrics', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/pulseplans/{id}/metrics',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "planId": 0,
    "metricType": "PayeeNumberOf",
    "value": null
  }
]
[{"planId":0,"metricType":"PayeeNumberOf","value":null}]

Get a metric for the pulse plan.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

metric

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get a metric for the pulse plan

RESTAPI.v1.DTOs.Pulse.PulseMetricDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/pulseplans/{id}/metrics/{metric}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/pulseplans/{id}/metrics/{metric}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/pulseplans/{id}/metrics/{metric}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/pulseplans/{id}/metrics/{metric}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/pulseplans/{id}/metrics/{metric}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "planId": 0,
  "metricType": "PayeeNumberOf",
  "value": null
}
{"planId":0,"metricType":"PayeeNumberOf","value":null}

PulseChartsControllerV1_GetDefaultParameters

Parameters

Name

In

Type

Required

Description

reportType

path

string

true

none

Enumerated Values

Parameter

Value

reportType

Undefined

reportType

TransactionsProductionsResults

reportType

CompensationSummary

reportType

PerformanceReport

reportType

SalesManagerOverview

reportType

Overview

reportType

PayeePerformanceReport

reportType

PerformanceOTE

reportType

SalesVsAttainment

reportType

PerformanceDistribution

reportType

PerformanceDistributionByRole

reportType

PayDistribution

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.Pulse.ReportDefaultParametersDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/pulseplans/{reportType}/defaults", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/pulseplans/{reportType}/defaults");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/pulseplans/{reportType}/defaults',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/pulseplans/{reportType}/defaults', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/pulseplans/{reportType}/defaults',
  params: {
  }, headers: headers

p JSON.parse(result)

PulseChartsControllerV1_PutDefaultParameters

Body parameter

{
  "columnMappings": {
    "property1": "string",
    "property2": "string"
  },
  "columnOptions": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "reportType": "Undefined"
}

Parameters

Name

In

Type

Required

Description

reportType

path

string

true

none

body

body

RESTAPI.v1.DTOs.Pulse.ReportDefaultParametersDTO

false

none

» columnMappings

body

object¦null

false

none

»» additionalProperties

body

string

false

none

» columnOptions

body

object¦null

false

none

»» additionalProperties

body

[string]

false

none

» reportType

body

string

false

none

Enumerated Values

Parameter

Value

reportType

Undefined

reportType

TransactionsProductionsResults

reportType

CompensationSummary

reportType

PerformanceReport

reportType

SalesManagerOverview

reportType

Overview

reportType

PayeePerformanceReport

reportType

PerformanceOTE

reportType

SalesVsAttainment

reportType

PerformanceDistribution

reportType

PerformanceDistributionByRole

reportType

PayDistribution

» reportType

Undefined

» reportType

TransactionsProductionsResults

» reportType

CompensationSummary

» reportType

PerformanceReport

» reportType

SalesManagerOverview

» reportType

Overview

» reportType

PayeePerformanceReport

» reportType

PerformanceOTE

» reportType

SalesVsAttainment

» reportType

PerformanceDistribution

» reportType

PerformanceDistributionByRole

» reportType

PayDistribution

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/pulseplans/{reportType}/defaults", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/pulseplans/{reportType}/defaults");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "columnMappings": {
    "property1": "string",
    "property2": "string"
  },
  "columnOptions": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "reportType": "Undefined"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/pulseplans/{reportType}/defaults',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/pulseplans/{reportType}/defaults', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/pulseplans/{reportType}/defaults',
  params: {
  }, headers: headers

p JSON.parse(result)

PulseChartsControllerV1_GetReportsWithMappings

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/pulseplans/{id}/hasMappings", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/pulseplans/{id}/hasMappings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/pulseplans/{id}/hasMappings',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/pulseplans/{id}/hasMappings', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/pulseplans/{id}/hasMappings',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  0
]
[0]

Get all pulse plans.

Parameters

Name

In

Type

Required

Description

orderBy

query

string

false

####Description

Detailed descriptions

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

name

Responses

Status

Meaning

Description

Schema

200

OK

Get all Pulse plans

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.Pulse.PulsePlanDTO]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» description

string¦null

false

none

none

» highlightColor

string¦null

false

none

none

» creationDate

string(date-time)

false

none

none

» workflowObjectId

integer(int32)

false

none

none

» settings

RESTAPI.v1.DTOs.Pulse.PulsePlanSettingsDTO

false

none

none

»» id

integer(int32)

false

none

none

»» planId

integer(int32)

false

none

none

»» calendarId

string¦null

false

none

none

»» calendarLevel

string¦null

false

none

none

»» calendarStartDate

string(date-time)¦null

false

none

none

»» calendarEndDate

string(date-time)¦null

false

none

none

»» payDayExampleDate

string(date-time)

false

none

none

»» payDayFrequencyType

integer(int32)

false

none

none

»» payDayPrimaryValue

integer(int32)

false

none

none

»» payDaySecondaryValue

integer(int32)

false

none

none

»» payDayCountFromEndOfMonth

boolean

false

none

none

»» workflowGroupId

integer(int32)¦null

false

none

none

»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»» rowVersion

integer(int64)

false

none

none

» tagged

[RESTAPI.v1.DTOs.Pulse.TaggedDTO]¦null

false

none

none

»» id

integer(int32)

false

none

none

»» planId

integer(int32)

false

none

none

»» tagType

integer(int32)

false

none

none

»» taggedTo

string¦null

false

none

none

»» mappings

[RESTAPI.v1.DTOs.Pulse.TagMappingDTO]¦null

false

none

none

»»» tagColumn

integer(int32)

false

none

none

»»» taggedToTable

string¦null

false

none

none

»»» taggedToColumn

string¦null

false

none

none

»» restrictions

Varicent.RESTAPI.v1.DTOs.QuerySourceDefinitionDTO

false

none

none

»»» name

string¦null

false

none

none

»»» sourceDefinition

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

»»»» query

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

»»»»» selectItems

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

none

»»»»»» alias

string¦null

false

none

none

»»»»»» column

string¦null

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» customSelect

string¦null

false

none

none

»»»»»» dataType

string

false

none

none

»»»»»» type

string

false

none

none

»»»»»» value

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»»»» expressionType

string

false

none

none

»»»»»»» cases

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» column

string¦null

false

none

none

»»»»»»» op

string¦null

false

none

none

»»»»»»» arguments

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

none

[DTO version of IExpression]

»»»»»»»» expressionType

string

false

none

none

»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» table

string¦null

false

none

none

»»»»»»»» column

string¦null

false

none

none

»»»»»»»» op

string¦null

false

none

none

»»»»»»»» arguments

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»»»»» constraintType

string

false

none

none

»»»»»»»»» op

string¦null

false

none

none

»»»»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»»»» expressionType

string

false

none

none

»»»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»»» table

string¦null

false

none

none

»»»»»»»»»» column

string¦null

false

none

none

»»»»»»»»»» op

string¦null

false

none

none

»»»»»»»»»» arguments

array¦null

false

none

none

»»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»»» condition

any

false

none

none

»»»»»»»»»» trueValue

any

false

none

none

»»»»»»»»»» falseValue

any

false

none

none

»»»»»»»»»» isDate

boolean

false

none

none

»»»»»»»»»» literalType

string

false

none

none

»»»»»»»»»» value

any

false

none

none

»»»»»»»»» caseSensitive

boolean

false

none

none

»»»»»»»»» constraints

array¦null

false

none

none

»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»» literalRight

any

false

none

none

»»»»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»»» right

any

false

none

none

»»»»»»»»» expressionLeft

any

false

none

none

»»»»»»»»» expressionRight

any

false

none

none

»»»»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»»»»» like

string¦null

false

none

none

»»»»»»»»» escapeWildcards

boolean

false

none

none

»»»»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»»»» table

string¦null

false

none

none

»»»»»»»»» queryDefinitionRight

any

false

none

none

»»»»»»»» trueValue

any

false

none

none

»»»»»»»» falseValue

any

false

none

none

»»»»»»»» isDate

boolean

false

none

none

»»»»»»»» literalType

string

false

none

none

»»»»»»»» value

any

false

none

none

»»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»»» trueValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»» falseValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»» isDate

boolean

false

none

none

»»»»»»» literalType

string

false

none

none

»»»»»»» value

any

false

none

none

»»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»»»» namespaceTable

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

none

»»»»»»» m_namespace

string¦null

false

none

none

»»»»»»» name

string¦null

false

none

none

»»»»»» query

any

false

none

none

»»»»»» alias

string¦null

false

none

none

»»»»»» sourceType

string

false

none

none

»»»»» joins

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

none

»»»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»»»» joinType

string

false

none

none

»»»»»» onClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»»»» constraintType

string

false

none

none

»»»»»»» op

string¦null

false

none

none

»»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»» caseSensitive

boolean

false

none

none

»»»»»»» constraints

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

none

[DTO version of IConstraint]

»»»»»»» literalRight

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»» right

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»» expressionLeft

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»» expressionRight

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»»» like

string¦null

false

none

none

»»»»»»» escapeWildcards

boolean

false

none

none

»»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» queryDefinitionRight

any

false

none

none

»»»»» whereClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»» order

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» column

string¦null

false

none

none

»»»»»» direction

string

false

none

none

»»»»» group

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» column

string¦null

false

none

none

»»»»» havingClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»» distinct

boolean

false

none

none

»»»»» unionWith

any

false

none

none

»»»»» exceptWith

any

false

none

none

»»»» sourceNames

object¦null

false

none

none

»»»»» additionalProperties

string¦null

false

none

none

»»» dependencies

[string]¦null

false

none

none

»»» columns

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

none

»»»» name

string¦null

false

none

none

»»»» type

string

false

none

none

»»»» isKey

boolean

false

none

none

»»»» nullable

boolean

false

none

none

»»»» values

string¦null

false

none

none

»»»» lockedPeriod

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

none

»»»»» start

string(date-time)

false

none

none

»»»»» end

string(date-time)

false

none

none

»»»» referencedCol

string¦null

false

none

none

»»»» picklistFilter

string¦null

false

none

none

»»»» displayName

string¦null

false

none

none

»»»» isELTPeriod

boolean¦null

false

none

none

»»» references

object¦null

false

none

none

»»»» additionalProperties

string

false

none

none

»»» timeReferences

object¦null

false

none

none

»»»» additionalProperties

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

none

»»»»» levelId

string¦null

false

none

none

»»»»» timeId

string¦null

false

none

none

»» valid

boolean

false

none

none

»» validationItems

[RESTAPI.v1.DTOs.Pulse.CompPlanValidationItemDTO]¦null

false

none

none

»»» level

integer(int32)

false

none

none

»»» code

integer(int32)

false

none

none

»»» affectedColumn

RESTAPI.v1.DTOs.Pulse.TagColumnDTO

false

none

none

»»»» displayName

string¦null

false

none

none

»»»» value

integer(int32)

false

none

none

»»»» allowedTypes

[string]¦null

false

none

none

»»» affectedTagType

integer(int32)

false

none

none

»» displayName

string¦null

false

none

none

»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

dataType

Int

dataType

Decimal

dataType

DateTime

dataType

None

dataType

String

type

SelectAll

type

SelectItem

type

SelectLiteral

type

SelectCustom

type

SelectExpression

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

sourceType

Table

sourceType

Query

joinType

Inner

joinType

Left

joinType

Right

joinType

Cross

joinType

CrossApply

joinType

OuterApply

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

direction

Ascending

direction

Descending

direction

AscendingNullsFirst

direction

DescendingNullsLast

type

String

type

LongString

type

MaxString

type

Date

type

DateTime

type

Decimal

type

Int

type

Long

type

Float

type

BLOB

type

Identity

type

CLOB

type

RowVersion

type

UID

type

VarCharMax

type

Boolean

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/pulseplans", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/pulseplans");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/pulseplans',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/pulseplans', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/pulseplans',
  params: {
  }, headers: headers

p JSON.parse(result)

Create a pulse plan.

Body parameter

{
  "id": 0,
  "name": "string",
  "description": "string",
  "highlightColor": "string",
  "creationDate": "2019-08-24T14:15:22Z",
  "workflowObjectId": 0,
  "settings": {
    "id": 0,
    "planId": 0,
    "calendarId": "string",
    "calendarLevel": "string",
    "calendarStartDate": "2019-08-24T14:15:22Z",
    "calendarEndDate": "2019-08-24T14:15:22Z",
    "payDayExampleDate": "2019-08-24T14:15:22Z",
    "payDayFrequencyType": 0,
    "payDayPrimaryValue": 0,
    "payDaySecondaryValue": 0,
    "payDayCountFromEndOfMonth": true,
    "workflowGroupId": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "tagged": [
    {
      "id": 0,
      "planId": 0,
      "tagType": 0,
      "taggedTo": "string",
      "mappings": [],
      "restrictions": {},
      "valid": true,
      "validationItems": [],
      "displayName": "string",
      "version": {}
    }
  ],
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Pulse.PulsePlanDTO

false

none

» id

body

integer(int32)

false

none

» name

body

string¦null

false

none

» description

body

string¦null

false

none

» highlightColor

body

string¦null

false

none

» creationDate

body

string(date-time)

false

none

» workflowObjectId

body

integer(int32)

false

none

» settings

body

RESTAPI.v1.DTOs.Pulse.PulsePlanSettingsDTO

false

none

»» id

body

integer(int32)

false

none

»» planId

body

integer(int32)

false

none

»» calendarId

body

string¦null

false

none

»» calendarLevel

body

string¦null

false

none

»» calendarStartDate

body

string(date-time)¦null

false

none

»» calendarEndDate

body

string(date-time)¦null

false

none

»» payDayExampleDate

body

string(date-time)

false

none

»» payDayFrequencyType

body

integer(int32)

false

none

»» payDayPrimaryValue

body

integer(int32)

false

none

»» payDaySecondaryValue

body

integer(int32)

false

none

»» payDayCountFromEndOfMonth

body

boolean

false

none

»» workflowGroupId

body

integer(int32)¦null

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» rowVersion

body

integer(int64)

false

none

» tagged

body

[RESTAPI.v1.DTOs.Pulse.TaggedDTO]¦null

false

none

»» id

body

integer(int32)

false

none

»» planId

body

integer(int32)

false

none

»» tagType

body

integer(int32)

false

none

»» taggedTo

body

string¦null

false

none

»» mappings

body

[RESTAPI.v1.DTOs.Pulse.TagMappingDTO]¦null

false

none

»»» tagColumn

body

integer(int32)

false

none

»»» taggedToTable

body

string¦null

false

none

»»» taggedToColumn

body

string¦null

false

none

»» restrictions

body

Varicent.RESTAPI.v1.DTOs.QuerySourceDefinitionDTO

false

none

»»» name

body

string¦null

false

none

»»» sourceDefinition

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»»»» alias

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» customSelect

body

string¦null

false

none

»»»»»» dataType

body

string

false

none

»»»»»» type

body

string

false

none

»»»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»» expressionType

body

string

false

none

»»»»»»» cases

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»»» constraintType

body

string

false

none

»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»» condition

body

any

false

none

»»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»»» literalType

body

string

false

none

»»»»»»»»»» value

body

any

false

none

»»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»»» constraints

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»» literalRight

body

any

false

none

»»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»» right

body

any

false

none

»»»»»»»»» expressionLeft

body

any

false

none

»»»»»»»»» expressionRight

body

any

false

none

»»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»»» like

body

string¦null

false

none

»»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»»»» trueValue

body

any

false

none

»»»»»»»» falseValue

body

any

false

none

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» isDate

body

boolean

false

none

»»»»»»» literalType

body

string

false

none

»»»»»»» value

body

any

false

none

»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»»»» m_namespace

body

string¦null

false

none

»»»»»»» name

body

string¦null

false

none

»»»»»» query

body

any

false

none

»»»»»» alias

body

string¦null

false

none

»»»»»» sourceType

body

string

false

none

»»»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»» joinType

body

string

false

none

»»»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»»» constraintType

body

string

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»» like

body

string¦null

false

none

»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» queryDefinitionRight

body

any

false

none

»»»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» direction

body

string

false

none

»»»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» distinct

body

boolean

false

none

»»»»» unionWith

body

any

false

none

»»»»» exceptWith

body

any

false

none

»»»» sourceNames

body

object¦null

false

none

»»»»» additionalProperties

body

string¦null

false

none

»»» dependencies

body

[string]¦null

false

none

»»» columns

body

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

»»»» name

body

string¦null

false

none

»»»» type

body

string

false

none

»»»» isKey

body

boolean

false

none

»»»» nullable

body

boolean

false

none

»»»» values

body

string¦null

false

none

»»»» lockedPeriod

body

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

»»»»» start

body

string(date-time)

false

none

»»»»» end

body

string(date-time)

false

none

»»»» referencedCol

body

string¦null

false

none

»»»» picklistFilter

body

string¦null

false

none

»»»» displayName

body

string¦null

false

none

»»»» isELTPeriod

body

boolean¦null

false

none

»»» references

body

object¦null

false

none

»»»» additionalProperties

body

string

false

none

»»» timeReferences

body

object¦null

false

none

»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»»»» levelId

body

string¦null

false

none

»»»»» timeId

body

string¦null

false

none

»» valid

body

boolean

false

none

»» validationItems

body

[RESTAPI.v1.DTOs.Pulse.CompPlanValidationItemDTO]¦null

false

none

»»» level

body

integer(int32)

false

none

»»» code

body

integer(int32)

false

none

»»» affectedColumn

body

RESTAPI.v1.DTOs.Pulse.TagColumnDTO

false

none

»»»» displayName

body

string¦null

false

none

»»»» value

body

integer(int32)

false

none

»»»» allowedTypes

body

[string]¦null

false

none

»»» affectedTagType

body

integer(int32)

false

none

»» displayName

body

string¦null

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

»»»»»» dataType

Int

»»»»»» dataType

Decimal

»»»»»» dataType

DateTime

»»»»»» dataType

None

»»»»»» dataType

String

»»»»»» type

SelectAll

»»»»»» type

SelectItem

»»»»»» type

SelectLiteral

»»»»»» type

SelectCustom

»»»»»» type

SelectExpression

»»»»»»» expressionType

caseExpression

»»»»»»» expressionType

dataField

»»»»»»» expressionType

function

»»»»»»» expressionType

ifExpression

»»»»»»» expressionType

literal

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»»» constraintType

clause

»»»»»»»»» constraintType

constraint

»»»»»»»»» constraintType

expressionConstraint

»»»»»»»»» constraintType

likeConstraint

»»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»»» constraintType

subQueryConstraint

»»»»»»»»»» expressionType

caseExpression

»»»»»»»»»» expressionType

dataField

»»»»»»»»»» expressionType

function

»»»»»»»»»» expressionType

ifExpression

»»»»»»»»»» expressionType

literal

»»»»»»»»»» literalType

Integer

»»»»»»»»»» literalType

Decimal

»»»»»»»»»» literalType

Date

»»»»»»»»»» literalType

DateTime

»»»»»»»»»» literalType

String

»»»»»»»»»» literalType

Float

»»»»»»»»»» literalType

Long

»»»»»»»»»» literalType

Null

»»»»»»»»»» literalType

Parameter

»»»»»»»»»» literalType

Guid

»»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»»» literalType

Boolean

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»»» literalType

Integer

»»»»»»» literalType

Decimal

»»»»»»» literalType

Date

»»»»»»» literalType

DateTime

»»»»»»» literalType

String

»»»»»»» literalType

Float

»»»»»»» literalType

Long

»»»»»»» literalType

Null

»»»»»»» literalType

Parameter

»»»»»»» literalType

Guid

»»»»»»» literalType

SystemUtcTime

»»»»»»» literalType

Boolean

»»»»»» sourceType

Table

»»»»»» sourceType

Query

»»»»»» joinType

Inner

»»»»»» joinType

Left

»»»»»» joinType

Right

»»»»»» joinType

Cross

»»»»»» joinType

CrossApply

»»»»»» joinType

OuterApply

»»»»»»» constraintType

clause

»»»»»»» constraintType

constraint

»»»»»»» constraintType

expressionConstraint

»»»»»»» constraintType

likeConstraint

»»»»»»» constraintType

rowVersionConstraint

»»»»»»» constraintType

subQueryConstraint

»»»»»» direction

Ascending

»»»»»» direction

Descending

»»»»»» direction

AscendingNullsFirst

»»»»»» direction

DescendingNullsLast

»»»» type

String

»»»» type

LongString

»»»» type

MaxString

»»»» type

Date

»»»» type

DateTime

»»»» type

Decimal

»»»» type

Int

»»»» type

Long

»»»» type

Float

»»»» type

BLOB

»»»» type

Identity

»»»» type

CLOB

»»»» type

RowVersion

»»»» type

UID

»»»» type

VarCharMax

»»»» type

Boolean

»»»» allowedTypes

String

»»»» allowedTypes

LongString

»»»» allowedTypes

MaxString

»»»» allowedTypes

Date

»»»» allowedTypes

DateTime

»»»» allowedTypes

Decimal

»»»» allowedTypes

Int

»»»» allowedTypes

Long

»»»» allowedTypes

Float

»»»» allowedTypes

BLOB

»»»» allowedTypes

Identity

»»»» allowedTypes

CLOB

»»»» allowedTypes

RowVersion

»»»» allowedTypes

UID

»»»» allowedTypes

VarCharMax

»»»» allowedTypes

Boolean

Responses

Status

Meaning

Description

Schema

201

Created

Add a Pulse plan.

RESTAPI.v1.DTOs.Pulse.PulsePlanDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/pulseplans", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/pulseplans");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "name": "string",
  "description": "string",
  "highlightColor": "string",
  "creationDate": "2019-08-24T14:15:22Z",
  "workflowObjectId": 0,
  "settings": {
    "id": 0,
    "planId": 0,
    "calendarId": "string",
    "calendarLevel": "string",
    "calendarStartDate": "2019-08-24T14:15:22Z",
    "calendarEndDate": "2019-08-24T14:15:22Z",
    "payDayExampleDate": "2019-08-24T14:15:22Z",
    "payDayFrequencyType": 0,
    "payDayPrimaryValue": 0,
    "payDaySecondaryValue": 0,
    "payDayCountFromEndOfMonth": true,
    "workflowGroupId": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "tagged": [
    {
      "id": 0,
      "planId": 0,
      "tagType": 0,
      "taggedTo": "string",
      "mappings": [],
      "restrictions": {},
      "valid": true,
      "validationItems": [],
      "displayName": "string",
      "version": {}
    }
  ],
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/pulseplans',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/pulseplans', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/pulseplans',
  params: {
  }, headers: headers

p JSON.parse(result)

Update a pulse plan.

Body parameter

{
  "id": 0,
  "name": "string",
  "description": "string",
  "highlightColor": "string",
  "creationDate": "2019-08-24T14:15:22Z",
  "workflowObjectId": 0,
  "settings": {
    "id": 0,
    "planId": 0,
    "calendarId": "string",
    "calendarLevel": "string",
    "calendarStartDate": "2019-08-24T14:15:22Z",
    "calendarEndDate": "2019-08-24T14:15:22Z",
    "payDayExampleDate": "2019-08-24T14:15:22Z",
    "payDayFrequencyType": 0,
    "payDayPrimaryValue": 0,
    "payDaySecondaryValue": 0,
    "payDayCountFromEndOfMonth": true,
    "workflowGroupId": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "tagged": [
    {
      "id": 0,
      "planId": 0,
      "tagType": 0,
      "taggedTo": "string",
      "mappings": [],
      "restrictions": {},
      "valid": true,
      "validationItems": [],
      "displayName": "string",
      "version": {}
    }
  ],
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Pulse.PulsePlanDTO

false

none

» id

body

integer(int32)

false

none

» name

body

string¦null

false

none

» description

body

string¦null

false

none

» highlightColor

body

string¦null

false

none

» creationDate

body

string(date-time)

false

none

» workflowObjectId

body

integer(int32)

false

none

» settings

body

RESTAPI.v1.DTOs.Pulse.PulsePlanSettingsDTO

false

none

»» id

body

integer(int32)

false

none

»» planId

body

integer(int32)

false

none

»» calendarId

body

string¦null

false

none

»» calendarLevel

body

string¦null

false

none

»» calendarStartDate

body

string(date-time)¦null

false

none

»» calendarEndDate

body

string(date-time)¦null

false

none

»» payDayExampleDate

body

string(date-time)

false

none

»» payDayFrequencyType

body

integer(int32)

false

none

»» payDayPrimaryValue

body

integer(int32)

false

none

»» payDaySecondaryValue

body

integer(int32)

false

none

»» payDayCountFromEndOfMonth

body

boolean

false

none

»» workflowGroupId

body

integer(int32)¦null

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» rowVersion

body

integer(int64)

false

none

» tagged

body

[RESTAPI.v1.DTOs.Pulse.TaggedDTO]¦null

false

none

»» id

body

integer(int32)

false

none

»» planId

body

integer(int32)

false

none

»» tagType

body

integer(int32)

false

none

»» taggedTo

body

string¦null

false

none

»» mappings

body

[RESTAPI.v1.DTOs.Pulse.TagMappingDTO]¦null

false

none

»»» tagColumn

body

integer(int32)

false

none

»»» taggedToTable

body

string¦null

false

none

»»» taggedToColumn

body

string¦null

false

none

»» restrictions

body

Varicent.RESTAPI.v1.DTOs.QuerySourceDefinitionDTO

false

none

»»» name

body

string¦null

false

none

»»» sourceDefinition

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»»»» alias

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» customSelect

body

string¦null

false

none

»»»»»» dataType

body

string

false

none

»»»»»» type

body

string

false

none

»»»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»» expressionType

body

string

false

none

»»»»»»» cases

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»»» constraintType

body

string

false

none

»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»» condition

body

any

false

none

»»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»»» literalType

body

string

false

none

»»»»»»»»»» value

body

any

false

none

»»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»»» constraints

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»» literalRight

body

any

false

none

»»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»» right

body

any

false

none

»»»»»»»»» expressionLeft

body

any

false

none

»»»»»»»»» expressionRight

body

any

false

none

»»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»»» like

body

string¦null

false

none

»»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»»»» trueValue

body

any

false

none

»»»»»»»» falseValue

body

any

false

none

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» isDate

body

boolean

false

none

»»»»»»» literalType

body

string

false

none

»»»»»»» value

body

any

false

none

»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»»»» m_namespace

body

string¦null

false

none

»»»»»»» name

body

string¦null

false

none

»»»»»» query

body

any

false

none

»»»»»» alias

body

string¦null

false

none

»»»»»» sourceType

body

string

false

none

»»»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»» joinType

body

string

false

none

»»»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»»» constraintType

body

string

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»» like

body

string¦null

false

none

»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» queryDefinitionRight

body

any

false

none

»»»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» direction

body

string

false

none

»»»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» distinct

body

boolean

false

none

»»»»» unionWith

body

any

false

none

»»»»» exceptWith

body

any

false

none

»»»» sourceNames

body

object¦null

false

none

»»»»» additionalProperties

body

string¦null

false

none

»»» dependencies

body

[string]¦null

false

none

»»» columns

body

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

»»»» name

body

string¦null

false

none

»»»» type

body

string

false

none

»»»» isKey

body

boolean

false

none

»»»» nullable

body

boolean

false

none

»»»» values

body

string¦null

false

none

»»»» lockedPeriod

body

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

»»»»» start

body

string(date-time)

false

none

»»»»» end

body

string(date-time)

false

none

»»»» referencedCol

body

string¦null

false

none

»»»» picklistFilter

body

string¦null

false

none

»»»» displayName

body

string¦null

false

none

»»»» isELTPeriod

body

boolean¦null

false

none

»»» references

body

object¦null

false

none

»»»» additionalProperties

body

string

false

none

»»» timeReferences

body

object¦null

false

none

»»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»»»» levelId

body

string¦null

false

none

»»»»» timeId

body

string¦null

false

none

»» valid

body

boolean

false

none

»» validationItems

body

[RESTAPI.v1.DTOs.Pulse.CompPlanValidationItemDTO]¦null

false

none

»»» level

body

integer(int32)

false

none

»»» code

body

integer(int32)

false

none

»»» affectedColumn

body

RESTAPI.v1.DTOs.Pulse.TagColumnDTO

false

none

»»»» displayName

body

string¦null

false

none

»»»» value

body

integer(int32)

false

none

»»»» allowedTypes

body

[string]¦null

false

none

»»» affectedTagType

body

integer(int32)

false

none

»» displayName

body

string¦null

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

»»»»»» dataType

Int

»»»»»» dataType

Decimal

»»»»»» dataType

DateTime

»»»»»» dataType

None

»»»»»» dataType

String

»»»»»» type

SelectAll

»»»»»» type

SelectItem

»»»»»» type

SelectLiteral

»»»»»» type

SelectCustom

»»»»»» type

SelectExpression

»»»»»»» expressionType

caseExpression

»»»»»»» expressionType

dataField

»»»»»»» expressionType

function

»»»»»»» expressionType

ifExpression

»»»»»»» expressionType

literal

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»»» constraintType

clause

»»»»»»»»» constraintType

constraint

»»»»»»»»» constraintType

expressionConstraint

»»»»»»»»» constraintType

likeConstraint

»»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»»» constraintType

subQueryConstraint

»»»»»»»»»» expressionType

caseExpression

»»»»»»»»»» expressionType

dataField

»»»»»»»»»» expressionType

function

»»»»»»»»»» expressionType

ifExpression

»»»»»»»»»» expressionType

literal

»»»»»»»»»» literalType

Integer

»»»»»»»»»» literalType

Decimal

»»»»»»»»»» literalType

Date

»»»»»»»»»» literalType

DateTime

»»»»»»»»»» literalType

String

»»»»»»»»»» literalType

Float

»»»»»»»»»» literalType

Long

»»»»»»»»»» literalType

Null

»»»»»»»»»» literalType

Parameter

»»»»»»»»»» literalType

Guid

»»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»»» literalType

Boolean

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»»» literalType

Integer

»»»»»»» literalType

Decimal

»»»»»»» literalType

Date

»»»»»»» literalType

DateTime

»»»»»»» literalType

String

»»»»»»» literalType

Float

»»»»»»» literalType

Long

»»»»»»» literalType

Null

»»»»»»» literalType

Parameter

»»»»»»» literalType

Guid

»»»»»»» literalType

SystemUtcTime

»»»»»»» literalType

Boolean

»»»»»» sourceType

Table

»»»»»» sourceType

Query

»»»»»» joinType

Inner

»»»»»» joinType

Left

»»»»»» joinType

Right

»»»»»» joinType

Cross

»»»»»» joinType

CrossApply

»»»»»» joinType

OuterApply

»»»»»»» constraintType

clause

»»»»»»» constraintType

constraint

»»»»»»» constraintType

expressionConstraint

»»»»»»» constraintType

likeConstraint

»»»»»»» constraintType

rowVersionConstraint

»»»»»»» constraintType

subQueryConstraint

»»»»»» direction

Ascending

»»»»»» direction

Descending

»»»»»» direction

AscendingNullsFirst

»»»»»» direction

DescendingNullsLast

»»»» type

String

»»»» type

LongString

»»»» type

MaxString

»»»» type

Date

»»»» type

DateTime

»»»» type

Decimal

»»»» type

Int

»»»» type

Long

»»»» type

Float

»»»» type

BLOB

»»»» type

Identity

»»»» type

CLOB

»»»» type

RowVersion

»»»» type

UID

»»»» type

VarCharMax

»»»» type

Boolean

»»»» allowedTypes

String

»»»» allowedTypes

LongString

»»»» allowedTypes

MaxString

»»»» allowedTypes

Date

»»»» allowedTypes

DateTime

»»»» allowedTypes

Decimal

»»»» allowedTypes

Int

»»»» allowedTypes

Long

»»»» allowedTypes

Float

»»»» allowedTypes

BLOB

»»»» allowedTypes

Identity

»»»» allowedTypes

CLOB

»»»» allowedTypes

RowVersion

»»»» allowedTypes

UID

»»»» allowedTypes

VarCharMax

»»»» allowedTypes

Boolean

Responses

Status

Meaning

Description

Schema

200

OK

Update a Pulse plan.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/pulseplans", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/pulseplans");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "name": "string",
  "description": "string",
  "highlightColor": "string",
  "creationDate": "2019-08-24T14:15:22Z",
  "workflowObjectId": 0,
  "settings": {
    "id": 0,
    "planId": 0,
    "calendarId": "string",
    "calendarLevel": "string",
    "calendarStartDate": "2019-08-24T14:15:22Z",
    "calendarEndDate": "2019-08-24T14:15:22Z",
    "payDayExampleDate": "2019-08-24T14:15:22Z",
    "payDayFrequencyType": 0,
    "payDayPrimaryValue": 0,
    "payDaySecondaryValue": 0,
    "payDayCountFromEndOfMonth": true,
    "workflowGroupId": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "tagged": [
    {
      "id": 0,
      "planId": 0,
      "tagType": 0,
      "taggedTo": "string",
      "mappings": [],
      "restrictions": {},
      "valid": true,
      "validationItems": [],
      "displayName": "string",
      "version": {}
    }
  ],
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/pulseplans',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/pulseplans', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/pulseplans',
  params: {
  }, headers: headers

p JSON.parse(result)

Retrieve a specific pulse plan.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get a Pulse plan

RESTAPI.v1.DTOs.Pulse.PulsePlanDTO

404

Not Found

Pulse Plan not found.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/pulseplans/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/pulseplans/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/pulseplans/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/pulseplans/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/pulseplans/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "description": "string",
  "highlightColor": "string",
  "creationDate": "2019-08-24T14:15:22Z",
  "workflowObjectId": 0,
  "settings": {
    "id": 0,
    "planId": 0,
    "calendarId": "string",
    "calendarLevel": "string",
    "calendarStartDate": "2019-08-24T14:15:22Z",
    "calendarEndDate": "2019-08-24T14:15:22Z",
    "payDayExampleDate": "2019-08-24T14:15:22Z",
    "payDayFrequencyType": 0,
    "payDayPrimaryValue": 0,
    "payDaySecondaryValue": 0,
    "payDayCountFromEndOfMonth": true,
    "workflowGroupId": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "tagged": [
    {
      "id": 0,
      "planId": 0,
      "tagType": 0,
      "taggedTo": "string",
      "mappings": [],
      "restrictions": {},
      "valid": true,
      "validationItems": [],
      "displayName": "string",
      "version": {}
    }
  ],
  "version": {
    "rowVersion": 0
  }
}
{"id":0,"name":"string","description":"string","highlightColor":"string","creationDate":"2019-08-24T14:15:22Z","workflowObjectId":0,"settings":{"id":0,"planId":0,"calendarId":"string","calendarLevel":"string","calendarStartDate":"2019-08-24T14:15:22Z","calendarEndDate":"2019-08-24T14:15:22Z","payDayExampleDate":"2019-08-24T14:15:22Z","payDayFrequencyType":0,"payDayPrimaryValue":0,"payDaySecondaryValue":0,"payDayCountFromEndOfMonth":true,"workflowGroupId":0,"version":{"rowVersion":0}},"tagged":[{"id":0,"planId":0,"tagType":0,"taggedTo":"string","mappings":[],"restrictions":{},"valid":true,"validationItems":[],"displayName":"string","version":{}}],"version":{"rowVersion":0}}

Remove a specific pulse plan.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Remove the specified Pulse plan

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/pulseplans/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/pulseplans/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/pulseplans/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/pulseplans/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/pulseplans/{id}',
  params: {
  }

p JSON.parse(result)

Get all Tags.

Responses

Status

Meaning

Description

Schema

200

OK

Get all Tagged

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.Pulse.TaggedDTO]

false

none

none

» id

integer(int32)

false

none

none

» planId

integer(int32)

false

none

none

» tagType

integer(int32)

false

none

none

» taggedTo

string¦null

false

none

none

» mappings

[RESTAPI.v1.DTOs.Pulse.TagMappingDTO]¦null

false

none

none

»» tagColumn

integer(int32)

false

none

none

»» taggedToTable

string¦null

false

none

none

»» taggedToColumn

string¦null

false

none

none

» restrictions

Varicent.RESTAPI.v1.DTOs.QuerySourceDefinitionDTO

false

none

none

»» name

string¦null

false

none

none

»» sourceDefinition

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

»»» query

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

»»»» selectItems

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

none

»»»»» alias

string¦null

false

none

none

»»»»» column

string¦null

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» customSelect

string¦null

false

none

none

»»»»» dataType

string

false

none

none

»»»»» type

string

false

none

none

»»»»» value

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»»» expressionType

string

false

none

none

»»»»»» cases

array¦null

false

none

none

»»»»»»» anonymous

any

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» column

string¦null

false

none

none

»»»»»» op

string¦null

false

none

none

»»»»»» arguments

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

none

[DTO version of IExpression]

»»»»»»» expressionType

string

false

none

none

»»»»»»» cases

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» column

string¦null

false

none

none

»»»»»»» op

string¦null

false

none

none

»»»»»»» arguments

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»»»» constraintType

string

false

none

none

»»»»»»»» op

string¦null

false

none

none

»»»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»»» expressionType

string

false

none

none

»»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»» table

string¦null

false

none

none

»»»»»»»»» column

string¦null

false

none

none

»»»»»»»»» op

string¦null

false

none

none

»»»»»»»»» arguments

array¦null

false

none

none

»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»» condition

any

false

none

none

»»»»»»»»» trueValue

any

false

none

none

»»»»»»»»» falseValue

any

false

none

none

»»»»»»»»» isDate

boolean

false

none

none

»»»»»»»»» literalType

string

false

none

none

»»»»»»»»» value

any

false

none

none

»»»»»»»» caseSensitive

boolean

false

none

none

»»»»»»»» constraints

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» literalRight

any

false

none

none

»»»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»» right

any

false

none

none

»»»»»»»» expressionLeft

any

false

none

none

»»»»»»»» expressionRight

any

false

none

none

»»»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»»»» like

string¦null

false

none

none

»»»»»»»» escapeWildcards

boolean

false

none

none

»»»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»»»» rowVersion

integer(int64)

false

none

none

»»»»»»»» table

string¦null

false

none

none

»»»»»»»» queryDefinitionRight

any

false

none

none

»»»»»»» trueValue

any

false

none

none

»»»»»»» falseValue

any

false

none

none

»»»»»»» isDate

boolean

false

none

none

»»»»»»» literalType

string

false

none

none

»»»»»»» value

any

false

none

none

»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»» trueValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»» falseValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»» isDate

boolean

false

none

none

»»»»»» literalType

string

false

none

none

»»»»»» value

any

false

none

none

»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»»» namespaceTable

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

none

»»»»»» m_namespace

string¦null

false

none

none

»»»»»» name

string¦null

false

none

none

»»»»» query

any

false

none

none

»»»»» alias

string¦null

false

none

none

»»»»» sourceType

string

false

none

none

»»»» joins

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

none

»»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»»» joinType

string

false

none

none

»»»»» onClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»»» constraintType

string

false

none

none

»»»»»» op

string¦null

false

none

none

»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»» caseSensitive

boolean

false

none

none

»»»»»» constraints

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

none

[DTO version of IConstraint]

»»»»»» literalRight

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»» right

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»» expressionLeft

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»» expressionRight

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»» like

string¦null

false

none

none

»»»»»» escapeWildcards

boolean

false

none

none

»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» queryDefinitionRight

any

false

none

none

»»»» whereClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»» order

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» column

string¦null

false

none

none

»»»»» direction

string

false

none

none

»»»» group

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» column

string¦null

false

none

none

»»»» havingClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»» distinct

boolean

false

none

none

»»»» unionWith

any

false

none

none

»»»» exceptWith

any

false

none

none

»»» sourceNames

object¦null

false

none

none

»»»» additionalProperties

string¦null

false

none

none

»» dependencies

[string]¦null

false

none

none

»» columns

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

none

»»» name

string¦null

false

none

none

»»» type

string

false

none

none

»»» isKey

boolean

false

none

none

»»» nullable

boolean

false

none

none

»»» values

string¦null

false

none

none

»»» lockedPeriod

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

none

»»»» start

string(date-time)

false

none

none

»»»» end

string(date-time)

false

none

none

»»» referencedCol

string¦null

false

none

none

»»» picklistFilter

string¦null

false

none

none

»»» displayName

string¦null

false

none

none

»»» isELTPeriod

boolean¦null

false

none

none

»» references

object¦null

false

none

none

»»» additionalProperties

string

false

none

none

»» timeReferences

object¦null

false

none

none

»»» additionalProperties

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

none

»»»» levelId

string¦null

false

none

none

»»»» timeId

string¦null

false

none

none

» valid

boolean

false

none

none

» validationItems

[RESTAPI.v1.DTOs.Pulse.CompPlanValidationItemDTO]¦null

false

none

none

»» level

integer(int32)

false

none

none

»» code

integer(int32)

false

none

none

»» affectedColumn

RESTAPI.v1.DTOs.Pulse.TagColumnDTO

false

none

none

»»» displayName

string¦null

false

none

none

»»» value

integer(int32)

false

none

none

»»» allowedTypes

[string]¦null

false

none

none

»» affectedTagType

integer(int32)

false

none

none

» displayName

string¦null

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

dataType

Int

dataType

Decimal

dataType

DateTime

dataType

None

dataType

String

type

SelectAll

type

SelectItem

type

SelectLiteral

type

SelectCustom

type

SelectExpression

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

sourceType

Table

sourceType

Query

joinType

Inner

joinType

Left

joinType

Right

joinType

Cross

joinType

CrossApply

joinType

OuterApply

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

direction

Ascending

direction

Descending

direction

AscendingNullsFirst

direction

DescendingNullsLast

type

String

type

LongString

type

MaxString

type

Date

type

DateTime

type

Decimal

type

Int

type

Long

type

Float

type

BLOB

type

Identity

type

CLOB

type

RowVersion

type

UID

type

VarCharMax

type

Boolean

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/pulsetagged", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/pulsetagged");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/pulsetagged',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/pulsetagged', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/pulsetagged',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "planId": 0,
    "tagType": 0,
    "taggedTo": "string",
    "mappings": [
      {}
    ],
    "restrictions": {
      "name": "string",
      "sourceDefinition": {},
      "dependencies": [],
      "columns": [],
      "references": {},
      "timeReferences": {}
    },
    "valid": true,
    "validationItems": [
      {}
    ],
    "displayName": "string",
    "version": {
      "rowVersion": 0
    }
  }
]
[{"id":0,"planId":0,"tagType":0,"taggedTo":"string","mappings":[{}],"restrictions":{"name":"string","sourceDefinition":{},"dependencies":[],"columns":[],"references":{},"timeReferences":{}},"valid":true,"validationItems":[{}],"displayName":"string","version":{"rowVersion":0}}]

Add or update a tagged item.

Body parameter

{
  "id": 0,
  "planId": 0,
  "tagType": 0,
  "taggedTo": "string",
  "mappings": [
    {
      "tagColumn": 0,
      "taggedToTable": "string",
      "taggedToColumn": "string"
    }
  ],
  "restrictions": {
    "name": "string",
    "sourceDefinition": {
      "query": {},
      "sourceNames": {}
    },
    "dependencies": [
      "string"
    ],
    "columns": [
      {}
    ],
    "references": {
      "property1": "string",
      "property2": "string"
    },
    "timeReferences": {
      "property1": {},
      "property2": {}
    }
  },
  "valid": true,
  "validationItems": [
    {
      "level": 0,
      "code": 0,
      "affectedColumn": {},
      "affectedTagType": 0
    }
  ],
  "displayName": "string",
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Pulse.TaggedDTO

false

none

» id

body

integer(int32)

false

none

» planId

body

integer(int32)

false

none

» tagType

body

integer(int32)

false

none

» taggedTo

body

string¦null

false

none

» mappings

body

[RESTAPI.v1.DTOs.Pulse.TagMappingDTO]¦null

false

none

»» tagColumn

body

integer(int32)

false

none

»» taggedToTable

body

string¦null

false

none

»» taggedToColumn

body

string¦null

false

none

» restrictions

body

Varicent.RESTAPI.v1.DTOs.QuerySourceDefinitionDTO

false

none

»» name

body

string¦null

false

none

»» sourceDefinition

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»»» alias

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» table

body

string¦null

false

none

»»»»» customSelect

body

string¦null

false

none

»»»»» dataType

body

string

false

none

»»»»» type

body

string

false

none

»»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»» expressionType

body

string

false

none

»»»»»» cases

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»»» expressionType

body

string

false

none

»»»»»»» cases

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» arguments

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»» constraintType

body

string

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»» condition

body

any

false

none

»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»» literalType

body

string

false

none

»»»»»»»»» value

body

any

false

none

»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»» constraints

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» literalRight

body

any

false

none

»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» right

body

any

false

none

»»»»»»»» expressionLeft

body

any

false

none

»»»»»»»» expressionRight

body

any

false

none

»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»» like

body

string¦null

false

none

»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»»» trueValue

body

any

false

none

»»»»»»» falseValue

body

any

false

none

»»»»»»» isDate

body

boolean

false

none

»»»»»»» literalType

body

string

false

none

»»»»»»» value

body

any

false

none

»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» isDate

body

boolean

false

none

»»»»»» literalType

body

string

false

none

»»»»»» value

body

any

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»»» m_namespace

body

string¦null

false

none

»»»»»» name

body

string¦null

false

none

»»»»» query

body

any

false

none

»»»»» alias

body

string¦null

false

none

»»»»» sourceType

body

string

false

none

»»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»» joinType

body

string

false

none

»»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»» constraintType

body

string

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»» caseSensitive

body

boolean

false

none

»»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»» like

body

string¦null

false

none

»»»»»» escapeWildcards

body

boolean

false

none

»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» queryDefinitionRight

body

any

false

none

»»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» direction

body

string

false

none

»»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»» distinct

body

boolean

false

none

»»»» unionWith

body

any

false

none

»»»» exceptWith

body

any

false

none

»»» sourceNames

body

object¦null

false

none

»»»» additionalProperties

body

string¦null

false

none

»» dependencies

body

[string]¦null

false

none

»» columns

body

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

»»» name

body

string¦null

false

none

»»» type

body

string

false

none

»»» isKey

body

boolean

false

none

»»» nullable

body

boolean

false

none

»»» values

body

string¦null

false

none

»»» lockedPeriod

body

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

»»»» start

body

string(date-time)

false

none

»»»» end

body

string(date-time)

false

none

»»» referencedCol

body

string¦null

false

none

»»» picklistFilter

body

string¦null

false

none

»»» displayName

body

string¦null

false

none

»»» isELTPeriod

body

boolean¦null

false

none

»» references

body

object¦null

false

none

»»» additionalProperties

body

string

false

none

»» timeReferences

body

object¦null

false

none

»»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»»» levelId

body

string¦null

false

none

»»»» timeId

body

string¦null

false

none

» valid

body

boolean

false

none

» validationItems

body

[RESTAPI.v1.DTOs.Pulse.CompPlanValidationItemDTO]¦null

false

none

»» level

body

integer(int32)

false

none

»» code

body

integer(int32)

false

none

»» affectedColumn

body

RESTAPI.v1.DTOs.Pulse.TagColumnDTO

false

none

»»» displayName

body

string¦null

false

none

»»» value

body

integer(int32)

false

none

»»» allowedTypes

body

[string]¦null

false

none

»» affectedTagType

body

integer(int32)

false

none

» displayName

body

string¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

»»»»» dataType

Int

»»»»» dataType

Decimal

»»»»» dataType

DateTime

»»»»» dataType

None

»»»»» dataType

String

»»»»» type

SelectAll

»»»»» type

SelectItem

»»»»» type

SelectLiteral

»»»»» type

SelectCustom

»»»»» type

SelectExpression

»»»»»» expressionType

caseExpression

»»»»»» expressionType

dataField

»»»»»» expressionType

function

»»»»»» expressionType

ifExpression

»»»»»» expressionType

literal

»»»»»»» expressionType

caseExpression

»»»»»»» expressionType

dataField

»»»»»»» expressionType

function

»»»»»»» expressionType

ifExpression

»»»»»»» expressionType

literal

»»»»»»»» constraintType

clause

»»»»»»»» constraintType

constraint

»»»»»»»» constraintType

expressionConstraint

»»»»»»»» constraintType

likeConstraint

»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»» constraintType

subQueryConstraint

»»»»»»»»» expressionType

caseExpression

»»»»»»»»» expressionType

dataField

»»»»»»»»» expressionType

function

»»»»»»»»» expressionType

ifExpression

»»»»»»»»» expressionType

literal

»»»»»»»»» literalType

Integer

»»»»»»»»» literalType

Decimal

»»»»»»»»» literalType

Date

»»»»»»»»» literalType

DateTime

»»»»»»»»» literalType

String

»»»»»»»»» literalType

Float

»»»»»»»»» literalType

Long

»»»»»»»»» literalType

Null

»»»»»»»»» literalType

Parameter

»»»»»»»»» literalType

Guid

»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»» literalType

Boolean

»»»»»»» literalType

Integer

»»»»»»» literalType

Decimal

»»»»»»» literalType

Date

»»»»»»» literalType

DateTime

»»»»»»» literalType

String

»»»»»»» literalType

Float

»»»»»»» literalType

Long

»»»»»»» literalType

Null

»»»»»»» literalType

Parameter

»»»»»»» literalType

Guid

»»»»»»» literalType

SystemUtcTime

»»»»»»» literalType

Boolean

»»»»»» literalType

Integer

»»»»»» literalType

Decimal

»»»»»» literalType

Date

»»»»»» literalType

DateTime

»»»»»» literalType

String

»»»»»» literalType

Float

»»»»»» literalType

Long

»»»»»» literalType

Null

»»»»»» literalType

Parameter

»»»»»» literalType

Guid

»»»»»» literalType

SystemUtcTime

»»»»»» literalType

Boolean

»»»»» sourceType

Table

»»»»» sourceType

Query

»»»»» joinType

Inner

»»»»» joinType

Left

»»»»» joinType

Right

»»»»» joinType

Cross

»»»»» joinType

CrossApply

»»»»» joinType

OuterApply

»»»»»» constraintType

clause

»»»»»» constraintType

constraint

»»»»»» constraintType

expressionConstraint

»»»»»» constraintType

likeConstraint

»»»»»» constraintType

rowVersionConstraint

»»»»»» constraintType

subQueryConstraint

»»»»» direction

Ascending

»»»»» direction

Descending

»»»»» direction

AscendingNullsFirst

»»»»» direction

DescendingNullsLast

»»» type

String

»»» type

LongString

»»» type

MaxString

»»» type

Date

»»» type

DateTime

»»» type

Decimal

»»» type

Int

»»» type

Long

»»» type

Float

»»» type

BLOB

»»» type

Identity

»»» type

CLOB

»»» type

RowVersion

»»» type

UID

»»» type

VarCharMax

»»» type

Boolean

»»» allowedTypes

String

»»» allowedTypes

LongString

»»» allowedTypes

MaxString

»»» allowedTypes

Date

»»» allowedTypes

DateTime

»»» allowedTypes

Decimal

»»» allowedTypes

Int

»»» allowedTypes

Long

»»» allowedTypes

Float

»»» allowedTypes

BLOB

»»» allowedTypes

Identity

»»» allowedTypes

CLOB

»»» allowedTypes

RowVersion

»»» allowedTypes

UID

»»» allowedTypes

VarCharMax

»»» allowedTypes

Boolean

Responses

Status

Meaning

Description

Schema

200

OK

Add/Update a Tagged item. If the id is valid, it will be updated, if id <= 0 then it will be added.

RESTAPI.v1.DTOs.Pulse.TaggedDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/pulsetagged", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/pulsetagged");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "planId": 0,
  "tagType": 0,
  "taggedTo": "string",
  "mappings": [
    {
      "tagColumn": 0,
      "taggedToTable": "string",
      "taggedToColumn": "string"
    }
  ],
  "restrictions": {
    "name": "string",
    "sourceDefinition": {
      "query": {},
      "sourceNames": {}
    },
    "dependencies": [
      "string"
    ],
    "columns": [
      {}
    ],
    "references": {
      "property1": "string",
      "property2": "string"
    },
    "timeReferences": {
      "property1": {},
      "property2": {}
    }
  },
  "valid": true,
  "validationItems": [
    {
      "level": 0,
      "code": 0,
      "affectedColumn": {},
      "affectedTagType": 0
    }
  ],
  "displayName": "string",
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/pulsetagged',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/pulsetagged', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/pulsetagged',
  params: {
  }, headers: headers

p JSON.parse(result)

Get all taggable items.

Responses

Status

Meaning

Description

Schema

200

OK

Get all taggable items in the current model

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.Pulse.TaggableDTO]

false

none

none

» name

string¦null

false

none

none

» displayName

string¦null

false

none

none

» columns

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

none

»» name

string¦null

false

none

none

»» type

string

false

none

none

»» isKey

boolean

false

none

none

»» nullable

boolean

false

none

none

»» values

string¦null

false

none

none

»» lockedPeriod

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

none

»»» start

string(date-time)

false

none

none

»»» end

string(date-time)

false

none

none

»» referencedCol

string¦null

false

none

none

»» picklistFilter

string¦null

false

none

none

»» displayName

string¦null

false

none

none

»» isELTPeriod

boolean¦null

false

none

none

» frequencyColumns

[string]¦null

false

none

none

» payeeColumns

[string]¦null

false

none

none

» objectType

string

false

none

none

Enumerated Values

Property

Value

type

String

type

LongString

type

MaxString

type

Date

type

DateTime

type

Decimal

type

Int

type

Long

type

Float

type

BLOB

type

Identity

type

CLOB

type

RowVersion

type

UID

type

VarCharMax

type

Boolean

objectType

Undefined

objectType

Calculation

objectType

Table

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/pulsetaggables", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/pulsetaggables");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/pulsetaggables',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/pulsetaggables', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/pulsetaggables',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "name": "string",
    "displayName": "string",
    "columns": [
      {}
    ],
    "frequencyColumns": [
      "string"
    ],
    "payeeColumns": [
      "string"
    ],
    "objectType": "Undefined"
  }
]
[{"name":"string","displayName":"string","columns":[{}],"frequencyColumns":["string"],"payeeColumns":["string"],"objectType":"Undefined"}]

Get all taggable sources.

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Composer.DataSourceSchemaDTO]

false

none

none

» displayName

string¦null

false

none

none

» details

Varicent.RESTAPI.v1.DTOs.ExpandableResourceDTO

false

none

none

»» href

string¦null

false

none

none

» type

string

false

none

none

» fullTableSchema

Varicent.RESTAPI.v1.DTOs.FullTableSchemaDTO

false

none

none

»» columns

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

none

»»» name

string¦null

false

none

none

»»» type

string

false

none

none

»»» isKey

boolean

false

none

none

»»» nullable

boolean

false

none

none

»»» values

string¦null

false

none

none

»»» lockedPeriod

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

none

»»»» start

string(date-time)

false

none

none

»»»» end

string(date-time)

false

none

none

»»» referencedCol

string¦null

false

none

none

»»» picklistFilter

string¦null

false

none

none

»»» displayName

string¦null

false

none

none

»»» isELTPeriod

boolean¦null

false

none

none

»» table

string¦null

false

none

none

»» name

string¦null

false

none

none

»» referencedSources

[string]¦null

false

none

none

»» referencedTimes

[Varicent.RESTAPI.v1.DTOs.FrequencyDTO]¦null

false

none

none

»»» levelId

string¦null

false

none

none

»»» timeId

string¦null

false

none

none

»» referencedSourcesDictionary

object¦null

false

none

none

»»» additionalProperties

string

false

none

none

»» referencedTimesDictionary

object¦null

false

none

none

»»» additionalProperties

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

none

» tableDefinition

Varicent.RESTAPI.v1.DTOs.TableDefinitionDTO

false

none

none

»» table

Varicent.RESTAPI.v1.DTOs.CustomTableDTO

false

none

none

»»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»» rowVersion

integer(int64)

false

none

none

»»» name

string¦null

false

none

none

»»» tableType

string

false

none

none

»»» effectiveDated

boolean

false

none

none

»»» workflowObjectID

integer(int32)

false

none

none

»»» hierarchyMetadata

RESTAPI.v1.DTOs.Hierarchy.HierarchyMetadataDTO

false

none

none

»»»» tableName

string¦null

false

none

none

»»»» idColumnName

string¦null

false

none

none

»»»» parentColumnName

string¦null

false

none

none

»»» lastUpdatedTracking

boolean¦null

false

none

none

»» columns

[Varicent.RESTAPI.v1.DTOs.ColumnDefinitionDTO]¦null

false

none

none

»»» column

Varicent.RESTAPI.v1.DTOs.CustomColumnDTO

false

none

none

»»»» name

string¦null

false

none

none

»»»» type

string

false

none

none

»»»» referencedTable

string¦null

false

none

none

»»»» referencedName

string¦null

false

none

none

»»»» source

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

»»»»» query

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

»»»»»» selectItems

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

none

»»»»»»» alias

string¦null

false

none

none

»»»»»»» column

string¦null

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» customSelect

string¦null

false

none

none

»»»»»»» dataType

string

false

none

none

»»»»»»» type

string

false

none

none

»»»»»»» value

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»»»»» expressionType

string

false

none

none

»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» table

string¦null

false

none

none

»»»»»»»» column

string¦null

false

none

none

»»»»»»»» op

string¦null

false

none

none

»»»»»»»» arguments

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

none

[DTO version of IExpression]

»»»»»»»»» expressionType

string

false

none

none

»»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»» table

string¦null

false

none

none

»»»»»»»»» column

string¦null

false

none

none

»»»»»»»»» op

string¦null

false

none

none

»»»»»»»»» arguments

array¦null

false

none

none

»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»»»»»» constraintType

string

false

none

none

»»»»»»»»»» op

string¦null

false

none

none

»»»»»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»»»»» expressionType

string

false

none

none

»»»»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»»»» table

string¦null

false

none

none

»»»»»»»»»»» column

string¦null

false

none

none

»»»»»»»»»»» op

string¦null

false

none

none

»»»»»»»»»»» arguments

array¦null

false

none

none

»»»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»»»» condition

any

false

none

none

»»»»»»»»»»» trueValue

any

false

none

none

»»»»»»»»»»» falseValue

any

false

none

none

»»»»»»»»»»» isDate

boolean

false

none

none

»»»»»»»»»»» literalType

string

false

none

none

»»»»»»»»»»» value

any

false

none

none

»»»»»»»»»» caseSensitive

boolean

false

none

none

»»»»»»»»»» constraints

array¦null

false

none

none

»»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»»» literalRight

any

false

none

none

»»»»»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»»»» right

any

false

none

none

»»»»»»»»»» expressionLeft

any

false

none

none

»»»»»»»»»» expressionRight

any

false

none

none

»»»»»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»»»»»» like

string¦null

false

none

none

»»»»»»»»»» escapeWildcards

boolean

false

none

none

»»»»»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»»»»» table

string¦null

false

none

none

»»»»»»»»»» queryDefinitionRight

any

false

none

none

»»»»»»»»» trueValue

any

false

none

none

»»»»»»»»» falseValue

any

false

none

none

»»»»»»»»» isDate

boolean

false

none

none

»»»»»»»»» literalType

string

false

none

none

»»»»»»»»» value

any

false

none

none

»»»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»»»» trueValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»»» falseValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»»» isDate

boolean

false

none

none

»»»»»»»» literalType

string

false

none

none

»»»»»»»» value

any

false

none

none

»»»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»»»»» namespaceTable

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

none

»»»»»»»» m_namespace

string¦null

false

none

none

»»»»»»»» name

string¦null

false

none

none

»»»»»»» query

any

false

none

none

»»»»»»» alias

string¦null

false

none

none

»»»»»»» sourceType

string

false

none

none

»»»»»» joins

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

none

»»»»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»»»»» joinType

string

false

none

none

»»»»»»» onClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»»»»» constraintType

string

false

none

none

»»»»»»»» op

string¦null

false

none

none

»»»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»» caseSensitive

boolean

false

none

none

»»»»»»»» constraints

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

none

[DTO version of IConstraint]

»»»»»»»» literalRight

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»» right

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»»» expressionLeft

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»»» expressionRight

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»»»» like

string¦null

false

none

none

»»»»»»»» escapeWildcards

boolean

false

none

none

»»»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»»» table

string¦null

false

none

none

»»»»»»»» queryDefinitionRight

any

false

none

none

»»»»»» whereClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»»» order

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» column

string¦null

false

none

none

»»»»»»» direction

string

false

none

none

»»»»»» group

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» column

string¦null

false

none

none

»»»»»» havingClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»»» distinct

boolean

false

none

none

»»»»»» unionWith

any

false

none

none

»»»»»» exceptWith

any

false

none

none

»»»»» sourceNames

object¦null

false

none

none

»»»»»» additionalProperties

string¦null

false

none

none

»»»» pickListParams

[Varicent.RESTAPI.v1.DTOs.PickListParamDTO]¦null

false

none

none

»»»»» joinAlias

string¦null

false

none

none

»»»»» joinColumn

string¦null

false

none

none

»»»»» op

string

false

none

none

»»»» isKey

boolean

false

none

none

»»» isRemovable

boolean

false

none

none

»»» isNullable

boolean

false

none

none

»»» referencedColumn

string¦null

false

none

none

»» time

Varicent.RESTAPI.v1.DTOs.TableTimeDTO

false

none

none

»»» timeId

string¦null

false

none

none

»»» dateColumn

string¦null

false

none

none

»»» lockedOn

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

»»» min

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

»»» max

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

» calculationDefinition

Varicent.RESTAPI.v1.DTOs.CalculationDefinitionDTO

false

none

none

»» calculationId

integer(int32)

false

none

none

»» calculationType

string

false

none

none

»» planBuilderCalculationId

string¦null

false

none

none

Enumerated Values

Property

Value

type

Table

type

Calculation

type

DataStore

type

Port

type

Symon

type

PlanBuilderCalculation

type

String

type

LongString

type

MaxString

type

Date

type

DateTime

type

Decimal

type

Int

type

Long

type

Float

type

BLOB

type

Identity

type

CLOB

type

RowVersion

type

UID

type

VarCharMax

type

Boolean

tableType

System

tableType

Dimension

tableType

Structural

tableType

Lookup

tableType

Data

tableType

View

tableType

Custom

tableType

StarSchema

tableType

ExportTable

tableType

CreditingRule

tableType

AssignTable

tableType

PlcmCustomTable

tableType

PlcmStructuralTable

tableType

PlcmTable

tableType

DataSource

tableType

Cached

tableType

MaterializedView

type

Text

type

Date

type

List

type

Numeric

type

Email

type

Url

type

Comment

type

DateTime

dataType

Int

dataType

Decimal

dataType

DateTime

dataType

None

dataType

String

type

SelectAll

type

SelectItem

type

SelectLiteral

type

SelectCustom

type

SelectExpression

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

sourceType

Table

sourceType

Query

joinType

Inner

joinType

Left

joinType

Right

joinType

Cross

joinType

CrossApply

joinType

OuterApply

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

direction

Ascending

direction

Descending

direction

AscendingNullsFirst

direction

DescendingNullsLast

op

LessThan

op

LessThanEquals

op

Equals

op

NotEquals

op

GreaterThan

op

GreaterThanEquals

op

IsNull

op

IsNotNull

op

In

op

NotIn

calculationType

Mathematical

calculationType

Sorting

calculationType

TimeShift

calculationType

Category

calculationType

Symon

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/pulsetaggablesources", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/pulsetaggablesources");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/pulsetaggablesources',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/pulsetaggablesources', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/pulsetaggablesources',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "displayName": "string",
    "details": {
      "href": "string"
    },
    "type": "Table",
    "fullTableSchema": {
      "columns": [],
      "table": "string",
      "name": "string",
      "referencedSources": [],
      "referencedTimes": [],
      "referencedSourcesDictionary": {},
      "referencedTimesDictionary": {}
    },
    "tableDefinition": {
      "table": {},
      "columns": [],
      "time": {}
    },
    "calculationDefinition": {
      "calculationId": 0,
      "calculationType": "Mathematical",
      "planBuilderCalculationId": "string"
    }
  }
]
[{"displayName":"string","details":{"href":"string"},"type":"Table","fullTableSchema":{"columns":[],"table":"string","name":"string","referencedSources":[],"referencedTimes":[],"referencedSourcesDictionary":{},"referencedTimesDictionary":{}},"tableDefinition":{"table":{},"columns":[],"time":{}},"calculationDefinition":{"calculationId":0,"calculationType":"Mathematical","planBuilderCalculationId":"string"}}]

Remove a tagged item.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Remove a Tagged item.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/pulsetagged/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/pulsetagged/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/pulsetagged/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/pulsetagged/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/pulsetagged/{id}',
  params: {
  }

p JSON.parse(result)

Return pulse report structures.

Body parameter

{
  "name": "string",
  "sourceDefinition": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "dependencies": [
    "string"
  ],
  "columns": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "references": {
    "property1": "string",
    "property2": "string"
  },
  "timeReferences": {
    "property1": {
      "levelId": "string",
      "timeId": "string"
    },
    "property2": {
      "levelId": "string",
      "timeId": "string"
    }
  }
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.QuerySourceDefinitionDTO

false

none

» name

body

string¦null

false

none

» sourceDefinition

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»» alias

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» table

body

string¦null

false

none

»»»» customSelect

body

string¦null

false

none

»»»» dataType

body

string

false

none

»»»» type

body

string

false

none

»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»» expressionType

body

string

false

none

»»»»»» cases

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» arguments

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»» constraintType

body

string

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» condition

body

any

false

none

»»»»»»»» trueValue

body

any

false

none

»»»»»»»» falseValue

body

any

false

none

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»» constraints

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» literalRight

body

any

false

none

»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» right

body

any

false

none

»»»»»»» expressionLeft

body

any

false

none

»»»»»»» expressionRight

body

any

false

none

»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»» like

body

string¦null

false

none

»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»» trueValue

body

any

false

none

»»»»»» falseValue

body

any

false

none

»»»»»» isDate

body

boolean

false

none

»»»»»» literalType

body

string

false

none

»»»»»» value

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»» m_namespace

body

string¦null

false

none

»»»»» name

body

string¦null

false

none

»»»» query

body

any

false

none

»»»» alias

body

string¦null

false

none

»»»» sourceType

body

string

false

none

»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» joinType

body

string

false

none

»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» constraintType

body

string

false

none

»»»»» op

body

string¦null

false

none

»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» caseSensitive

body

boolean

false

none

»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isPreciseDecimal

body

boolean

false

none

»»»»» like

body

string¦null

false

none

»»»»» escapeWildcards

body

boolean

false

none

»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»» table

body

string¦null

false

none

»»»»» queryDefinitionRight

body

any

false

none

»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» direction

body

string

false

none

»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» distinct

body

boolean

false

none

»»» unionWith

body

any

false

none

»»» exceptWith

body

any

false

none

»» sourceNames

body

object¦null

false

none

»»» additionalProperties

body

string¦null

false

none

» dependencies

body

[string]¦null

false

none

» columns

body

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

»» name

body

string¦null

false

none

»» type

body

string

false

none

»» isKey

body

boolean

false

none

»» nullable

body

boolean

false

none

»» values

body

string¦null

false

none

»» lockedPeriod

body

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

»»» start

body

string(date-time)

false

none

»»» end

body

string(date-time)

false

none

»» referencedCol

body

string¦null

false

none

»» picklistFilter

body

string¦null

false

none

»» displayName

body

string¦null

false

none

»» isELTPeriod

body

boolean¦null

false

none

» references

body

object¦null

false

none

»» additionalProperties

body

string

false

none

» timeReferences

body

object¦null

false

none

»» additionalProperties

body

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

»»» levelId

body

string¦null

false

none

»»» timeId

body

string¦null

false

none

Enumerated Values

Parameter

Value

»»»» dataType

Int

»»»» dataType

Decimal

»»»» dataType

DateTime

»»»» dataType

None

»»»» dataType

String

»»»» type

SelectAll

»»»» type

SelectItem

»»»» type

SelectLiteral

»»»» type

SelectCustom

»»»» type

SelectExpression

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» expressionType

caseExpression

»»»»»» expressionType

dataField

»»»»»» expressionType

function

»»»»»» expressionType

ifExpression

»»»»»» expressionType

literal

»»»»»»» constraintType

clause

»»»»»»» constraintType

constraint

»»»»»»» constraintType

expressionConstraint

»»»»»»» constraintType

likeConstraint

»»»»»»» constraintType

rowVersionConstraint

»»»»»»» constraintType

subQueryConstraint

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»» literalType

Integer

»»»»»» literalType

Decimal

»»»»»» literalType

Date

»»»»»» literalType

DateTime

»»»»»» literalType

String

»»»»»» literalType

Float

»»»»»» literalType

Long

»»»»»» literalType

Null

»»»»»» literalType

Parameter

»»»»»» literalType

Guid

»»»»»» literalType

SystemUtcTime

»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» sourceType

Table

»»»» sourceType

Query

»»»» joinType

Inner

»»»» joinType

Left

»»»» joinType

Right

»»»» joinType

Cross

»»»» joinType

CrossApply

»»»» joinType

OuterApply

»»»»» constraintType

clause

»»»»» constraintType

constraint

»»»»» constraintType

expressionConstraint

»»»»» constraintType

likeConstraint

»»»»» constraintType

rowVersionConstraint

»»»»» constraintType

subQueryConstraint

»»»» direction

Ascending

»»»» direction

Descending

»»»» direction

AscendingNullsFirst

»»»» direction

DescendingNullsLast

»» type

String

»» type

LongString

»» type

MaxString

»» type

Date

»» type

DateTime

»» type

Decimal

»» type

Int

»» type

Long

»» type

Float

»» type

BLOB

»» type

Identity

»» type

CLOB

»» type

RowVersion

»» type

UID

»» type

VarCharMax

»» type

Boolean

Responses

Status

Meaning

Description

Schema

200

OK

Returned Pulse report structures

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Pulse.CompPlanReportTypeDTO]

false

none

none

» reportType

integer(int32)

false

none

none

» reportName

string¦null

false

none

none

» reportTypeSummary

string¦null

false

none

none

» reportDescription

string¦null

false

none

none

» tagTypes

[Varicent.RESTAPI.v1.DTOs.Pulse.TagTypeDTO]¦null

false

none

none

»» tagTypeId

integer(int32)

false

none

none

»» tagType

string¦null

false

none

none

»» tagColumns

[RESTAPI.v1.DTOs.Pulse.TagColumnDTO]¦null

false

none

none

»»» displayName

string¦null

false

none

none

»»» value

integer(int32)

false

none

none

»»» allowedTypes

[string]¦null

false

none

none

» reportTaggingGroup

string

false

none

none

» filters

Varicent.RESTAPI.v1.DTOs.QuerySourceDefinitionDTO

false

none

none

»» name

string¦null

false

none

none

»» sourceDefinition

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

»»» query

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

»»»» selectItems

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

none

»»»»» alias

string¦null

false

none

none

»»»»» column

string¦null

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» customSelect

string¦null

false

none

none

»»»»» dataType

string

false

none

none

»»»»» type

string

false

none

none

»»»»» value

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»»» expressionType

string

false

none

none

»»»»»» cases

array¦null

false

none

none

»»»»»»» anonymous

any

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» column

string¦null

false

none

none

»»»»»» op

string¦null

false

none

none

»»»»»» arguments

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

none

[DTO version of IExpression]

»»»»»»» expressionType

string

false

none

none

»»»»»»» cases

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» column

string¦null

false

none

none

»»»»»»» op

string¦null

false

none

none

»»»»»»» arguments

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»»»» constraintType

string

false

none

none

»»»»»»»» op

string¦null

false

none

none

»»»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»»» expressionType

string

false

none

none

»»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»» table

string¦null

false

none

none

»»»»»»»»» column

string¦null

false

none

none

»»»»»»»»» op

string¦null

false

none

none

»»»»»»»»» arguments

array¦null

false

none

none

»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»» condition

any

false

none

none

»»»»»»»»» trueValue

any

false

none

none

»»»»»»»»» falseValue

any

false

none

none

»»»»»»»»» isDate

boolean

false

none

none

»»»»»»»»» literalType

string

false

none

none

»»»»»»»»» value

any

false

none

none

»»»»»»»» caseSensitive

boolean

false

none

none

»»»»»»»» constraints

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» literalRight

any

false

none

none

»»»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»» right

any

false

none

none

»»»»»»»» expressionLeft

any

false

none

none

»»»»»»»» expressionRight

any

false

none

none

»»»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»»»» like

string¦null

false

none

none

»»»»»»»» escapeWildcards

boolean

false

none

none

»»»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»»»» rowVersion

integer(int64)

false

none

none

»»»»»»»» table

string¦null

false

none

none

»»»»»»»» queryDefinitionRight

any

false

none

none

»»»»»»» trueValue

any

false

none

none

»»»»»»» falseValue

any

false

none

none

»»»»»»» isDate

boolean

false

none

none

»»»»»»» literalType

string

false

none

none

»»»»»»» value

any

false

none

none

»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»» trueValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»» falseValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»» isDate

boolean

false

none

none

»»»»»» literalType

string

false

none

none

»»»»»» value

any

false

none

none

»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»»» namespaceTable

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

none

»»»»»» m_namespace

string¦null

false

none

none

»»»»»» name

string¦null

false

none

none

»»»»» query

any

false

none

none

»»»»» alias

string¦null

false

none

none

»»»»» sourceType

string

false

none

none

»»»» joins

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

none

»»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»»» joinType

string

false

none

none

»»»»» onClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»»» constraintType

string

false

none

none

»»»»»» op

string¦null

false

none

none

»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»» caseSensitive

boolean

false

none

none

»»»»»» constraints

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

none

[DTO version of IConstraint]

»»»»»» literalRight

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»» right

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»» expressionLeft

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»» expressionRight

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»» like

string¦null

false

none

none

»»»»»» escapeWildcards

boolean

false

none

none

»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» queryDefinitionRight

any

false

none

none

»»»» whereClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»» order

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» column

string¦null

false

none

none

»»»»» direction

string

false

none

none

»»»» group

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» column

string¦null

false

none

none

»»»» havingClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»» distinct

boolean

false

none

none

»»»» unionWith

any

false

none

none

»»»» exceptWith

any

false

none

none

»»» sourceNames

object¦null

false

none

none

»»»» additionalProperties

string¦null

false

none

none

»» dependencies

[string]¦null

false

none

none

»» columns

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

none

»»» name

string¦null

false

none

none

»»» type

string

false

none

none

»»» isKey

boolean

false

none

none

»»» nullable

boolean

false

none

none

»»» values

string¦null

false

none

none

»»» lockedPeriod

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

none

»»»» start

string(date-time)

false

none

none

»»»» end

string(date-time)

false

none

none

»»» referencedCol

string¦null

false

none

none

»»» picklistFilter

string¦null

false

none

none

»»» displayName

string¦null

false

none

none

»»» isELTPeriod

boolean¦null

false

none

none

»» references

object¦null

false

none

none

»»» additionalProperties

string

false

none

none

»» timeReferences

object¦null

false

none

none

»»» additionalProperties

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

none

»»»» levelId

string¦null

false

none

none

»»»» timeId

string¦null

false

none

none

Enumerated Values

Property

Value

reportTaggingGroup

TagReportGroupAdminClient

reportTaggingGroup

TagReportGroupTabletAndWeb

reportTaggingGroup

None

dataType

Int

dataType

Decimal

dataType

DateTime

dataType

None

dataType

String

type

SelectAll

type

SelectItem

type

SelectLiteral

type

SelectCustom

type

SelectExpression

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

sourceType

Table

sourceType

Query

joinType

Inner

joinType

Left

joinType

Right

joinType

Cross

joinType

CrossApply

joinType

OuterApply

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

direction

Ascending

direction

Descending

direction

AscendingNullsFirst

direction

DescendingNullsLast

type

String

type

LongString

type

MaxString

type

Date

type

DateTime

type

Decimal

type

Int

type

Long

type

Float

type

BLOB

type

Identity

type

CLOB

type

RowVersion

type

UID

type

VarCharMax

type

Boolean

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/pulsereports/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/pulsereports/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "name": "string",
  "sourceDefinition": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "dependencies": [
    "string"
  ],
  "columns": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "references": {
    "property1": "string",
    "property2": "string"
  },
  "timeReferences": {
    "property1": {
      "levelId": "string",
      "timeId": "string"
    },
    "property2": {
      "levelId": "string",
      "timeId": "string"
    }
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/pulsereports/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/pulsereports/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/pulsereports/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

Return pulse tag mapping preview.

Body parameter

{
  "planId": 0,
  "tagType": "Transactions",
  "restrictionQuery": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  }
}

Parameters

Name

In

Type

Required

Description

offset

query

integer(int32)

false

none

limit

query

integer(int32)

false

none

orderBy

query

string

false

none

filter

query

string

false

none

body

body

Varicent.RESTAPI.v1.DTOs.Preview.PulseTagPreviewStateDTO

false

none

» planId

body

integer(int32)

false

none

» tagType

body

string

false

none

» restrictionQuery

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»» alias

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» table

body

string¦null

false

none

»»»» customSelect

body

string¦null

false

none

»»»» dataType

body

string

false

none

»»»» type

body

string

false

none

»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»» expressionType

body

string

false

none

»»»»»» cases

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» arguments

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»» constraintType

body

string

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» condition

body

any

false

none

»»»»»»»» trueValue

body

any

false

none

»»»»»»»» falseValue

body

any

false

none

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»» constraints

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» literalRight

body

any

false

none

»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» right

body

any

false

none

»»»»»»» expressionLeft

body

any

false

none

»»»»»»» expressionRight

body

any

false

none

»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»» like

body

string¦null

false

none

»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»» trueValue

body

any

false

none

»»»»»» falseValue

body

any

false

none

»»»»»» isDate

body

boolean

false

none

»»»»»» literalType

body

string

false

none

»»»»»» value

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»» m_namespace

body

string¦null

false

none

»»»»» name

body

string¦null

false

none

»»»» query

body

any

false

none

»»»» alias

body

string¦null

false

none

»»»» sourceType

body

string

false

none

»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» joinType

body

string

false

none

»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» constraintType

body

string

false

none

»»»»» op

body

string¦null

false

none

»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» caseSensitive

body

boolean

false

none

»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isPreciseDecimal

body

boolean

false

none

»»»»» like

body

string¦null

false

none

»»»»» escapeWildcards

body

boolean

false

none

»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»» table

body

string¦null

false

none

»»»»» queryDefinitionRight

body

any

false

none

»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» direction

body

string

false

none

»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» distinct

body

boolean

false

none

»»» unionWith

body

any

false

none

»»» exceptWith

body

any

false

none

»» sourceNames

body

object¦null

false

none

»»» additionalProperties

body

string¦null

false

none

Enumerated Values

Parameter

Value

» tagType

Transactions

» tagType

CreditedTransactions

» tagType

QualifiedTransactions

» tagType

Earnings

» tagType

Commission

» tagType

Bonus

» tagType

ManualPayoutAdjustments

» tagType

QuotaTargets

» tagType

Guarantees

» tagType

Actuals

» tagType

ClubQualification

» tagType

Performance

» tagType

PerformanceYTD

» tagType

PayeeAttributes

» tagType

Threshold

» tagType

BalanceCarry

» tagType

Plan

» tagType

Territory

» tagType

TransactionMapping

» tagType

Projected

» tagType

ScenarioResults

» tagType

ICMDates

» tagType

Roles

» tagType

BenchmarkMapping

» tagType

PayeeInfo

» tagType

Payment

»»»» dataType

Int

»»»» dataType

Decimal

»»»» dataType

DateTime

»»»» dataType

None

»»»» dataType

String

»»»» type

SelectAll

»»»» type

SelectItem

»»»» type

SelectLiteral

»»»» type

SelectCustom

»»»» type

SelectExpression

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» expressionType

caseExpression

»»»»»» expressionType

dataField

»»»»»» expressionType

function

»»»»»» expressionType

ifExpression

»»»»»» expressionType

literal

»»»»»»» constraintType

clause

»»»»»»» constraintType

constraint

»»»»»»» constraintType

expressionConstraint

»»»»»»» constraintType

likeConstraint

»»»»»»» constraintType

rowVersionConstraint

»»»»»»» constraintType

subQueryConstraint

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»» literalType

Integer

»»»»»» literalType

Decimal

»»»»»» literalType

Date

»»»»»» literalType

DateTime

»»»»»» literalType

String

»»»»»» literalType

Float

»»»»»» literalType

Long

»»»»»» literalType

Null

»»»»»» literalType

Parameter

»»»»»» literalType

Guid

»»»»»» literalType

SystemUtcTime

»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» sourceType

Table

»»»» sourceType

Query

»»»» joinType

Inner

»»»» joinType

Left

»»»» joinType

Right

»»»» joinType

Cross

»»»» joinType

CrossApply

»»»» joinType

OuterApply

»»»»» constraintType

clause

»»»»» constraintType

constraint

»»»»» constraintType

expressionConstraint

»»»»» constraintType

likeConstraint

»»»»» constraintType

rowVersionConstraint

»»»»» constraintType

subQueryConstraint

»»»» direction

Ascending

»»»» direction

Descending

»»»» direction

AscendingNullsFirst

»»»» direction

DescendingNullsLast

Responses

Status

Meaning

Description

Schema

200

OK

Return pulse tag mapping preview

Varicent.RESTAPI.v1.DTOs.ResultSetDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/pulsetagmappingpreview", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/pulsetagmappingpreview");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "planId": 0,
  "tagType": "Transactions",
  "restrictionQuery": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/pulsetagmappingpreview',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/pulsetagmappingpreview', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/pulsetagmappingpreview',
  params: {
  }, headers: headers

p JSON.parse(result)

PulsePlansControllerV1_GetBenchmarkTypes

Parameters

Name

In

Type

Required

Description

id

path

string

true

none

Enumerated Values

Parameter

Value

id

Undefined

id

TransactionsProductionsResults

id

CompensationSummary

id

PerformanceReport

id

SalesManagerOverview

id

Overview

id

PayeePerformanceReport

id

PerformanceOTE

id

SalesVsAttainment

id

PerformanceDistribution

id

PerformanceDistributionByRole

id

PayDistribution

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/pulsereports/{id}/benchmarks", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/pulsereports/{id}/benchmarks");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/pulsereports/{id}/benchmarks',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.get('http://localhost:8080/api/v1/pulsereports/{id}/benchmarks')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.get 'http://localhost:8080/api/v1/pulsereports/{id}/benchmarks',
  params: {
  }

p JSON.parse(result)

PulsePlansControllerV1_GetBenchmarkData

Parameters

Name

In

Type

Required

Description

id

path

string

true

none

source

path

string

true

none

Enumerated Values

Parameter

Value

id

Undefined

id

TransactionsProductionsResults

id

CompensationSummary

id

PerformanceReport

id

SalesManagerOverview

id

Overview

id

PayeePerformanceReport

id

PerformanceOTE

id

SalesVsAttainment

id

PerformanceDistribution

id

PerformanceDistributionByRole

id

PayDistribution

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/pulsereports/{id}/benchmarks/{source}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/pulsereports/{id}/benchmarks/{source}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/pulsereports/{id}/benchmarks/{source}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.get('http://localhost:8080/api/v1/pulsereports/{id}/benchmarks/{source}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.get 'http://localhost:8080/api/v1/pulsereports/{id}/benchmarks/{source}',
  params: {
  }

p JSON.parse(result)

ElementWrap

Wrap the given elements.

Body parameter

{
  "newBlockName": "string",
  "elementIDs": [
    0
  ],
  "parentBlockID": 0,
  "location": {
    "x": 0.1,
    "y": 0.1
  },
  "elementSubType": "None"
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Composer.ElementWrapDTO

false

Elements

» newBlockName

body

string¦null

false

none

» elementIDs

body

[integer]¦null

false

none

» parentBlockID

body

integer(int32)

false

none

» location

body

System.Drawing.PointF

false

none

»» isEmpty

body

boolean

false

none

»» x

body

number(float)

false

none

»» y

body

number(float)

false

none

» elementSubType

body

string

false

none

Enumerated Values

Parameter

Value

» elementSubType

None

» elementSubType

InsertionPoint

» elementSubType

Waypoint

Responses

Status

Meaning

Description

Schema

200

OK

Wrap elements

Varicent.RESTAPI.v1.DTOs.BlockElementDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/composer/wrap", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/composer/wrap");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "newBlockName": "string",
  "elementIDs": [
    0
  ],
  "parentBlockID": 0,
  "location": {
    "x": 0.1,
    "y": 0.1
  },
  "elementSubType": "None"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/composer/wrap',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/composer/wrap', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/composer/wrap',
  params: {
  }, headers: headers

p JSON.parse(result)

Unwrap the given blocks.

Body parameter

{
  "blockIDs": [
    0
  ],
  "parentBlockID": 0,
  "location": {
    "x": 0.1,
    "y": 0.1
  }
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Composer.ElementUnwrapDTO

false

Blocks

» blockIDs

body

[integer]¦null

false

none

» parentBlockID

body

integer(int32)

false

none

» location

body

System.Drawing.PointF

false

none

»» isEmpty

body

boolean

false

none

»» x

body

number(float)

false

none

»» y

body

number(float)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Wrap elements

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/composer/unwrap", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/composer/unwrap");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "blockIDs": [
    0
  ],
  "parentBlockID": 0,
  "location": {
    "x": 0.1,
    "y": 0.1
  }
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/composer/unwrap',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/composer/unwrap', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/composer/unwrap',
  params: {
  }, headers: headers

p JSON.parse(result)

Payee

Get payee names of given payee ids.

Parameters

Name

In

Type

Required

Description

payeeIds

query

array[string]

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.PayeeNameDTO]

false

none

none

» name

string¦null

false

none

none

» id

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/payee/payeeNames", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payee/payeeNames");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/payee/payeeNames',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/payee/payeeNames', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/payee/payeeNames',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "name": "string",
    "id": "string"
  }
]
[{"name":"string","id":"string"}]

UsersControllerV1_GetPayeeProfilePicture

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.PayeeProfilePictureDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/payee/payeeProfilePicture", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payee/payeeProfilePicture");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/payee/payeeProfilePicture',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/payee/payeeProfilePicture', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/payee/payeeProfilePicture',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "payeeID": "string",
  "image": "string"
}
{"payeeID":"string","image":"string"}

UsersControllerV1_PostPayeeProfilePicture

Body parameter

{
  "payeeID": "string",
  "image": "string"
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.PayeeProfilePictureDTO

false

none

» payeeID

body

string¦null

false

none

» image

body

string(byte)¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/payee/payeeProfilePicture", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payee/payeeProfilePicture");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "payeeID": "string",
  "image": "string"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/payee/payeeProfilePicture',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/payee/payeeProfilePicture', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/payee/payeeProfilePicture',
  params: {
  }, headers: headers

p JSON.parse(result)

UsersControllerV1_DeletePayeeProfilePicture

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/payee/payeeProfilePicture", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payee/payeeProfilePicture");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/payee/payeeProfilePicture',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/payee/payeeProfilePicture')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/payee/payeeProfilePicture',
  params: {
  }

p JSON.parse(result)

UsersControllerV1_GetPayeeProfilePictureFromID

Parameters

Name

In

Type

Required

Description

id

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.PayeeImageDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/payee/payeeProfilePicture/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payee/payeeProfilePicture/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/payee/payeeProfilePicture/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/payee/payeeProfilePicture/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/payee/payeeProfilePicture/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "name": "string",
  "payeeID": "string",
  "image": "string"
}
{"name":"string","payeeID":"string","image":"string"}

UsersControllerV1_GetPayeeProfilePicturesFromIDs

Parameters

Name

In

Type

Required

Description

payeeIds

query

array[string]

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.PayeeImageDTO]

false

none

none

» name

string¦null

false

none

none

» payeeID

string¦null

false

none

none

» image

string(byte)¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/payee/payeeProfilePictures", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payee/payeeProfilePictures");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/payee/payeeProfilePictures',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/payee/payeeProfilePictures', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/payee/payeeProfilePictures',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "name": "string",
    "payeeID": "string",
    "image": "string"
  }
]
[{"name":"string","payeeID":"string","image":"string"}]

Payee Group

Get payee group names.

Responses

Status

Meaning

Description

Schema

200

OK

Get all Payee Groups

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Payee.PayeeGroupNameDTO]

false

none

none

» name

string¦null

false

none

none

» id

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/payeegroups", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payeegroups");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/payeegroups',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/payeegroups', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/payeegroups',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "name": "string",
    "id": "string"
  }
]
[{"name":"string","id":"string"}]

Add a payee group

Body parameter

{
  "group": {
    "name": "string",
    "id": "string"
  },
  "members": [
    {
      "payeeId": "string",
      "name": "string",
      "starting": "2019-08-24T14:15:22Z",
      "ending": "2019-08-24T14:15:22Z"
    }
  ]
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Payee.PayeeGroupDTO

false

none

» group

body

Varicent.RESTAPI.v1.DTOs.Payee.PayeeGroupNameDTO

false

none

»» name

body

string¦null

false

none

»» id

body

string¦null

false

none

» members

body

[Varicent.RESTAPI.v1.DTOs.Payee.GroupMemberDTO]¦null

false

none

»» payeeId

body

string¦null

false

none

»» name

body

string¦null

false

none

»» starting

body

string(date-time)

false

none

»» ending

body

string(date-time)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Add Payee Group

Varicent.RESTAPI.v1.DTOs.Payee.PayeeGroupDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/payeegroups", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payeegroups");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "group": {
    "name": "string",
    "id": "string"
  },
  "members": [
    {
      "payeeId": "string",
      "name": "string",
      "starting": "2019-08-24T14:15:22Z",
      "ending": "2019-08-24T14:15:22Z"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/payeegroups',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/payeegroups', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/payeegroups',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "group": {
    "name": "string",
    "id": "string"
  },
  "members": [
    {
      "payeeId": "string",
      "name": "string",
      "starting": "2019-08-24T14:15:22Z",
      "ending": "2019-08-24T14:15:22Z"
    }
  ]
}
{"group":{"name":"string","id":"string"},"members":[{"payeeId":"string","name":"string","starting":"2019-08-24T14:15:22Z","ending":"2019-08-24T14:15:22Z"}]}

Get a payee group by ID.

Parameters

Name

In

Type

Required

Description

id

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get Payee Group by Id

Varicent.RESTAPI.v1.DTOs.Payee.PayeeGroupDTO

404

Not Found

Payee group not found

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/payeegroups/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payeegroups/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/payeegroups/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/payeegroups/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/payeegroups/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "group": {
    "name": "string",
    "id": "string"
  },
  "members": [
    {
      "payeeId": "string",
      "name": "string",
      "starting": "2019-08-24T14:15:22Z",
      "ending": "2019-08-24T14:15:22Z"
    }
  ]
}
{"group":{"name":"string","id":"string"},"members":[{"payeeId":"string","name":"string","starting":"2019-08-24T14:15:22Z","ending":"2019-08-24T14:15:22Z"}]}

Update a payee group.

Body parameter

{
  "group": {
    "name": "string",
    "id": "string"
  },
  "members": [
    {
      "payeeId": "string",
      "name": "string",
      "starting": "2019-08-24T14:15:22Z",
      "ending": "2019-08-24T14:15:22Z"
    }
  ]
}

Parameters

Name

In

Type

Required

Description

id

path

string

true

none

body

body

Varicent.RESTAPI.v1.DTOs.Payee.PayeeGroupDTO

false

none

» group

body

Varicent.RESTAPI.v1.DTOs.Payee.PayeeGroupNameDTO

false

none

»» name

body

string¦null

false

none

»» id

body

string¦null

false

none

» members

body

[Varicent.RESTAPI.v1.DTOs.Payee.GroupMemberDTO]¦null

false

none

»» payeeId

body

string¦null

false

none

»» name

body

string¦null

false

none

»» starting

body

string(date-time)

false

none

»» ending

body

string(date-time)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Update Payee Group

Varicent.RESTAPI.v1.DTOs.Payee.PayeeGroupDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/payeegroups/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payeegroups/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "group": {
    "name": "string",
    "id": "string"
  },
  "members": [
    {
      "payeeId": "string",
      "name": "string",
      "starting": "2019-08-24T14:15:22Z",
      "ending": "2019-08-24T14:15:22Z"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/payeegroups/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/payeegroups/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/payeegroups/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "group": {
    "name": "string",
    "id": "string"
  },
  "members": [
    {
      "payeeId": "string",
      "name": "string",
      "starting": "2019-08-24T14:15:22Z",
      "ending": "2019-08-24T14:15:22Z"
    }
  ]
}
{"group":{"name":"string","id":"string"},"members":[{"payeeId":"string","name":"string","starting":"2019-08-24T14:15:22Z","ending":"2019-08-24T14:15:22Z"}]}

Add payees to a payee group.

Body parameter

{
  "group": {
    "name": "string",
    "id": "string"
  },
  "members": [
    {
      "payeeId": "string",
      "name": "string",
      "starting": "2019-08-24T14:15:22Z",
      "ending": "2019-08-24T14:15:22Z"
    }
  ]
}

Parameters

Name

In

Type

Required

Description

id

path

string

true

none

body

body

Varicent.RESTAPI.v1.DTOs.Payee.PayeeGroupDTO

false

none

» group

body

Varicent.RESTAPI.v1.DTOs.Payee.PayeeGroupNameDTO

false

none

»» name

body

string¦null

false

none

»» id

body

string¦null

false

none

» members

body

[Varicent.RESTAPI.v1.DTOs.Payee.GroupMemberDTO]¦null

false

none

»» payeeId

body

string¦null

false

none

»» name

body

string¦null

false

none

»» starting

body

string(date-time)

false

none

»» ending

body

string(date-time)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Add payees to Payee Group

Varicent.RESTAPI.v1.DTOs.Payee.PayeeGroupDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/payeegroups/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payeegroups/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "group": {
    "name": "string",
    "id": "string"
  },
  "members": [
    {
      "payeeId": "string",
      "name": "string",
      "starting": "2019-08-24T14:15:22Z",
      "ending": "2019-08-24T14:15:22Z"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/payeegroups/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/payeegroups/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/payeegroups/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "group": {
    "name": "string",
    "id": "string"
  },
  "members": [
    {
      "payeeId": "string",
      "name": "string",
      "starting": "2019-08-24T14:15:22Z",
      "ending": "2019-08-24T14:15:22Z"
    }
  ]
}
{"group":{"name":"string","id":"string"},"members":[{"payeeId":"string","name":"string","starting":"2019-08-24T14:15:22Z","ending":"2019-08-24T14:15:22Z"}]}

Delete a payee group.

Parameters

Name

In

Type

Required

Description

id

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Delete Payee Group by Id

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/payeegroups/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payeegroups/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/payeegroups/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/payeegroups/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/payeegroups/{id}',
  params: {
  }

p JSON.parse(result)

Add a payee group by query.

Body parameter

{
  "group": {
    "name": "string",
    "id": "string"
  },
  "query": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z",
  "excludeList": [
    "string"
  ]
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Payee.PayeeGroupDefinitionDTO

false

none

» group

body

Varicent.RESTAPI.v1.DTOs.Payee.PayeeGroupNameDTO

false

none

»» name

body

string¦null

false

none

»» id

body

string¦null

false

none

» query

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»» alias

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» table

body

string¦null

false

none

»»»» customSelect

body

string¦null

false

none

»»»» dataType

body

string

false

none

»»»» type

body

string

false

none

»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»» expressionType

body

string

false

none

»»»»»» cases

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» arguments

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»» constraintType

body

string

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» condition

body

any

false

none

»»»»»»»» trueValue

body

any

false

none

»»»»»»»» falseValue

body

any

false

none

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»» constraints

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» literalRight

body

any

false

none

»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» right

body

any

false

none

»»»»»»» expressionLeft

body

any

false

none

»»»»»»» expressionRight

body

any

false

none

»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»» like

body

string¦null

false

none

»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»» trueValue

body

any

false

none

»»»»»» falseValue

body

any

false

none

»»»»»» isDate

body

boolean

false

none

»»»»»» literalType

body

string

false

none

»»»»»» value

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»» m_namespace

body

string¦null

false

none

»»»»» name

body

string¦null

false

none

»»»» query

body

any

false

none

»»»» alias

body

string¦null

false

none

»»»» sourceType

body

string

false

none

»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» joinType

body

string

false

none

»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» constraintType

body

string

false

none

»»»»» op

body

string¦null

false

none

»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» caseSensitive

body

boolean

false

none

»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isPreciseDecimal

body

boolean

false

none

»»»»» like

body

string¦null

false

none

»»»»» escapeWildcards

body

boolean

false

none

»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»» table

body

string¦null

false

none

»»»»» queryDefinitionRight

body

any

false

none

»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» direction

body

string

false

none

»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» distinct

body

boolean

false

none

»»» unionWith

body

any

false

none

»»» exceptWith

body

any

false

none

»» sourceNames

body

object¦null

false

none

»»» additionalProperties

body

string¦null

false

none

» start

body

string(date-time)

false

none

» end

body

string(date-time)

false

none

» excludeList

body

[string]¦null

false

none

Enumerated Values

Parameter

Value

»»»» dataType

Int

»»»» dataType

Decimal

»»»» dataType

DateTime

»»»» dataType

None

»»»» dataType

String

»»»» type

SelectAll

»»»» type

SelectItem

»»»» type

SelectLiteral

»»»» type

SelectCustom

»»»» type

SelectExpression

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» expressionType

caseExpression

»»»»»» expressionType

dataField

»»»»»» expressionType

function

»»»»»» expressionType

ifExpression

»»»»»» expressionType

literal

»»»»»»» constraintType

clause

»»»»»»» constraintType

constraint

»»»»»»» constraintType

expressionConstraint

»»»»»»» constraintType

likeConstraint

»»»»»»» constraintType

rowVersionConstraint

»»»»»»» constraintType

subQueryConstraint

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»» literalType

Integer

»»»»»» literalType

Decimal

»»»»»» literalType

Date

»»»»»» literalType

DateTime

»»»»»» literalType

String

»»»»»» literalType

Float

»»»»»» literalType

Long

»»»»»» literalType

Null

»»»»»» literalType

Parameter

»»»»»» literalType

Guid

»»»»»» literalType

SystemUtcTime

»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» sourceType

Table

»»»» sourceType

Query

»»»» joinType

Inner

»»»» joinType

Left

»»»» joinType

Right

»»»» joinType

Cross

»»»» joinType

CrossApply

»»»» joinType

OuterApply

»»»»» constraintType

clause

»»»»» constraintType

constraint

»»»»» constraintType

expressionConstraint

»»»»» constraintType

likeConstraint

»»»»» constraintType

rowVersionConstraint

»»»»» constraintType

subQueryConstraint

»»»» direction

Ascending

»»»» direction

Descending

»»»» direction

AscendingNullsFirst

»»»» direction

DescendingNullsLast

Responses

Status

Meaning

Description

Schema

200

OK

Add Payee Group

Varicent.RESTAPI.v1.DTOs.Payee.PayeeGroupDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/payeegroups", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/payeegroups");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "group": {
    "name": "string",
    "id": "string"
  },
  "query": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z",
  "excludeList": [
    "string"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/payeegroups',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/payeegroups', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/payeegroups',
  params: {
  }, headers: headers

p JSON.parse(result)

Update a payee group by query.

Body parameter

{
  "group": {
    "name": "string",
    "id": "string"
  },
  "query": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z",
  "excludeList": [
    "string"
  ]
}

Parameters

Name

In

Type

Required

Description

id

path

string

true

none

body

body

Varicent.RESTAPI.v1.DTOs.Payee.PayeeGroupDefinitionDTO

false

none

» group

body

Varicent.RESTAPI.v1.DTOs.Payee.PayeeGroupNameDTO

false

none

»» name

body

string¦null

false

none

»» id

body

string¦null

false

none

» query

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»» alias

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» table

body

string¦null

false

none

»»»» customSelect

body

string¦null

false

none

»»»» dataType

body

string

false

none

»»»» type

body

string

false

none

»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»» expressionType

body

string

false

none

»»»»»» cases

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» arguments

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»» constraintType

body

string

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» condition

body

any

false

none

»»»»»»»» trueValue

body

any

false

none

»»»»»»»» falseValue

body

any

false

none

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»» constraints

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» literalRight

body

any

false

none

»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» right

body

any

false

none

»»»»»»» expressionLeft

body

any

false

none

»»»»»»» expressionRight

body

any

false

none

»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»» like

body

string¦null

false

none

»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»» trueValue

body

any

false

none

»»»»»» falseValue

body

any

false

none

»»»»»» isDate

body

boolean

false

none

»»»»»» literalType

body

string

false

none

»»»»»» value

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»» m_namespace

body

string¦null

false

none

»»»»» name

body

string¦null

false

none

»»»» query

body

any

false

none

»»»» alias

body

string¦null

false

none

»»»» sourceType

body

string

false

none

»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» joinType

body

string

false

none

»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» constraintType

body

string

false

none

»»»»» op

body

string¦null

false

none

»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» caseSensitive

body

boolean

false

none

»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isPreciseDecimal

body

boolean

false

none

»»»»» like

body

string¦null

false

none

»»»»» escapeWildcards

body

boolean

false

none

»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»» table

body

string¦null

false

none

»»»»» queryDefinitionRight

body

any

false

none

»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» direction

body

string

false

none

»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» distinct

body

boolean

false

none

»»» unionWith

body

any

false

none

»»» exceptWith

body

any

false

none

»» sourceNames

body

object¦null

false

none

»»» additionalProperties

body

string¦null

false

none

» start

body

string(date-time)

false

none

» end

body

string(date-time)

false

none

» excludeList

body

[string]¦null

false

none

Enumerated Values

Parameter

Value

»»»» dataType

Int

»»»» dataType

Decimal

»»»» dataType

DateTime

»»»» dataType

None

»»»» dataType

String

»»»» type

SelectAll

»»»» type

SelectItem

»»»» type

SelectLiteral

»»»» type

SelectCustom

»»»» type

SelectExpression

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» expressionType

caseExpression

»»»»»» expressionType

dataField

»»»»»» expressionType

function

»»»»»» expressionType

ifExpression

»»»»»» expressionType

literal

»»»»»»» constraintType

clause

»»»»»»» constraintType

constraint

»»»»»»» constraintType

expressionConstraint

»»»»»»» constraintType

likeConstraint

»»»»»»» constraintType

rowVersionConstraint

»»»»»»» constraintType

subQueryConstraint

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»» literalType

Integer

»»»»»» literalType

Decimal

»»»»»» literalType

Date

»»»»»» literalType

DateTime

»»»»»» literalType

String

»»»»»» literalType

Float

»»»»»» literalType

Long

»»»»»» literalType

Null

»»»»»» literalType

Parameter

»»»»»» literalType

Guid

»»»»»» literalType

SystemUtcTime

»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» sourceType

Table

»»»» sourceType

Query

»»»» joinType

Inner

»»»» joinType

Left

»»»» joinType

Right

»»»» joinType

Cross

»»»» joinType

CrossApply

»»»» joinType

OuterApply

»»»»» constraintType

clause

»»»»» constraintType

constraint

»»»»» constraintType

expressionConstraint

»»»»» constraintType

likeConstraint

»»»»» constraintType

rowVersionConstraint

»»»»» constraintType

subQueryConstraint

»»»» direction

Ascending

»»»» direction

Descending

»»»» direction

AscendingNullsFirst

»»»» direction

DescendingNullsLast

Responses

Status

Meaning

Description

Schema

200

OK

Update Payee Group

Varicent.RESTAPI.v1.DTOs.Payee.PayeeGroupDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/rpc/payeegroups/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/payeegroups/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "group": {
    "name": "string",
    "id": "string"
  },
  "query": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z",
  "excludeList": [
    "string"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/payeegroups/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/rpc/payeegroups/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/rpc/payeegroups/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

Add payees to a payee group by query.

Body parameter

{
  "group": {
    "name": "string",
    "id": "string"
  },
  "query": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z",
  "excludeList": [
    "string"
  ]
}

Parameters

Name

In

Type

Required

Description

id

path

string

true

none

body

body

Varicent.RESTAPI.v1.DTOs.Payee.PayeeGroupDefinitionDTO

false

none

» group

body

Varicent.RESTAPI.v1.DTOs.Payee.PayeeGroupNameDTO

false

none

»» name

body

string¦null

false

none

»» id

body

string¦null

false

none

» query

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»» alias

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» table

body

string¦null

false

none

»»»» customSelect

body

string¦null

false

none

»»»» dataType

body

string

false

none

»»»» type

body

string

false

none

»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»» expressionType

body

string

false

none

»»»»»» cases

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» arguments

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»» constraintType

body

string

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» condition

body

any

false

none

»»»»»»»» trueValue

body

any

false

none

»»»»»»»» falseValue

body

any

false

none

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»» constraints

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» literalRight

body

any

false

none

»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» right

body

any

false

none

»»»»»»» expressionLeft

body

any

false

none

»»»»»»» expressionRight

body

any

false

none

»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»» like

body

string¦null

false

none

»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»» trueValue

body

any

false

none

»»»»»» falseValue

body

any

false

none

»»»»»» isDate

body

boolean

false

none

»»»»»» literalType

body

string

false

none

»»»»»» value

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»» m_namespace

body

string¦null

false

none

»»»»» name

body

string¦null

false

none

»»»» query

body

any

false

none

»»»» alias

body

string¦null

false

none

»»»» sourceType

body

string

false

none

»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» joinType

body

string

false

none

»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» constraintType

body

string

false

none

»»»»» op

body

string¦null

false

none

»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» caseSensitive

body

boolean

false

none

»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isPreciseDecimal

body

boolean

false

none

»»»»» like

body

string¦null

false

none

»»»»» escapeWildcards

body

boolean

false

none

»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»» table

body

string¦null

false

none

»»»»» queryDefinitionRight

body

any

false

none

»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» direction

body

string

false

none

»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» distinct

body

boolean

false

none

»»» unionWith

body

any

false

none

»»» exceptWith

body

any

false

none

»» sourceNames

body

object¦null

false

none

»»» additionalProperties

body

string¦null

false

none

» start

body

string(date-time)

false

none

» end

body

string(date-time)

false

none

» excludeList

body

[string]¦null

false

none

Enumerated Values

Parameter

Value

»»»» dataType

Int

»»»» dataType

Decimal

»»»» dataType

DateTime

»»»» dataType

None

»»»» dataType

String

»»»» type

SelectAll

»»»» type

SelectItem

»»»» type

SelectLiteral

»»»» type

SelectCustom

»»»» type

SelectExpression

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» expressionType

caseExpression

»»»»»» expressionType

dataField

»»»»»» expressionType

function

»»»»»» expressionType

ifExpression

»»»»»» expressionType

literal

»»»»»»» constraintType

clause

»»»»»»» constraintType

constraint

»»»»»»» constraintType

expressionConstraint

»»»»»»» constraintType

likeConstraint

»»»»»»» constraintType

rowVersionConstraint

»»»»»»» constraintType

subQueryConstraint

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»» literalType

Integer

»»»»»» literalType

Decimal

»»»»»» literalType

Date

»»»»»» literalType

DateTime

»»»»»» literalType

String

»»»»»» literalType

Float

»»»»»» literalType

Long

»»»»»» literalType

Null

»»»»»» literalType

Parameter

»»»»»» literalType

Guid

»»»»»» literalType

SystemUtcTime

»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» sourceType

Table

»»»» sourceType

Query

»»»» joinType

Inner

»»»» joinType

Left

»»»» joinType

Right

»»»» joinType

Cross

»»»» joinType

CrossApply

»»»» joinType

OuterApply

»»»»» constraintType

clause

»»»»» constraintType

constraint

»»»»» constraintType

expressionConstraint

»»»»» constraintType

likeConstraint

»»»»» constraintType

rowVersionConstraint

»»»»» constraintType

subQueryConstraint

»»»» direction

Ascending

»»»» direction

Descending

»»»» direction

AscendingNullsFirst

»»»» direction

DescendingNullsLast

Responses

Status

Meaning

Description

Schema

200

OK

Add payees to Payee Group

Varicent.RESTAPI.v1.DTOs.Payee.PayeeGroupDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/rpc/payeegroups/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/payeegroups/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "group": {
    "name": "string",
    "id": "string"
  },
  "query": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z",
  "excludeList": [
    "string"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/payeegroups/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/rpc/payeegroups/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/rpc/payeegroups/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

PayeeGroupsControllerV1_UpdatePayeeGroupDates

Body parameter

{
  "group": {
    "name": "string",
    "id": "string"
  },
  "payeeID": "string",
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z",
  "startUpdated": "2019-08-24T14:15:22Z",
  "endUpdated": "2019-08-24T14:15:22Z"
}

Parameters

Name

In

Type

Required

Description

id

path

string

true

none

body

body

Varicent.RESTAPI.v1.DTOs.Payee.PayeeGroupDatesDTO

false

none

» group

body

Varicent.RESTAPI.v1.DTOs.Payee.PayeeGroupNameDTO

false

none

»» name

body

string¦null

false

none

»» id

body

string¦null

false

none

» payeeID

body

string¦null

false

none

» start

body

string(date-time)

false

none

» end

body

string(date-time)

false

none

» startUpdated

body

string(date-time)

false

none

» endUpdated

body

string(date-time)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Update Payee Group Dates

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/payeegroups/{id}/updateDates", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payeegroups/{id}/updateDates");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "group": {
    "name": "string",
    "id": "string"
  },
  "payeeID": "string",
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z",
  "startUpdated": "2019-08-24T14:15:22Z",
  "endUpdated": "2019-08-24T14:15:22Z"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/payeegroups/{id}/updateDates',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/payeegroups/{id}/updateDates', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/payeegroups/{id}/updateDates',
  params: {
  }, headers: headers

p JSON.parse(result)

WebDataEdit

View edit column permissions.

Parameters

Name

In

Type

Required

Description

table

path

string

true

Table Name

offset

query

integer(int32)

false

none

limit

query

integer(int32)

false

none

filter

query

string

false

none

fields

query

string

false

none

unique

query

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.ResultSetDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/webdataedit/{table}/editcolumnpermissions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webdataedit/{table}/editcolumnpermissions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webdataedit/{table}/editcolumnpermissions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/webdataedit/{table}/editcolumnpermissions', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/webdataedit/{table}/editcolumnpermissions',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "columnDefinitions": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "data": [
    null
  ],
  "columnSourceMap": {
    "property1": "string",
    "property2": "string"
  },
  "isDataSynced": true,
  "hierarchyMetadata": {
    "tableName": "string",
    "idColumnName": "string",
    "parentColumnName": "string"
  }
}
{"columnDefinitions":[{"name":"string","type":"String","isKey":true,"nullable":true,"values":"string","lockedPeriod":{},"referencedCol":"string","picklistFilter":"string","displayName":"string","isELTPeriod":true}],"data":[null],"columnSourceMap":{"property1":"string","property2":"string"},"isDataSynced":true,"hierarchyMetadata":{"tableName":"string","idColumnName":"string","parentColumnName":"string"}}

Edit column permissions.

Body parameter

[
  {
    "column": "string",
    "payeeID": "string",
    "isEnabled": true
  }
]

Parameters

Name

In

Type

Required

Description

table

path

string

true

Table Name

body

body

RESTAPI.v1.DTOs.Composer.WebDataEditPermissionDTO

false

Permission update for each payee and table column

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/webdataedit/{table}/editcolumnpermissions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webdataedit/{table}/editcolumnpermissions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "column": "string",
    "payeeID": "string",
    "isEnabled": true
  }
]';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/webdataedit/{table}/editcolumnpermissions',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/webdataedit/{table}/editcolumnpermissions', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/webdataedit/{table}/editcolumnpermissions',
  params: {
  }, headers: headers

p JSON.parse(result)

Enable a group of columns using given query definition, table, and column names.

Body parameter

{
  "queryDefinition": {
    "selectItems": [
      {}
    ],
    "source": {
      "namespaceTable": {},
      "query": null,
      "alias": "string",
      "sourceType": "Table"
    },
    "joins": [
      {}
    ],
    "whereClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "order": [
      {}
    ],
    "group": [
      {}
    ],
    "havingClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "distinct": true,
    "unionWith": null,
    "exceptWith": null
  },
  "table": {
    "version": {
      "rowVersion": 0
    },
    "name": "string",
    "tableType": "System",
    "effectiveDated": true,
    "workflowObjectID": 0,
    "hierarchyMetadata": {
      "tableName": "string",
      "idColumnName": "string",
      "parentColumnName": "string"
    },
    "lastUpdatedTracking": true
  },
  "columns": [
    "string"
  ]
}

Parameters

Name

In

Type

Required

Description

table

path

string

true

table name

body

body

Varicent.RESTAPI.v1.DTOs.Table.QueryTableColumnDTO

false

Query definition, table, column names

» queryDefinition

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»» alias

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» table

body

string¦null

false

none

»»» customSelect

body

string¦null

false

none

»»» dataType

body

string

false

none

»»» type

body

string

false

none

»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» expressionType

body

string

false

none

»»»» cases

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» op

body

string¦null

false

none

»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»» constraintType

body

string

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» expressionType

body

string

false

none

»»»»»»» cases

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» arguments

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» condition

body

any

false

none

»»»»»»» trueValue

body

any

false

none

»»»»»»» falseValue

body

any

false

none

»»»»»»» isDate

body

boolean

false

none

»»»»»»» literalType

body

string

false

none

»»»»»»» value

body

any

false

none

»»»»»» caseSensitive

body

boolean

false

none

»»»»»» constraints

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» literalRight

body

any

false

none

»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»» right

body

any

false

none

»»»»»» expressionLeft

body

any

false

none

»»»»»» expressionRight

body

any

false

none

»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»» like

body

string¦null

false

none

»»»»»» escapeWildcards

body

boolean

false

none

»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» queryDefinitionRight

body

any

false

none

»»»»» trueValue

body

any

false

none

»»»»» falseValue

body

any

false

none

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» isDate

body

boolean

false

none

»»»» literalType

body

string

false

none

»»»» value

body

any

false

none

»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»» m_namespace

body

string¦null

false

none

»»»» name

body

string¦null

false

none

»»» query

body

any

false

none

»»» alias

body

string¦null

false

none

»»» sourceType

body

string

false

none

»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»» joinType

body

string

false

none

»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»» constraintType

body

string

false

none

»»»» op

body

string¦null

false

none

»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» caseSensitive

body

boolean

false

none

»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» isPreciseDecimal

body

boolean

false

none

»»»» like

body

string¦null

false

none

»»»» escapeWildcards

body

boolean

false

none

»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»» table

body

string¦null

false

none

»»»» queryDefinitionRight

body

any

false

none

»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» direction

body

string

false

none

»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» distinct

body

boolean

false

none

»» unionWith

body

any

false

none

»» exceptWith

body

any

false

none

» table

body

Varicent.RESTAPI.v1.DTOs.CustomTableDTO

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» name

body

string¦null

false

none

»» tableType

body

string

false

none

»» effectiveDated

body

boolean

false

none

»» workflowObjectID

body

integer(int32)

false

none

»» hierarchyMetadata

body

RESTAPI.v1.DTOs.Hierarchy.HierarchyMetadataDTO

false

none

»»» tableName

body

string¦null

false

none

»»» idColumnName

body

string¦null

false

none

»»» parentColumnName

body

string¦null

false

none

»» lastUpdatedTracking

body

boolean¦null

false

none

» columns

body

[string]¦null

false

none

Enumerated Values

Parameter

Value

»»» dataType

Int

»»» dataType

Decimal

»»» dataType

DateTime

»»» dataType

None

»»» dataType

String

»»» type

SelectAll

»»» type

SelectItem

»»» type

SelectLiteral

»»» type

SelectCustom

»»» type

SelectExpression

»»»» expressionType

caseExpression

»»»» expressionType

dataField

»»»» expressionType

function

»»»» expressionType

ifExpression

»»»» expressionType

literal

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» constraintType

clause

»»»»»» constraintType

constraint

»»»»»» constraintType

expressionConstraint

»»»»»» constraintType

likeConstraint

»»»»»» constraintType

rowVersionConstraint

»»»»»» constraintType

subQueryConstraint

»»»»»»» expressionType

caseExpression

»»»»»»» expressionType

dataField

»»»»»»» expressionType

function

»»»»»»» expressionType

ifExpression

»»»»»»» expressionType

literal

»»»»»»» literalType

Integer

»»»»»»» literalType

Decimal

»»»»»»» literalType

Date

»»»»»»» literalType

DateTime

»»»»»»» literalType

String

»»»»»»» literalType

Float

»»»»»»» literalType

Long

»»»»»»» literalType

Null

»»»»»»» literalType

Parameter

»»»»»»» literalType

Guid

»»»»»»» literalType

SystemUtcTime

»»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» literalType

Integer

»»»» literalType

Decimal

»»»» literalType

Date

»»»» literalType

DateTime

»»»» literalType

String

»»»» literalType

Float

»»»» literalType

Long

»»»» literalType

Null

»»»» literalType

Parameter

»»»» literalType

Guid

»»»» literalType

SystemUtcTime

»»»» literalType

Boolean

»»» sourceType

Table

»»» sourceType

Query

»»» joinType

Inner

»»» joinType

Left

»»» joinType

Right

»»» joinType

Cross

»»» joinType

CrossApply

»»» joinType

OuterApply

»»»» constraintType

clause

»»»» constraintType

constraint

»»»» constraintType

expressionConstraint

»»»» constraintType

likeConstraint

»»»» constraintType

rowVersionConstraint

»»»» constraintType

subQueryConstraint

»»» direction

Ascending

»»» direction

Descending

»»» direction

AscendingNullsFirst

»»» direction

DescendingNullsLast

»» tableType

System

»» tableType

Dimension

»» tableType

Structural

»» tableType

Lookup

»» tableType

Data

»» tableType

View

»» tableType

Custom

»» tableType

StarSchema

»» tableType

ExportTable

»» tableType

CreditingRule

»» tableType

AssignTable

»» tableType

PlcmCustomTable

»» tableType

PlcmStructuralTable

»» tableType

PlcmTable

»» tableType

DataSource

»» tableType

Cached

»» tableType

MaterializedView

Responses

Status

Meaning

Description

Schema

200

OK

Enable a group of columns given query definition, table and column names

None

400

Bad Request

Table name in URL does not match given table

None

404

Not Found

Table does not exist

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/webdataedit/{table}/enablegroup", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webdataedit/{table}/enablegroup");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "queryDefinition": {
    "selectItems": [
      {}
    ],
    "source": {
      "namespaceTable": {},
      "query": null,
      "alias": "string",
      "sourceType": "Table"
    },
    "joins": [
      {}
    ],
    "whereClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "order": [
      {}
    ],
    "group": [
      {}
    ],
    "havingClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "distinct": true,
    "unionWith": null,
    "exceptWith": null
  },
  "table": {
    "version": {
      "rowVersion": 0
    },
    "name": "string",
    "tableType": "System",
    "effectiveDated": true,
    "workflowObjectID": 0,
    "hierarchyMetadata": {
      "tableName": "string",
      "idColumnName": "string",
      "parentColumnName": "string"
    },
    "lastUpdatedTracking": true
  },
  "columns": [
    "string"
  ]
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/webdataedit/{table}/enablegroup',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/webdataedit/{table}/enablegroup', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/webdataedit/{table}/enablegroup',
  params: {
  }, headers: headers

p JSON.parse(result)

Disable a group of columns using a given query definition, table, and column names.

Body parameter

{
  "queryDefinition": {
    "selectItems": [
      {}
    ],
    "source": {
      "namespaceTable": {},
      "query": null,
      "alias": "string",
      "sourceType": "Table"
    },
    "joins": [
      {}
    ],
    "whereClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "order": [
      {}
    ],
    "group": [
      {}
    ],
    "havingClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "distinct": true,
    "unionWith": null,
    "exceptWith": null
  },
  "table": {
    "version": {
      "rowVersion": 0
    },
    "name": "string",
    "tableType": "System",
    "effectiveDated": true,
    "workflowObjectID": 0,
    "hierarchyMetadata": {
      "tableName": "string",
      "idColumnName": "string",
      "parentColumnName": "string"
    },
    "lastUpdatedTracking": true
  },
  "columns": [
    "string"
  ]
}

Parameters

Name

In

Type

Required

Description

table

path

string

true

table name

body

body

Varicent.RESTAPI.v1.DTOs.Table.QueryTableColumnDTO

false

Query definition, table, column names

» queryDefinition

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»» alias

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» table

body

string¦null

false

none

»»» customSelect

body

string¦null

false

none

»»» dataType

body

string

false

none

»»» type

body

string

false

none

»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» expressionType

body

string

false

none

»»»» cases

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» op

body

string¦null

false

none

»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»» constraintType

body

string

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» expressionType

body

string

false

none

»»»»»»» cases

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» arguments

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» condition

body

any

false

none

»»»»»»» trueValue

body

any

false

none

»»»»»»» falseValue

body

any

false

none

»»»»»»» isDate

body

boolean

false

none

»»»»»»» literalType

body

string

false

none

»»»»»»» value

body

any

false

none

»»»»»» caseSensitive

body

boolean

false

none

»»»»»» constraints

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» literalRight

body

any

false

none

»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»» right

body

any

false

none

»»»»»» expressionLeft

body

any

false

none

»»»»»» expressionRight

body

any

false

none

»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»» like

body

string¦null

false

none

»»»»»» escapeWildcards

body

boolean

false

none

»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» queryDefinitionRight

body

any

false

none

»»»»» trueValue

body

any

false

none

»»»»» falseValue

body

any

false

none

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» isDate

body

boolean

false

none

»»»» literalType

body

string

false

none

»»»» value

body

any

false

none

»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»» m_namespace

body

string¦null

false

none

»»»» name

body

string¦null

false

none

»»» query

body

any

false

none

»»» alias

body

string¦null

false

none

»»» sourceType

body

string

false

none

»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»» joinType

body

string

false

none

»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»» constraintType

body

string

false

none

»»»» op

body

string¦null

false

none

»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» caseSensitive

body

boolean

false

none

»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» isPreciseDecimal

body

boolean

false

none

»»»» like

body

string¦null

false

none

»»»» escapeWildcards

body

boolean

false

none

»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»» table

body

string¦null

false

none

»»»» queryDefinitionRight

body

any

false

none

»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» direction

body

string

false

none

»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» distinct

body

boolean

false

none

»» unionWith

body

any

false

none

»» exceptWith

body

any

false

none

» table

body

Varicent.RESTAPI.v1.DTOs.CustomTableDTO

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» name

body

string¦null

false

none

»» tableType

body

string

false

none

»» effectiveDated

body

boolean

false

none

»» workflowObjectID

body

integer(int32)

false

none

»» hierarchyMetadata

body

RESTAPI.v1.DTOs.Hierarchy.HierarchyMetadataDTO

false

none

»»» tableName

body

string¦null

false

none

»»» idColumnName

body

string¦null

false

none

»»» parentColumnName

body

string¦null

false

none

»» lastUpdatedTracking

body

boolean¦null

false

none

» columns

body

[string]¦null

false

none

Enumerated Values

Parameter

Value

»»» dataType

Int

»»» dataType

Decimal

»»» dataType

DateTime

»»» dataType

None

»»» dataType

String

»»» type

SelectAll

»»» type

SelectItem

»»» type

SelectLiteral

»»» type

SelectCustom

»»» type

SelectExpression

»»»» expressionType

caseExpression

»»»» expressionType

dataField

»»»» expressionType

function

»»»» expressionType

ifExpression

»»»» expressionType

literal

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» constraintType

clause

»»»»»» constraintType

constraint

»»»»»» constraintType

expressionConstraint

»»»»»» constraintType

likeConstraint

»»»»»» constraintType

rowVersionConstraint

»»»»»» constraintType

subQueryConstraint

»»»»»»» expressionType

caseExpression

»»»»»»» expressionType

dataField

»»»»»»» expressionType

function

»»»»»»» expressionType

ifExpression

»»»»»»» expressionType

literal

»»»»»»» literalType

Integer

»»»»»»» literalType

Decimal

»»»»»»» literalType

Date

»»»»»»» literalType

DateTime

»»»»»»» literalType

String

»»»»»»» literalType

Float

»»»»»»» literalType

Long

»»»»»»» literalType

Null

»»»»»»» literalType

Parameter

»»»»»»» literalType

Guid

»»»»»»» literalType

SystemUtcTime

»»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» literalType

Integer

»»»» literalType

Decimal

»»»» literalType

Date

»»»» literalType

DateTime

»»»» literalType

String

»»»» literalType

Float

»»»» literalType

Long

»»»» literalType

Null

»»»» literalType

Parameter

»»»» literalType

Guid

»»»» literalType

SystemUtcTime

»»»» literalType

Boolean

»»» sourceType

Table

»»» sourceType

Query

»»» joinType

Inner

»»» joinType

Left

»»» joinType

Right

»»» joinType

Cross

»»» joinType

CrossApply

»»» joinType

OuterApply

»»»» constraintType

clause

»»»» constraintType

constraint

»»»» constraintType

expressionConstraint

»»»» constraintType

likeConstraint

»»»» constraintType

rowVersionConstraint

»»»» constraintType

subQueryConstraint

»»» direction

Ascending

»»» direction

Descending

»»» direction

AscendingNullsFirst

»»» direction

DescendingNullsLast

»» tableType

System

»» tableType

Dimension

»» tableType

Structural

»» tableType

Lookup

»» tableType

Data

»» tableType

View

»» tableType

Custom

»» tableType

StarSchema

»» tableType

ExportTable

»» tableType

CreditingRule

»» tableType

AssignTable

»» tableType

PlcmCustomTable

»» tableType

PlcmStructuralTable

»» tableType

PlcmTable

»» tableType

DataSource

»» tableType

Cached

»» tableType

MaterializedView

Responses

Status

Meaning

Description

Schema

200

OK

Disable a group of columns given query definition, table and column names

None

400

Bad Request

Table name in URL does not match given table

None

404

Not Found

Table does not exist

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/webdataedit/{table}/disablegroup", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webdataedit/{table}/disablegroup");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "queryDefinition": {
    "selectItems": [
      {}
    ],
    "source": {
      "namespaceTable": {},
      "query": null,
      "alias": "string",
      "sourceType": "Table"
    },
    "joins": [
      {}
    ],
    "whereClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "order": [
      {}
    ],
    "group": [
      {}
    ],
    "havingClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "distinct": true,
    "unionWith": null,
    "exceptWith": null
  },
  "table": {
    "version": {
      "rowVersion": 0
    },
    "name": "string",
    "tableType": "System",
    "effectiveDated": true,
    "workflowObjectID": 0,
    "hierarchyMetadata": {
      "tableName": "string",
      "idColumnName": "string",
      "parentColumnName": "string"
    },
    "lastUpdatedTracking": true
  },
  "columns": [
    "string"
  ]
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/webdataedit/{table}/disablegroup',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/webdataedit/{table}/disablegroup', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/webdataedit/{table}/disablegroup',
  params: {
  }, headers: headers

p JSON.parse(result)

View pending web data edits.

Parameters

Name

In

Type

Required

Description

table

path

string

true

Table Name

filter

query

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.ResultSetDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/webdataedit/{table}/pendingedits", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webdataedit/{table}/pendingedits");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webdataedit/{table}/pendingedits',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/webdataedit/{table}/pendingedits', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/webdataedit/{table}/pendingedits',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "columnDefinitions": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "data": [
    null
  ],
  "columnSourceMap": {
    "property1": "string",
    "property2": "string"
  },
  "isDataSynced": true,
  "hierarchyMetadata": {
    "tableName": "string",
    "idColumnName": "string",
    "parentColumnName": "string"
  }
}
{"columnDefinitions":[{"name":"string","type":"String","isKey":true,"nullable":true,"values":"string","lockedPeriod":{},"referencedCol":"string","picklistFilter":"string","displayName":"string","isELTPeriod":true}],"data":[null],"columnSourceMap":{"property1":"string","property2":"string"},"isDataSynced":true,"hierarchyMetadata":{"tableName":"string","idColumnName":"string","parentColumnName":"string"}}

Approve web data edits.

Body parameter

[
  0
]

Parameters

Name

In

Type

Required

Description

table

path

string

true

Table Name

body

body

array[integer]

false

Edit ID of rows to approve

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/webdataedit/{table}/pendingedits/approve", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webdataedit/{table}/pendingedits/approve");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  0
]';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/webdataedit/{table}/pendingedits/approve',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/webdataedit/{table}/pendingedits/approve', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/webdataedit/{table}/pendingedits/approve',
  params: {
  }, headers: headers

p JSON.parse(result)

Reject web data edits.

Body parameter

[
  0
]

Parameters

Name

In

Type

Required

Description

table

path

string

true

Table Name

body

body

array[integer]

false

Edit ID of rows to reject

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/webdataedit/{table}/pendingedits/reject", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webdataedit/{table}/pendingedits/reject");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  0
]';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/webdataedit/{table}/pendingedits/reject',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/webdataedit/{table}/pendingedits/reject', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/webdataedit/{table}/pendingedits/reject',
  params: {
  }, headers: headers

p JSON.parse(result)

Get view restrictions.

Parameters

Name

In

Type

Required

Description

table

path

string

true

Table Name

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.Composer.WebDataEditRestrictionsDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/webdataedit/{table}/viewrestrictions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webdataedit/{table}/viewrestrictions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webdataedit/{table}/viewrestrictions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/webdataedit/{table}/viewrestrictions', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/webdataedit/{table}/viewrestrictions',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "source": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "tableSchema": {
    "columns": [
      {}
    ],
    "table": "string",
    "name": "string",
    "referencedSources": [
      "string"
    ],
    "referencedTimes": [
      {}
    ],
    "referencedSourcesDictionary": {
      "property1": "string",
      "property2": "string"
    },
    "referencedTimesDictionary": {
      "property1": {},
      "property2": {}
    }
  }
}
{"source":{"query":{"selectItems":[],"source":{},"joins":[],"whereClause":{},"order":[],"group":[],"havingClause":{},"distinct":true,"unionWith":null,"exceptWith":null},"sourceNames":{"property1":"string","property2":"string"}},"tableSchema":{"columns":[{}],"table":"string","name":"string","referencedSources":["string"],"referencedTimes":[{}],"referencedSourcesDictionary":{"property1":"string","property2":"string"},"referencedTimesDictionary":{"property1":{},"property2":{}}}}

Update view restrictions.

Body parameter

{
  "query": {
    "selectItems": [
      {}
    ],
    "source": {
      "namespaceTable": {},
      "query": null,
      "alias": "string",
      "sourceType": "Table"
    },
    "joins": [
      {}
    ],
    "whereClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "order": [
      {}
    ],
    "group": [
      {}
    ],
    "havingClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "distinct": true,
    "unionWith": null,
    "exceptWith": null
  },
  "sourceNames": {
    "property1": "string",
    "property2": "string"
  }
}

Parameters

Name

In

Type

Required

Description

table

path

string

true

Table Name

body

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

Query of restriction

» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»» alias

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» table

body

string¦null

false

none

»»» customSelect

body

string¦null

false

none

»»» dataType

body

string

false

none

»»» type

body

string

false

none

»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» expressionType

body

string

false

none

»»»» cases

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» op

body

string¦null

false

none

»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»» constraintType

body

string

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» expressionType

body

string

false

none

»»»»»»» cases

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» arguments

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» condition

body

any

false

none

»»»»»»» trueValue

body

any

false

none

»»»»»»» falseValue

body

any

false

none

»»»»»»» isDate

body

boolean

false

none

»»»»»»» literalType

body

string

false

none

»»»»»»» value

body

any

false

none

»»»»»» caseSensitive

body

boolean

false

none

»»»»»» constraints

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» literalRight

body

any

false

none

»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»» right

body

any

false

none

»»»»»» expressionLeft

body

any

false

none

»»»»»» expressionRight

body

any

false

none

»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»» like

body

string¦null

false

none

»»»»»» escapeWildcards

body

boolean

false

none

»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» queryDefinitionRight

body

any

false

none

»»»»» trueValue

body

any

false

none

»»»»» falseValue

body

any

false

none

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» isDate

body

boolean

false

none

»»»» literalType

body

string

false

none

»»»» value

body

any

false

none

»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»» m_namespace

body

string¦null

false

none

»»»» name

body

string¦null

false

none

»»» query

body

any

false

none

»»» alias

body

string¦null

false

none

»»» sourceType

body

string

false

none

»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»» joinType

body

string

false

none

»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»» constraintType

body

string

false

none

»»»» op

body

string¦null

false

none

»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» caseSensitive

body

boolean

false

none

»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» isPreciseDecimal

body

boolean

false

none

»»»» like

body

string¦null

false

none

»»»» escapeWildcards

body

boolean

false

none

»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»» table

body

string¦null

false

none

»»»» queryDefinitionRight

body

any

false

none

»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» direction

body

string

false

none

»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» distinct

body

boolean

false

none

»» unionWith

body

any

false

none

»» exceptWith

body

any

false

none

» sourceNames

body

object¦null

false

none

»» additionalProperties

body

string¦null

false

none

Enumerated Values

Parameter

Value

»»» dataType

Int

»»» dataType

Decimal

»»» dataType

DateTime

»»» dataType

None

»»» dataType

String

»»» type

SelectAll

»»» type

SelectItem

»»» type

SelectLiteral

»»» type

SelectCustom

»»» type

SelectExpression

»»»» expressionType

caseExpression

»»»» expressionType

dataField

»»»» expressionType

function

»»»» expressionType

ifExpression

»»»» expressionType

literal

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» constraintType

clause

»»»»»» constraintType

constraint

»»»»»» constraintType

expressionConstraint

»»»»»» constraintType

likeConstraint

»»»»»» constraintType

rowVersionConstraint

»»»»»» constraintType

subQueryConstraint

»»»»»»» expressionType

caseExpression

»»»»»»» expressionType

dataField

»»»»»»» expressionType

function

»»»»»»» expressionType

ifExpression

»»»»»»» expressionType

literal

»»»»»»» literalType

Integer

»»»»»»» literalType

Decimal

»»»»»»» literalType

Date

»»»»»»» literalType

DateTime

»»»»»»» literalType

String

»»»»»»» literalType

Float

»»»»»»» literalType

Long

»»»»»»» literalType

Null

»»»»»»» literalType

Parameter

»»»»»»» literalType

Guid

»»»»»»» literalType

SystemUtcTime

»»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» literalType

Integer

»»»» literalType

Decimal

»»»» literalType

Date

»»»» literalType

DateTime

»»»» literalType

String

»»»» literalType

Float

»»»» literalType

Long

»»»» literalType

Null

»»»» literalType

Parameter

»»»» literalType

Guid

»»»» literalType

SystemUtcTime

»»»» literalType

Boolean

»»» sourceType

Table

»»» sourceType

Query

»»» joinType

Inner

»»» joinType

Left

»»» joinType

Right

»»» joinType

Cross

»»» joinType

CrossApply

»»» joinType

OuterApply

»»»» constraintType

clause

»»»» constraintType

constraint

»»»» constraintType

expressionConstraint

»»»» constraintType

likeConstraint

»»»» constraintType

rowVersionConstraint

»»»» constraintType

subQueryConstraint

»»» direction

Ascending

»»» direction

Descending

»»» direction

AscendingNullsFirst

»»» direction

DescendingNullsLast

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/webdataedit/{table}/viewrestrictions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webdataedit/{table}/viewrestrictions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "query": {
    "selectItems": [
      {}
    ],
    "source": {
      "namespaceTable": {},
      "query": null,
      "alias": "string",
      "sourceType": "Table"
    },
    "joins": [
      {}
    ],
    "whereClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "order": [
      {}
    ],
    "group": [
      {}
    ],
    "havingClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "distinct": true,
    "unionWith": null,
    "exceptWith": null
  },
  "sourceNames": {
    "property1": "string",
    "property2": "string"
  }
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/webdataedit/{table}/viewrestrictions',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/webdataedit/{table}/viewrestrictions', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/webdataedit/{table}/viewrestrictions',
  params: {
  }, headers: headers

p JSON.parse(result)

Delete all view restrictions.

Parameters

Name

In

Type

Required

Description

table

path

string

true

Table Name

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/webdataedit/{table}/viewrestrictions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webdataedit/{table}/viewrestrictions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/webdataedit/{table}/viewrestrictions',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/webdataedit/{table}/viewrestrictions')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/webdataedit/{table}/viewrestrictions',
  params: {
  }

p JSON.parse(result)

Workflow

Get all Admin notes.

Parameters

Name

In

Type

Required

Description

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

orderBy

query

string

false

####Description

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

time, subject

Responses

Status

Meaning

Description

Schema

200

OK

All admin notes are returned.

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Workflow.AdminNoteDTO]

false

none

none

» time

string(date-time)

false

none

none

» author

string¦null

false

none

none

» subject

string¦null

false

none

none

» body

string¦null

false

none

none

» noteID

integer(int32)

false

none

none

» isNew

boolean

false

none

none

» category

string

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

Enumerated Values

Property

Value

category

AdminMessage

category

Document

category

SignOff

category

InquiryAssigned

category

InquiryOpen

category

AdminPayeeMessage

category

InquiryReturned

category

InquiryEscalated

category

InquiryResubmitted

category

InquiryCommented

category

InquiryClosed

category

PlanApprovalDocument

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/adminnotes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/adminnotes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/adminnotes',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/adminnotes', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/adminnotes',
  params: {
  }, headers: headers

p JSON.parse(result)

Create a new Admin note.

Body parameter

{
  "time": "2019-08-24T14:15:22Z",
  "author": "string",
  "subject": "string",
  "body": "string",
  "noteID": 0,
  "isNew": true,
  "category": "AdminMessage",
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Workflow.AdminNoteDTO

false

none

» time

body

string(date-time)

false

none

» author

body

string¦null

false

none

» subject

body

string¦null

false

none

» body

body

string¦null

false

none

» noteID

body

integer(int32)

false

none

» isNew

body

boolean

false

none

» category

body

string

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Enumerated Values

Parameter

Value

» category

AdminMessage

» category

Document

» category

SignOff

» category

InquiryAssigned

» category

InquiryOpen

» category

AdminPayeeMessage

» category

InquiryReturned

» category

InquiryEscalated

» category

InquiryResubmitted

» category

InquiryCommented

» category

InquiryClosed

» category

PlanApprovalDocument

Responses

Status

Meaning

Description

Schema

201

Created

The Admin note is created.

Varicent.RESTAPI.v1.DTOs.Workflow.AdminNoteDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/adminnotes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/adminnotes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "time": "2019-08-24T14:15:22Z",
  "author": "string",
  "subject": "string",
  "body": "string",
  "noteID": 0,
  "isNew": true,
  "category": "AdminMessage",
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/adminnotes',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/adminnotes', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/adminnotes',
  params: {
  }, headers: headers

p JSON.parse(result)

Delete all Admin notes for Payees

Responses

Status

Meaning

Description

Schema

200

OK

All Admin notes are deleted.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/adminnotes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/adminnotes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/adminnotes',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/adminnotes')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/adminnotes',
  params: {
  }

p JSON.parse(result)

Get the number of admin notes.

Responses

Status

Meaning

Description

Schema

200

OK

Get the number of admin notes.

integer

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/adminnotescount", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/adminnotescount");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/adminnotescount',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/adminnotescount', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/adminnotescount',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
0
0

AdminNotesControllerV1_Get

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

The Admin note is returned.

Varicent.RESTAPI.v1.DTOs.Workflow.AdminNoteDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/adminnotes/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/adminnotes/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/adminnotes/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/adminnotes/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/adminnotes/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "time": "2019-08-24T14:15:22Z",
  "author": "string",
  "subject": "string",
  "body": "string",
  "noteID": 0,
  "isNew": true,
  "category": "AdminMessage",
  "version": {
    "rowVersion": 0
  }
}
{"time":"2019-08-24T14:15:22Z","author":"string","subject":"string","body":"string","noteID":0,"isNew":true,"category":"AdminMessage","version":{"rowVersion":0}}

Delete an Admin note by its ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

The Admin note is deleted.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/adminnotes/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/adminnotes/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/adminnotes/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/adminnotes/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/adminnotes/{id}',
  params: {
  }

p JSON.parse(result)

Update an Admin note.

Body parameter

{
  "time": "2019-08-24T14:15:22Z",
  "author": "string",
  "subject": "string",
  "body": "string",
  "noteID": 0,
  "isNew": true,
  "category": "AdminMessage",
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.Workflow.AdminNoteDTO

false

none

» time

body

string(date-time)

false

none

» author

body

string¦null

false

none

» subject

body

string¦null

false

none

» body

body

string¦null

false

none

» noteID

body

integer(int32)

false

none

» isNew

body

boolean

false

none

» category

body

string

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Enumerated Values

Parameter

Value

» category

AdminMessage

» category

Document

» category

SignOff

» category

InquiryAssigned

» category

InquiryOpen

» category

AdminPayeeMessage

» category

InquiryReturned

» category

InquiryEscalated

» category

InquiryResubmitted

» category

InquiryCommented

» category

InquiryClosed

» category

PlanApprovalDocument

Responses

Status

Meaning

Description

Schema

200

OK

The Admin note is updated.

Varicent.RESTAPI.v1.DTOs.Workflow.AdminNoteDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/adminnotes/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/adminnotes/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "time": "2019-08-24T14:15:22Z",
  "author": "string",
  "subject": "string",
  "body": "string",
  "noteID": 0,
  "isNew": true,
  "category": "AdminMessage",
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/adminnotes/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/adminnotes/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/adminnotes/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

Send an email to all Web users.

Responses

Status

Meaning

Description

Schema

202

Accepted

An email has been sent to all Web users.

Inline

Response Schema

Status Code 202

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/adminnotes/notifyUsers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/adminnotes/notifyUsers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/adminnotes/notifyUsers',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/adminnotes/notifyUsers', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/adminnotes/notifyUsers',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "property1": "string",
  "property2": "string"
}
{"property1":"string","property2":"string"}

Get a workflow.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.BPMWorkflowDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workflowmanager/workflows/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/workflows/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflowmanager/workflows/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/workflowmanager/workflows/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/workflowmanager/workflows/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "description": "string",
  "isSingleInstance": true,
  "workflowState": "Stopped",
  "conditionalVars": [
    {
      "expressionName": "string",
      "name": "string",
      "variableType": "Text"
    }
  ],
  "columnCount": 0,
  "workflowConfig": {
    "pendingWorkflowEnabled": true
  },
  "runCount": 0,
  "runDate": "string",
  "runBy": "string",
  "lastActioned": "string",
  "workflowType": "PresenterReport",
  "webReport": {
    "parameters": [
      {}
    ],
    "layoutAssignment": {
      "property1": {},
      "property2": {}
    },
    "webReportID": 0
  },
  "inquiry": {
    "hasRun": true,
    "components": [
      {}
    ]
  },
  "bpmWorkflowPresenterFlexReportDTO": {
    "reportId": 0,
    "parameters": [
      {}
    ],
    "objectRestrictions": {
      "property1": {},
      "property2": {}
    }
  },
  "bpmWorkflowPlanDocPresenterFlexReportDTO": {
    "reportId": 0,
    "parameters": [
      {}
    ],
    "templateType": "Payee"
  },
  "assignedReports": [
    "string"
  ],
  "numReportsAssigned": 0,
  "permissions": {
    "advanceToken": [
      "Start"
    ],
    "viewDocuments": [
      "Start"
    ]
  },
  "parentFolder": {
    "folderID": 0,
    "folderName": "string",
    "rowVersion": {
      "rowVersion": 0
    },
    "workflowType": "PresenterReport"
  },
  "parameters": [
    {
      "paramName": "string",
      "value": "string",
      "paramType": "Text",
      "valueType": "Constant",
      "usesReportValue": true,
      "isRequired": true
    }
  ],
  "layoutAssignment": {
    "property1": {
      "first": true,
      "second": true
    },
    "property2": {
      "first": true,
      "second": true
    }
  },
  "webReportID": 0,
  "version": {
    "rowVersion": 0
  }
}
{"id":0,"name":"string","description":"string","isSingleInstance":true,"workflowState":"Stopped","conditionalVars":[{"expressionName":"string","name":"string","variableType":"Text"}],"columnCount":0,"workflowConfig":{"pendingWorkflowEnabled":true},"runCount":0,"runDate":"string","runBy":"string","lastActioned":"string","workflowType":"PresenterReport","webReport":{"parameters":[{}],"layoutAssignment":{"property1":{},"property2":{}},"webReportID":0},"inquiry":{"hasRun":true,"components":[{}]},"bpmWorkflowPresenterFlexReportDTO":{"reportId":0,"parameters":[{}],"objectRestrictions":{"property1":{},"property2":{}}},"bpmWorkflowPlanDocPresenterFlexReportDTO":{"reportId":0,"parameters":[{}],"templateType":"Payee"},"assignedReports":["string"],"numReportsAssigned":0,"permissions":{"advanceToken":["Start"],"viewDocuments":["Start"]},"parentFolder":{"folderID":0,"folderName":"string","rowVersion":{"rowVersion":0},"workflowType":"PresenterReport"},"parameters":[{"paramName":"string","value":"string","paramType":"Text","valueType":"Constant","usesReportValue":true,"isRequired":true}],"layoutAssignment":{"property1":{"first":true,"second":true},"property2":{"first":true,"second":true}},"webReportID":0,"version":{"rowVersion":0}}

Delete a workflow.

Body parameter

{
  "workflow": {
    "workflow": {
      "id": 0,
      "name": "string",
      "description": "string",
      "isSingleInstance": true,
      "workflowState": "Stopped",
      "conditionalVars": [],
      "columnCount": 0,
      "workflowConfig": {},
      "runCount": 0,
      "runDate": "string",
      "runBy": "string",
      "lastActioned": "string",
      "workflowType": "PresenterReport",
      "webReport": {},
      "inquiry": {},
      "bpmWorkflowPresenterFlexReportDTO": {},
      "bpmWorkflowPlanDocPresenterFlexReportDTO": {},
      "assignedReports": [],
      "numReportsAssigned": 0,
      "permissions": {},
      "parentFolder": {},
      "parameters": [],
      "layoutAssignment": {},
      "webReportID": 0,
      "version": {}
    },
    "parentFolderId": 0
  },
  "parentFolderRowVersion": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.DeleteBPMWorkflowDTO

false

none

» workflow

body

Varicent.RESTAPI.v1.DTOs.BPMWorkflowChildNodeDTO

false

none

»» workflow

body

Varicent.RESTAPI.v1.DTOs.BPMWorkflowDTO

false

none

»»» id

body

integer(int32)

false

none

»»» name

body

string¦null

false

none

»»» description

body

string¦null

false

none

»»» isSingleInstance

body

boolean

false

none

»»» workflowState

body

string

false

none

»»» conditionalVars

body

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowConditionVariableDTO]¦null

false

none

»»»» expressionName

body

string¦null

false

none

»»»» name

body

string¦null

false

none

»»»» variableType

body

string

false

none

»»» columnCount

body

integer(int32)

false

none

»»» workflowConfig

body

RESTAPI.v1.DTOs.BPMWorkflowConfigDTO

false

none

»»»» pendingWorkflowEnabled

body

boolean

false

none

»»» runCount

body

integer(int32)

false

none

»»» runDate

body

string¦null

false

none

»»» runBy

body

string¦null

false

none

»»» lastActioned

body

string¦null

false

none

»»» workflowType

body

string

false

none

»»» webReport

body

Varicent.RESTAPI.v1.DTOs.BPMWorkflowWebReportDTO

false

none

»»»» parameters

body

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowParameterDTO]¦null

false

none

»»»»» paramName

body

string¦null

false

none

»»»»» value

body

string¦null

false

none

»»»»» paramType

body

string

false

none

»»»»» valueType

body

string

false

none

»»»»» usesReportValue

body

boolean

false

none

»»»»» isRequired

body

boolean

false

none

»»»» layoutAssignment

body

object¦null

false

none

»»»»» additionalProperties

body

[RESTAPI.v1.DTOs.PairDTO2[System.Boolean,System.Boolean]](#schemarestapi.v1.dtos.pairdto2[system.boolean,system.boolean])

false

none

»»»»»» first

body

boolean

false

none

»»»»»» second

body

boolean

false

none

»»»» webReportID

body

integer(int32)

false

none

»»» inquiry

body

Varicent.RESTAPI.v1.DTOs.BPMWorkflowInquiryDTO

false

none

»»»» hasRun

body

boolean

false

none

»»»» components

body

[RESTAPI.v1.DTOs.BPM.BPMComponentDTO]¦null

false

none

»»»»» workflowID

body

integer(int32)

false

none

»»»»» componentID

body

integer(int32)

false

none

»»»»» name

body

string¦null

false

none

»»»»» type

body

string

false

none

»»»»» order

body

integer(int32)

false

none

»»»»» categories

body

[RESTAPI.v1.DTOs.BPMInquiryCategoryDTO]¦null

false

none

»»»»»» categoryID

body

integer(int32)

false

none

»»»»»» value

body

string¦null

false

none

»»»»» source

body

RESTAPI.v1.DTOs.BPM.BPMComponentSourceDTO

false

none

»»»»»» sourceID

body

integer(int32)¦null

false

none

»»»»»» sourceReference

body

RESTAPI.v1.DTOs.BPM.BPMComponentSourceReferenceDTO

false

none

»»»»»»» tableName

body

string¦null

false

none

»»»»»»» calculationID

body

integer(int32)¦null

false

none

»»»»»»» dataStoreID

body

integer(int32)¦null

false

none

»»»»»»» planBuilderCalculationID

body

string¦null

false

none

»»»»»» sourceFilters

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFiltersDTO

false

none

»»»»»»» filters

body

[RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterDTO]¦null

false

none

»»»»»»»» constraint

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterConstraintDTO

false

none

»»»»»»»»» columnName

body

string¦null

false

none

»»»»»»»»» operator

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterOperatorDTO

false

none

»»»»»»»»»» type

body

string

false

none

»»»»»»»»» value

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterValueDTO

false

none

»»»»»»»»»» text

body

string¦null

false

none

»»»»»»»»»» numeric

body

number(double)¦null

false

none

»»»»»»»»»» date

body

string(date-time)¦null

false

none

»»»»»»»»»» special

body

string¦null

false

none

»»»»»»»»»» valueId

body

integer(int32)¦null

false

none

»»»»»»»»»» rangeValue

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexRangeValueDTO

false

none

»»»»»»»»»»» min

body

any

false

none

»»»»»»»»»»» max

body

any

false

none

»»»»»»»»» caseSensitive

body

boolean¦null

false

none

»»»»»»»» and

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterAndDTO

false

none

»»»»»»»»» filters

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» or

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterOrDTO

false

none

»»»»»»»»» filters

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» not

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterNotDTO

false

none

»»»»»»»»» filter

body

any

false

none

»»»»»»»» metadata

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterMetaDataDTO

false

none

»»»»»»»»» additionalProperties

body

any

false

none

»»»»»» columns

body

[RESTAPI.v1.DTOs.BPM.BPMComponentSourceColumnDTO]¦null

false

none

»»»»»»» columnName

body

string¦null

false

none

»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»» config

body

RESTAPI.v1.DTOs.BPM.BPMComponentConfigDTO

false

none

»»»»»» pickList

body

RESTAPI.v1.DTOs.BPM.BPMComponentPickListDTO

false

none

»»»»»»» additionalProperties

body

any

false

none

»»»»»»» placeholder

body

string¦null

false

none

»»»»»»» sort

body

string¦null

false

none

»»»»»»» parameterName

body

string¦null

false

none

»»»»»»» userGenerated

body

boolean

false

none

»»»»»»» hasError

body

boolean

false

none

»»»»»»» required

body

boolean

false

none

»»»»»»» enabled

body

boolean

false

none

»»»»»»» visible

body

boolean

false

none

»»»»»»» defaultValue

body

string¦null

false

none

»»»»»» title

body

RESTAPI.v1.DTOs.BPM.BPMComponentTitleDTO

false

none

»»»»»»» additionalProperties

body

any

false

none

»»»»»»» content

body

string¦null

false

none

»»»»»»» userGenerated

body

boolean

false

none

»»»»»»» hasError

body

boolean

false

none

»»»»»»» required

body

boolean

false

none

»»»»»»» enabled

body

boolean

false

none

»»»»»»» visible

body

boolean

false

none

»»»»»»» defaultValue

body

string¦null

false

none

»»»»»» subject

body

RESTAPI.v1.DTOs.BPM.BPMComponentSubjectDTO

false

none

»»»»»»» additionalProperties

body

any

false

none

»»»»»»» placeholder

body

string¦null

false

none

»»»»»»» parameterName

body

string¦null

false

none

»»»»»»» userGenerated

body

boolean

false

none

»»»»»»» hasError

body

boolean

false

none

»»»»»»» required

body

boolean

false

none

»»»»»»» enabled

body

boolean

false

none

»»»»»»» visible

body

boolean

false

none

»»»»»»» defaultValue

body

string¦null

false

none

»»»»»» description

body

RESTAPI.v1.DTOs.BPM.BPMComponentDescriptionDTO

false

none

»»»»»»» additionalProperties

body

any

false

none

»»»»»»» placeholder

body

string¦null

false

none

»»»»»»» parameterName

body

string¦null

false

none

»»»»»»» charLimit

body

integer(int32)

false

none

»»»»»»» userGenerated

body

boolean

false

none

»»»»»»» hasError

body

boolean

false

none

»»»»»»» required

body

boolean

false

none

»»»»»»» enabled

body

boolean

false

none

»»»»»»» visible

body

boolean

false

none

»»»»»»» defaultValue

body

string¦null

false

none

»»»»»» text

body

RESTAPI.v1.DTOs.BPM.BPMComponentTextDTO

false

none

»»»»»»» additionalProperties

body

any

false

none

»»»»»»» placeholder

body

string¦null

false

none

»»»»»»» charLimit

body

integer(int32)

false

none

»»»»»»» content

body

string¦null

false

none

»»»»»»» parameterName

body

string¦null

false

none

»»»»»»» userGenerated

body

boolean

false

none

»»»»»»» hasError

body

boolean

false

none

»»»»»»» required

body

boolean

false

none

»»»»»»» templateList

body

[RESTAPI.v1.DTOs.BPM.CommentTemplateDTO]¦null

false

none

»»»»»»»» value

body

string¦null

false

none

»»»»»»» enabled

body

boolean

false

none

»»»»»»» visible

body

boolean

false

none

»»»»»»» defaultValue

body

string¦null

false

none

»»»»»» numeric

body

RESTAPI.v1.DTOs.BPM.BPMComponentNumericDTO

false

none

»»»»»»» additionalProperties

body

any

false

none

»»»»»»» placeholder

body

string¦null

false

none

»»»»»»» charLimit

body

integer(int32)

false

none

»»»»»»» content

body

string¦null

false

none

»»»»»»» parameterName

body

string¦null

false

none

»»»»»»» userGenerated

body

boolean

false

none

»»»»»»» hasError

body

boolean

false

none

»»»»»»» required

body

boolean

false

none

»»»»»»» enabled

body

boolean

false

none

»»»»»»» visible

body

boolean

false

none

»»»»»»» defaultValue

body

integer(int32)

false

none

»»»»»» sourcePickList

body

RESTAPI.v1.DTOs.BPM.BPMComponentSourcePickListDTO

false

none

»»»»»»» additionalProperties

body

any

false

none

»»»»»»» displayName

body

string¦null

false

none

»»»»»»» displayColumn

body

string¦null

false

none

»»»»»»» displayColumnDBType

body

string

false

none

»»»»»»» idColumn

body

string¦null

false

none

»»»»»»» idColumnDBType

body

string

false

none

»»»»»»» placeholder

body

string¦null

false

none

»»»»»»» sort

body

string¦null

false

none

»»»»»»» sortOrder

body

string

false

none

»»»»»»» parameterName

body

string¦null

false

none

»»»»»»» hasError

body

boolean

false

none

»»»»»»» required

body

boolean

false

none

»»»»»»» userGenerated

body

boolean

false

none

»»»»»»» hideIDColumn

body

boolean¦null

false

none

»»»»»»» enabled

body

boolean

false

none

»»»»»»» visible

body

boolean

false

none

»»»»»»» defaultValue

body

string¦null

false

none

»»»»» componentMappings

body

[RESTAPI.v1.DTOs.BPM.BPMAutoAdjustComponentMappingDTO]¦null

false

none

»»»»»» nodeID

body

integer(int32)

false

none

»»»»»» nodeName

body

string¦null

false

none

»»»»»» tableName

body

string¦null

false

none

»»»»»» columnName

body

string¦null

false

none

»»»»»» dataType

body

string¦null

false

none

»»»»»» isPrimaryKey

body

boolean

false

none

»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» bpmWorkflowPresenterFlexReportDTO

body

Varicent.RESTAPI.v1.DTOs.BPMWorkflowPresenterFlexReportDTO

false

none

»»»» reportId

body

integer(int32)

false

none

»»»» parameters

body

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowParameterDTO]¦null

false

none

»»»» objectRestrictions

body

object¦null

false

none

»»»»» additionalProperties

body

RESTAPI.v1.DTOs.BPM.BPMVisibilityEditabilityDTO

false

none

»»»»»» visible

body

boolean

false

none

»»»»»» editable

body

boolean

false

none

»»» bpmWorkflowPlanDocPresenterFlexReportDTO

body

Varicent.RESTAPI.v1.DTOs.BPMWorkflowPlanDocPresenterFlexReportDTO

false

none

»»»» reportId

body

integer(int32)

false

none

»»»» parameters

body

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowParameterDTO]¦null

false

none

»»»» templateType

body

string

false

none

»»» assignedReports

body

[string]¦null

false

none

»»» numReportsAssigned

body

integer(int32)

false

none

»»» permissions

body

Varicent.RESTAPI.v1.DTOs.WorkflowPermissionsDTO

false

none

»»»» advanceToken

body

[string]¦null

false

none

»»»» viewDocuments

body

[string]¦null

false

none

»»» parentFolder

body

Varicent.RESTAPI.v1.DTOs.BPMFolderDTO

false

none

»»»» folderID

body

integer(int32)

false

none

»»»» folderName

body

string¦null

false

none

»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»» workflowType

body

string¦null

false

none

»»» parameters

body

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowParameterDTO]¦null

false

none

»»» layoutAssignment

body

object¦null

false

none

»»»» additionalProperties

body

[RESTAPI.v1.DTOs.PairDTO2[System.Boolean,System.Boolean]](#schemarestapi.v1.dtos.pairdto2[system.boolean,system.boolean])

false

none

»»» webReportID

body

integer(int32)

false

none

»»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» parentFolderId

body

integer(int32)

false

none

» parentFolderRowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

»»» workflowState

Stopped

»»» workflowState

Started

»»» workflowState

Stopping

»»» workflowState

Starting

»»» workflowState

Archived

»»» workflowState

Draft

»»»» variableType

Text

»»»» variableType

Date

»»»» variableType

Numeric

»»» workflowType

PresenterReport

»»» workflowType

Inquiry

»»» workflowType

PlanApproval

»»» workflowType

PresenterFlexReport

»»» workflowType

PlanDocument

»»»»» paramType

Text

»»»»» paramType

Date

»»»»» paramType

Numeric

»»»»» valueType

Constant

»»»»» valueType

Value

»»»»» type

pickList

»»»»» type

title

»»»»» type

subject

»»»»» type

description

»»»»» type

text

»»»»» type

numeric

»»»»» type

sourcePickList

»»»»»»»»»» type

Equals

»»»»»»»»»» type

NotEquals

»»»»»»»»»» type

LessThan

»»»»»»»»»» type

LessThanEquals

»»»»»»»»»» type

GreaterThan

»»»»»»»»»» type

GreaterThanEquals

»»»»»»»»»» type

IsNull

»»»»»»»»»» type

IsNotNull

»»»»»»»»»» type

Contains

»»»»»»»»»» type

NotContains

»»»»»»»»»» type

StartWith

»»»»»»»»»» type

EndWith

»»»»»»»»»» type

InRange

»»»»»»»»»» type

InArray

»»»»»»»»»» type

NotInArray

»»»»»»»»»» special

CurrentWebUser

»»»»»»»»»» special

CurrentDate

»»»»»»»»»» special

CurrentRowValue

»»»»»»»»»» special

WorkflowFormID

»»»»»»» displayColumnDBType

String

»»»»»»» displayColumnDBType

LongString

»»»»»»» displayColumnDBType

MaxString

»»»»»»» displayColumnDBType

Date

»»»»»»» displayColumnDBType

DateTime

»»»»»»» displayColumnDBType

Decimal

»»»»»»» displayColumnDBType

Int

»»»»»»» displayColumnDBType

Long

»»»»»»» displayColumnDBType

Float

»»»»»»» displayColumnDBType

BLOB

»»»»»»» displayColumnDBType

Identity

»»»»»»» displayColumnDBType

CLOB

»»»»»»» displayColumnDBType

RowVersion

»»»»»»» displayColumnDBType

UID

»»»»»»» displayColumnDBType

VarCharMax

»»»»»»» displayColumnDBType

Boolean

»»»»»»» idColumnDBType

String

»»»»»»» idColumnDBType

LongString

»»»»»»» idColumnDBType

MaxString

»»»»»»» idColumnDBType

Date

»»»»»»» idColumnDBType

DateTime

»»»»»»» idColumnDBType

Decimal

»»»»»»» idColumnDBType

Int

»»»»»»» idColumnDBType

Long

»»»»»»» idColumnDBType

Float

»»»»»»» idColumnDBType

BLOB

»»»»»»» idColumnDBType

Identity

»»»»»»» idColumnDBType

CLOB

»»»»»»» idColumnDBType

RowVersion

»»»»»»» idColumnDBType

UID

»»»»»»» idColumnDBType

VarCharMax

»»»»»»» idColumnDBType

Boolean

»»»»»»» sortOrder

Ascending

»»»»»»» sortOrder

Descending

»»»»»»» sortOrder

AscendingNullsFirst

»»»»»»» sortOrder

DescendingNullsLast

»»»» templateType

Payee

»»»» templateType

ManagerPayee

»»»» templateType

Custom

»»»» advanceToken

Start

»»»» advanceToken

End

»»»» advanceToken

Action

»»»» advanceToken

Alert

»»»» advanceToken

Process

»»»» advanceToken

Conditional

»»»» advanceToken

AutoAdjust

»»»» advanceToken

GeneratePdf

»»»» advanceToken

Sign

»»»» viewDocuments

Start

»»»» viewDocuments

End

»»»» viewDocuments

Action

»»»» viewDocuments

Alert

»»»» viewDocuments

Process

»»»» viewDocuments

Conditional

»»»» viewDocuments

AutoAdjust

»»»» viewDocuments

GeneratePdf

»»»» viewDocuments

Sign

»»»» workflowType

PresenterReport

»»»» workflowType

Inquiry

»»»» workflowType

PlanApproval

»»»» workflowType

PresenterFlexReport

»»»» workflowType

PlanDocument

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.TreeNodeDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/workflowmanager/workflows/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/workflows/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "workflow": {
    "workflow": {
      "id": 0,
      "name": "string",
      "description": "string",
      "isSingleInstance": true,
      "workflowState": "Stopped",
      "conditionalVars": [],
      "columnCount": 0,
      "workflowConfig": {},
      "runCount": 0,
      "runDate": "string",
      "runBy": "string",
      "lastActioned": "string",
      "workflowType": "PresenterReport",
      "webReport": {},
      "inquiry": {},
      "bpmWorkflowPresenterFlexReportDTO": {},
      "bpmWorkflowPlanDocPresenterFlexReportDTO": {},
      "assignedReports": [],
      "numReportsAssigned": 0,
      "permissions": {},
      "parentFolder": {},
      "parameters": [],
      "layoutAssignment": {},
      "webReportID": 0,
      "version": {}
    },
    "parentFolderId": 0
  },
  "parentFolderRowVersion": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflowmanager/workflows/{id}',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.delete('http://localhost:8080/api/v1/workflowmanager/workflows/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.delete 'http://localhost:8080/api/v1/workflowmanager/workflows/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

Update a workflow.

Body parameter

{
  "workflow": {
    "workflow": {
      "id": 0,
      "name": "string",
      "description": "string",
      "isSingleInstance": true,
      "workflowState": "Stopped",
      "conditionalVars": [],
      "columnCount": 0,
      "workflowConfig": {},
      "runCount": 0,
      "runDate": "string",
      "runBy": "string",
      "lastActioned": "string",
      "workflowType": "PresenterReport",
      "webReport": {},
      "inquiry": {},
      "bpmWorkflowPresenterFlexReportDTO": {},
      "bpmWorkflowPlanDocPresenterFlexReportDTO": {},
      "assignedReports": [],
      "numReportsAssigned": 0,
      "permissions": {},
      "parentFolder": {},
      "parameters": [],
      "layoutAssignment": {},
      "webReportID": 0,
      "version": {}
    },
    "parentFolderId": 0
  },
  "oldOrder": 0,
  "newOrder": 0,
  "oldParentFolderRowVersion": {
    "rowVersion": 0
  },
  "newParentFolderRowVersion": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.UpdateBPMWorkflowDTO

false

none

» workflow

body

Varicent.RESTAPI.v1.DTOs.BPMWorkflowChildNodeDTO

false

none

»» workflow

body

Varicent.RESTAPI.v1.DTOs.BPMWorkflowDTO

false

none

»»» id

body

integer(int32)

false

none

»»» name

body

string¦null

false

none

»»» description

body

string¦null

false

none

»»» isSingleInstance

body

boolean

false

none

»»» workflowState

body

string

false

none

»»» conditionalVars

body

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowConditionVariableDTO]¦null

false

none

»»»» expressionName

body

string¦null

false

none

»»»» name

body

string¦null

false

none

»»»» variableType

body

string

false

none

»»» columnCount

body

integer(int32)

false

none

»»» workflowConfig

body

RESTAPI.v1.DTOs.BPMWorkflowConfigDTO

false

none

»»»» pendingWorkflowEnabled

body

boolean

false

none

»»» runCount

body

integer(int32)

false

none

»»» runDate

body

string¦null

false

none

»»» runBy

body

string¦null

false

none

»»» lastActioned

body

string¦null

false

none

»»» workflowType

body

string

false

none

»»» webReport

body

Varicent.RESTAPI.v1.DTOs.BPMWorkflowWebReportDTO

false

none

»»»» parameters

body

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowParameterDTO]¦null

false

none

»»»»» paramName

body

string¦null

false

none

»»»»» value

body

string¦null

false

none

»»»»» paramType

body

string

false

none

»»»»» valueType

body

string

false

none

»»»»» usesReportValue

body

boolean

false

none

»»»»» isRequired

body

boolean

false

none

»»»» layoutAssignment

body

object¦null

false

none

»»»»» additionalProperties

body

[RESTAPI.v1.DTOs.PairDTO2[System.Boolean,System.Boolean]](#schemarestapi.v1.dtos.pairdto2[system.boolean,system.boolean])

false

none

»»»»»» first

body

boolean

false

none

»»»»»» second

body

boolean

false

none

»»»» webReportID

body

integer(int32)

false

none

»»» inquiry

body

Varicent.RESTAPI.v1.DTOs.BPMWorkflowInquiryDTO

false

none

»»»» hasRun

body

boolean

false

none

»»»» components

body

[RESTAPI.v1.DTOs.BPM.BPMComponentDTO]¦null

false

none

»»»»» workflowID

body

integer(int32)

false

none

»»»»» componentID

body

integer(int32)

false

none

»»»»» name

body

string¦null

false

none

»»»»» type

body

string

false

none

»»»»» order

body

integer(int32)

false

none

»»»»» categories

body

[RESTAPI.v1.DTOs.BPMInquiryCategoryDTO]¦null

false

none

»»»»»» categoryID

body

integer(int32)

false

none

»»»»»» value

body

string¦null

false

none

»»»»» source

body

RESTAPI.v1.DTOs.BPM.BPMComponentSourceDTO

false

none

»»»»»» sourceID

body

integer(int32)¦null

false

none

»»»»»» sourceReference

body

RESTAPI.v1.DTOs.BPM.BPMComponentSourceReferenceDTO

false

none

»»»»»»» tableName

body

string¦null

false

none

»»»»»»» calculationID

body

integer(int32)¦null

false

none

»»»»»»» dataStoreID

body

integer(int32)¦null

false

none

»»»»»»» planBuilderCalculationID

body

string¦null

false

none

»»»»»» sourceFilters

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFiltersDTO

false

none

»»»»»»» filters

body

[RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterDTO]¦null

false

none

»»»»»»»» constraint

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterConstraintDTO

false

none

»»»»»»»»» columnName

body

string¦null

false

none

»»»»»»»»» operator

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterOperatorDTO

false

none

»»»»»»»»»» type

body

string

false

none

»»»»»»»»» value

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterValueDTO

false

none

»»»»»»»»»» text

body

string¦null

false

none

»»»»»»»»»» numeric

body

number(double)¦null

false

none

»»»»»»»»»» date

body

string(date-time)¦null

false

none

»»»»»»»»»» special

body

string¦null

false

none

»»»»»»»»»» valueId

body

integer(int32)¦null

false

none

»»»»»»»»»» rangeValue

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexRangeValueDTO

false

none

»»»»»»»»»»» min

body

any

false

none

»»»»»»»»»»» max

body

any

false

none

»»»»»»»»» caseSensitive

body

boolean¦null

false

none

»»»»»»»» and

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterAndDTO

false

none

»»»»»»»»» filters

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» or

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterOrDTO

false

none

»»»»»»»»» filters

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» not

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterNotDTO

false

none

»»»»»»»»» filter

body

any

false

none

»»»»»»»» metadata

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterMetaDataDTO

false

none

»»»»»»»»» additionalProperties

body

any

false

none

»»»»»» columns

body

[RESTAPI.v1.DTOs.BPM.BPMComponentSourceColumnDTO]¦null

false

none

»»»»»»» columnName

body

string¦null

false

none

»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»» config

body

RESTAPI.v1.DTOs.BPM.BPMComponentConfigDTO

false

none

»»»»»» pickList

body

RESTAPI.v1.DTOs.BPM.BPMComponentPickListDTO

false

none

»»»»»»» additionalProperties

body

any

false

none

»»»»»»» placeholder

body

string¦null

false

none

»»»»»»» sort

body

string¦null

false

none

»»»»»»» parameterName

body

string¦null

false

none

»»»»»»» userGenerated

body

boolean

false

none

»»»»»»» hasError

body

boolean

false

none

»»»»»»» required

body

boolean

false

none

»»»»»»» enabled

body

boolean

false

none

»»»»»»» visible

body

boolean

false

none

»»»»»»» defaultValue

body

string¦null

false

none

»»»»»» title

body

RESTAPI.v1.DTOs.BPM.BPMComponentTitleDTO

false

none

»»»»»»» additionalProperties

body

any

false

none

»»»»»»» content

body

string¦null

false

none

»»»»»»» userGenerated

body

boolean

false

none

»»»»»»» hasError

body

boolean

false

none

»»»»»»» required

body

boolean

false

none

»»»»»»» enabled

body

boolean

false

none

»»»»»»» visible

body

boolean

false

none

»»»»»»» defaultValue

body

string¦null

false

none

»»»»»» subject

body

RESTAPI.v1.DTOs.BPM.BPMComponentSubjectDTO

false

none

»»»»»»» additionalProperties

body

any

false

none

»»»»»»» placeholder

body

string¦null

false

none

»»»»»»» parameterName

body

string¦null

false

none

»»»»»»» userGenerated

body

boolean

false

none

»»»»»»» hasError

body

boolean

false

none

»»»»»»» required

body

boolean

false

none

»»»»»»» enabled

body

boolean

false

none

»»»»»»» visible

body

boolean

false

none

»»»»»»» defaultValue

body

string¦null

false

none

»»»»»» description

body

RESTAPI.v1.DTOs.BPM.BPMComponentDescriptionDTO

false

none

»»»»»»» additionalProperties

body

any

false

none

»»»»»»» placeholder

body

string¦null

false

none

»»»»»»» parameterName

body

string¦null

false

none

»»»»»»» charLimit

body

integer(int32)

false

none

»»»»»»» userGenerated

body

boolean

false

none

»»»»»»» hasError

body

boolean

false

none

»»»»»»» required

body

boolean

false

none

»»»»»»» enabled

body

boolean

false

none

»»»»»»» visible

body

boolean

false

none

»»»»»»» defaultValue

body

string¦null

false

none

»»»»»» text

body

RESTAPI.v1.DTOs.BPM.BPMComponentTextDTO

false

none

»»»»»»» additionalProperties

body

any

false

none

»»»»»»» placeholder

body

string¦null

false

none

»»»»»»» charLimit

body

integer(int32)

false

none

»»»»»»» content

body

string¦null

false

none

»»»»»»» parameterName

body

string¦null

false

none

»»»»»»» userGenerated

body

boolean

false

none

»»»»»»» hasError

body

boolean

false

none

»»»»»»» required

body

boolean

false

none

»»»»»»» templateList

body

[RESTAPI.v1.DTOs.BPM.CommentTemplateDTO]¦null

false

none

»»»»»»»» value

body

string¦null

false

none

»»»»»»» enabled

body

boolean

false

none

»»»»»»» visible

body

boolean

false

none

»»»»»»» defaultValue

body

string¦null

false

none

»»»»»» numeric

body

RESTAPI.v1.DTOs.BPM.BPMComponentNumericDTO

false

none

»»»»»»» additionalProperties

body

any

false

none

»»»»»»» placeholder

body

string¦null

false

none

»»»»»»» charLimit

body

integer(int32)

false

none

»»»»»»» content

body

string¦null

false

none

»»»»»»» parameterName

body

string¦null

false

none

»»»»»»» userGenerated

body

boolean

false

none

»»»»»»» hasError

body

boolean

false

none

»»»»»»» required

body

boolean

false

none

»»»»»»» enabled

body

boolean

false

none

»»»»»»» visible

body

boolean

false

none

»»»»»»» defaultValue

body

integer(int32)

false

none

»»»»»» sourcePickList

body

RESTAPI.v1.DTOs.BPM.BPMComponentSourcePickListDTO

false

none

»»»»»»» additionalProperties

body

any

false

none

»»»»»»» displayName

body

string¦null

false

none

»»»»»»» displayColumn

body

string¦null

false

none

»»»»»»» displayColumnDBType

body

string

false

none

»»»»»»» idColumn

body

string¦null

false

none

»»»»»»» idColumnDBType

body

string

false

none

»»»»»»» placeholder

body

string¦null

false

none

»»»»»»» sort

body

string¦null

false

none

»»»»»»» sortOrder

body

string

false

none

»»»»»»» parameterName

body

string¦null

false

none

»»»»»»» hasError

body

boolean

false

none

»»»»»»» required

body

boolean

false

none

»»»»»»» userGenerated

body

boolean

false

none

»»»»»»» hideIDColumn

body

boolean¦null

false

none

»»»»»»» enabled

body

boolean

false

none

»»»»»»» visible

body

boolean

false

none

»»»»»»» defaultValue

body

string¦null

false

none

»»»»» componentMappings

body

[RESTAPI.v1.DTOs.BPM.BPMAutoAdjustComponentMappingDTO]¦null

false

none

»»»»»» nodeID

body

integer(int32)

false

none

»»»»»» nodeName

body

string¦null

false

none

»»»»»» tableName

body

string¦null

false

none

»»»»»» columnName

body

string¦null

false

none

»»»»»» dataType

body

string¦null

false

none

»»»»»» isPrimaryKey

body

boolean

false

none

»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» bpmWorkflowPresenterFlexReportDTO

body

Varicent.RESTAPI.v1.DTOs.BPMWorkflowPresenterFlexReportDTO

false

none

»»»» reportId

body

integer(int32)

false

none

»»»» parameters

body

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowParameterDTO]¦null

false

none

»»»» objectRestrictions

body

object¦null

false

none

»»»»» additionalProperties

body

RESTAPI.v1.DTOs.BPM.BPMVisibilityEditabilityDTO

false

none

»»»»»» visible

body

boolean

false

none

»»»»»» editable

body

boolean

false

none

»»» bpmWorkflowPlanDocPresenterFlexReportDTO

body

Varicent.RESTAPI.v1.DTOs.BPMWorkflowPlanDocPresenterFlexReportDTO

false

none

»»»» reportId

body

integer(int32)

false

none

»»»» parameters

body

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowParameterDTO]¦null

false

none

»»»» templateType

body

string

false

none

»»» assignedReports

body

[string]¦null

false

none

»»» numReportsAssigned

body

integer(int32)

false

none

»»» permissions

body

Varicent.RESTAPI.v1.DTOs.WorkflowPermissionsDTO

false

none

»»»» advanceToken

body

[string]¦null

false

none

»»»» viewDocuments

body

[string]¦null

false

none

»»» parentFolder

body

Varicent.RESTAPI.v1.DTOs.BPMFolderDTO

false

none

»»»» folderID

body

integer(int32)

false

none

»»»» folderName

body

string¦null

false

none

»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»» workflowType

body

string¦null

false

none

»»» parameters

body

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowParameterDTO]¦null

false

none

»»» layoutAssignment

body

object¦null

false

none

»»»» additionalProperties

body

[RESTAPI.v1.DTOs.PairDTO2[System.Boolean,System.Boolean]](#schemarestapi.v1.dtos.pairdto2[system.boolean,system.boolean])

false

none

»»» webReportID

body

integer(int32)

false

none

»»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» parentFolderId

body

integer(int32)

false

none

» oldOrder

body

integer(int32)

false

none

» newOrder

body

integer(int32)¦null

false

none

» oldParentFolderRowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

» newParentFolderRowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

»»» workflowState

Stopped

»»» workflowState

Started

»»» workflowState

Stopping

»»» workflowState

Starting

»»» workflowState

Archived

»»» workflowState

Draft

»»»» variableType

Text

»»»» variableType

Date

»»»» variableType

Numeric

»»» workflowType

PresenterReport

»»» workflowType

Inquiry

»»» workflowType

PlanApproval

»»» workflowType

PresenterFlexReport

»»» workflowType

PlanDocument

»»»»» paramType

Text

»»»»» paramType

Date

»»»»» paramType

Numeric

»»»»» valueType

Constant

»»»»» valueType

Value

»»»»» type

pickList

»»»»» type

title

»»»»» type

subject

»»»»» type

description

»»»»» type

text

»»»»» type

numeric

»»»»» type

sourcePickList

»»»»»»»»»» type

Equals

»»»»»»»»»» type

NotEquals

»»»»»»»»»» type

LessThan

»»»»»»»»»» type

LessThanEquals

»»»»»»»»»» type

GreaterThan

»»»»»»»»»» type

GreaterThanEquals

»»»»»»»»»» type

IsNull

»»»»»»»»»» type

IsNotNull

»»»»»»»»»» type

Contains

»»»»»»»»»» type

NotContains

»»»»»»»»»» type

StartWith

»»»»»»»»»» type

EndWith

»»»»»»»»»» type

InRange

»»»»»»»»»» type

InArray

»»»»»»»»»» type

NotInArray

»»»»»»»»»» special

CurrentWebUser

»»»»»»»»»» special

CurrentDate

»»»»»»»»»» special

CurrentRowValue

»»»»»»»»»» special

WorkflowFormID

»»»»»»» displayColumnDBType

String

»»»»»»» displayColumnDBType

LongString

»»»»»»» displayColumnDBType

MaxString

»»»»»»» displayColumnDBType

Date

»»»»»»» displayColumnDBType

DateTime

»»»»»»» displayColumnDBType

Decimal

»»»»»»» displayColumnDBType

Int

»»»»»»» displayColumnDBType

Long

»»»»»»» displayColumnDBType

Float

»»»»»»» displayColumnDBType

BLOB

»»»»»»» displayColumnDBType

Identity

»»»»»»» displayColumnDBType

CLOB

»»»»»»» displayColumnDBType

RowVersion

»»»»»»» displayColumnDBType

UID

»»»»»»» displayColumnDBType

VarCharMax

»»»»»»» displayColumnDBType

Boolean

»»»»»»» idColumnDBType

String

»»»»»»» idColumnDBType

LongString

»»»»»»» idColumnDBType

MaxString

»»»»»»» idColumnDBType

Date

»»»»»»» idColumnDBType

DateTime

»»»»»»» idColumnDBType

Decimal

»»»»»»» idColumnDBType

Int

»»»»»»» idColumnDBType

Long

»»»»»»» idColumnDBType

Float

»»»»»»» idColumnDBType

BLOB

»»»»»»» idColumnDBType

Identity

»»»»»»» idColumnDBType

CLOB

»»»»»»» idColumnDBType

RowVersion

»»»»»»» idColumnDBType

UID

»»»»»»» idColumnDBType

VarCharMax

»»»»»»» idColumnDBType

Boolean

»»»»»»» sortOrder

Ascending

»»»»»»» sortOrder

Descending

»»»»»»» sortOrder

AscendingNullsFirst

»»»»»»» sortOrder

DescendingNullsLast

»»»» templateType

Payee

»»»» templateType

ManagerPayee

»»»» templateType

Custom

»»»» advanceToken

Start

»»»» advanceToken

End

»»»» advanceToken

Action

»»»» advanceToken

Alert

»»»» advanceToken

Process

»»»» advanceToken

Conditional

»»»» advanceToken

AutoAdjust

»»»» advanceToken

GeneratePdf

»»»» advanceToken

Sign

»»»» viewDocuments

Start

»»»» viewDocuments

End

»»»» viewDocuments

Action

»»»» viewDocuments

Alert

»»»» viewDocuments

Process

»»»» viewDocuments

Conditional

»»»» viewDocuments

AutoAdjust

»»»» viewDocuments

GeneratePdf

»»»» viewDocuments

Sign

»»»» workflowType

PresenterReport

»»»» workflowType

Inquiry

»»»» workflowType

PlanApproval

»»»» workflowType

PresenterFlexReport

»»»» workflowType

PlanDocument

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.TreeNodeDTO]

false

none

none

» node

any

false

none

none

» children

array¦null

false

none

none

»» anonymous

any

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/workflowmanager/workflows/{id}/foldernode", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/workflows/{id}/foldernode");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "workflow": {
    "workflow": {
      "id": 0,
      "name": "string",
      "description": "string",
      "isSingleInstance": true,
      "workflowState": "Stopped",
      "conditionalVars": [],
      "columnCount": 0,
      "workflowConfig": {},
      "runCount": 0,
      "runDate": "string",
      "runBy": "string",
      "lastActioned": "string",
      "workflowType": "PresenterReport",
      "webReport": {},
      "inquiry": {},
      "bpmWorkflowPresenterFlexReportDTO": {},
      "bpmWorkflowPlanDocPresenterFlexReportDTO": {},
      "assignedReports": [],
      "numReportsAssigned": 0,
      "permissions": {},
      "parentFolder": {},
      "parameters": [],
      "layoutAssignment": {},
      "webReportID": 0,
      "version": {}
    },
    "parentFolderId": 0
  },
  "oldOrder": 0,
  "newOrder": 0,
  "oldParentFolderRowVersion": {
    "rowVersion": 0
  },
  "newParentFolderRowVersion": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflowmanager/workflows/{id}/foldernode',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/workflowmanager/workflows/{id}/foldernode', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/workflowmanager/workflows/{id}/foldernode',
  params: {
  }, headers: headers

p JSON.parse(result)

Add or remove a column from a BPM workflow using UpdateBPMColumn dto.

Body parameter

{
  "index": 0,
  "type": "Remove"
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

RESTAPI.v1.DTOs.BPM.UpdateBPMColumn

false

none

» index

body

integer(int32)

false

none

» type

body

string

false

none

Enumerated Values

Parameter

Value

» type

Remove

» type

Add

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowDTO]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» description

string¦null

false

none

none

» isSingleInstance

boolean

false

none

none

» workflowState

string

false

none

none

» conditionalVars

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowConditionVariableDTO]¦null

false

none

none

»» expressionName

string¦null

false

none

none

»» name

string¦null

false

none

none

»» variableType

string

false

none

none

» columnCount

integer(int32)

false

none

none

» workflowConfig

RESTAPI.v1.DTOs.BPMWorkflowConfigDTO

false

none

none

»» pendingWorkflowEnabled

boolean

false

none

none

» runCount

integer(int32)

false

none

none

» runDate

string¦null

false

none

none

» runBy

string¦null

false

none

none

» lastActioned

string¦null

false

none

none

» workflowType

string

false

none

none

» webReport

Varicent.RESTAPI.v1.DTOs.BPMWorkflowWebReportDTO

false

none

none

»» parameters

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowParameterDTO]¦null

false

none

none

»»» paramName

string¦null

false

none

none

»»» value

string¦null

false

none

none

»»» paramType

string

false

none

none

»»» valueType

string

false

none

none

»»» usesReportValue

boolean

false

none

none

»»» isRequired

boolean

false

none

none

»» layoutAssignment

object¦null

false

none

none

»»» additionalProperties

[RESTAPI.v1.DTOs.PairDTO2[System.Boolean,System.Boolean]](#schemarestapi.v1.dtos.pairdto2[system.boolean,system.boolean])

false

none

none

»»»» first

boolean

false

none

none

»»»» second

boolean

false

none

none

»» webReportID

integer(int32)

false

none

none

» inquiry

Varicent.RESTAPI.v1.DTOs.BPMWorkflowInquiryDTO

false

none

none

»» hasRun

boolean

false

none

none

»» components

[RESTAPI.v1.DTOs.BPM.BPMComponentDTO]¦null

false

none

none

»»» workflowID

integer(int32)

false

none

none

»»» componentID

integer(int32)

false

none

none

»»» name

string¦null

false

none

none

»»» type

string

false

none

none

»»» order

integer(int32)

false

none

none

»»» categories

[RESTAPI.v1.DTOs.BPMInquiryCategoryDTO]¦null

false

none

none

»»»» categoryID

integer(int32)

false

none

none

»»»» value

string¦null

false

none

none

»»» source

RESTAPI.v1.DTOs.BPM.BPMComponentSourceDTO

false

none

none

»»»» sourceID

integer(int32)¦null

false

none

none

»»»» sourceReference

RESTAPI.v1.DTOs.BPM.BPMComponentSourceReferenceDTO

false

none

none

»»»»» tableName

string¦null

false

none

none

»»»»» calculationID

integer(int32)¦null

false

none

none

»»»»» dataStoreID

integer(int32)¦null

false

none

none

»»»»» planBuilderCalculationID

string¦null

false

none

none

»»»» sourceFilters

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFiltersDTO

false

none

none

»»»»» filters

[RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterDTO]¦null

false

none

none

»»»»»» constraint

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterConstraintDTO

false

none

none

»»»»»»» columnName

string¦null

false

none

none

»»»»»»» operator

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterOperatorDTO

false

none

none

»»»»»»»» type

string

false

none

none

»»»»»»» value

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterValueDTO

false

none

none

»»»»»»»» text

string¦null

false

none

none

»»»»»»»» numeric

number(double)¦null

false

none

none

»»»»»»»» date

string(date-time)¦null

false

none

none

»»»»»»»» special

string¦null

false

none

none

»»»»»»»» valueId

integer(int32)¦null

false

none

none

»»»»»»»» rangeValue

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexRangeValueDTO

false

none

none

»»»»»»»»» min

any

false

none

none

»»»»»»»»» max

any

false

none

none

»»»»»»» caseSensitive

boolean¦null

false

none

none

»»»»»» and

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterAndDTO

false

none

none

»»»»»»» filters

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»» or

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterOrDTO

false

none

none

»»»»»»» filters

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»» not

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterNotDTO

false

none

none

»»»»»»» filter

any

false

none

none

»»»»»» metadata

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterMetaDataDTO

false

none

none

»»»»»»» additionalProperties

any

false

none

none

»»»» columns

[RESTAPI.v1.DTOs.BPM.BPMComponentSourceColumnDTO]¦null

false

none

none

»»»»» columnName

string¦null

false

none

none

»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»» rowVersion

integer(int64)

false

none

none

»»» config

RESTAPI.v1.DTOs.BPM.BPMComponentConfigDTO

false

none

none

»»»» pickList

RESTAPI.v1.DTOs.BPM.BPMComponentPickListDTO

false

none

none

»»»»» additionalProperties

any

false

none

none

»»»»» placeholder

string¦null

false

none

none

»»»»» sort

string¦null

false

none

none

»»»»» parameterName

string¦null

false

none

none

»»»»» userGenerated

boolean

false

none

none

»»»»» hasError

boolean

false

none

none

»»»»» required

boolean

false

none

none

»»»»» enabled

boolean

false

none

none

»»»»» visible

boolean

false

none

none

»»»»» defaultValue

string¦null

false

none

none

»»»» title

RESTAPI.v1.DTOs.BPM.BPMComponentTitleDTO

false

none

none

»»»»» additionalProperties

any

false

none

none

»»»»» content

string¦null

false

none

none

»»»»» userGenerated

boolean

false

none

none

»»»»» hasError

boolean

false

none

none

»»»»» required

boolean

false

none

none

»»»»» enabled

boolean

false

none

none

»»»»» visible

boolean

false

none

none

»»»»» defaultValue

string¦null

false

none

none

»»»» subject

RESTAPI.v1.DTOs.BPM.BPMComponentSubjectDTO

false

none

none

»»»»» additionalProperties

any

false

none

none

»»»»» placeholder

string¦null

false

none

none

»»»»» parameterName

string¦null

false

none

none

»»»»» userGenerated

boolean

false

none

none

»»»»» hasError

boolean

false

none

none

»»»»» required

boolean

false

none

none

»»»»» enabled

boolean

false

none

none

»»»»» visible

boolean

false

none

none

»»»»» defaultValue

string¦null

false

none

none

»»»» description

RESTAPI.v1.DTOs.BPM.BPMComponentDescriptionDTO

false

none

none

»»»»» additionalProperties

any

false

none

none

»»»»» placeholder

string¦null

false

none

none

»»»»» parameterName

string¦null

false

none

none

»»»»» charLimit

integer(int32)

false

none

none

»»»»» userGenerated

boolean

false

none

none

»»»»» hasError

boolean

false

none

none

»»»»» required

boolean

false

none

none

»»»»» enabled

boolean

false

none

none

»»»»» visible

boolean

false

none

none

»»»»» defaultValue

string¦null

false

none

none

»»»» text

RESTAPI.v1.DTOs.BPM.BPMComponentTextDTO

false

none

none

»»»»» additionalProperties

any

false

none

none

»»»»» placeholder

string¦null

false

none

none

»»»»» charLimit

integer(int32)

false

none

none

»»»»» content

string¦null

false

none

none

»»»»» parameterName

string¦null

false

none

none

»»»»» userGenerated

boolean

false

none

none

»»»»» hasError

boolean

false

none

none

»»»»» required

boolean

false

none

none

»»»»» templateList

[RESTAPI.v1.DTOs.BPM.CommentTemplateDTO]¦null

false

none

none

»»»»»» value

string¦null

false

none

none

»»»»» enabled

boolean

false

none

none

»»»»» visible

boolean

false

none

none

»»»»» defaultValue

string¦null

false

none

none

»»»» numeric

RESTAPI.v1.DTOs.BPM.BPMComponentNumericDTO

false

none

none

»»»»» additionalProperties

any

false

none

none

»»»»» placeholder

string¦null

false

none

none

»»»»» charLimit

integer(int32)

false

none

none

»»»»» content

string¦null

false

none

none

»»»»» parameterName

string¦null

false

none

none

»»»»» userGenerated

boolean

false

none

none

»»»»» hasError

boolean

false

none

none

»»»»» required

boolean

false

none

none

»»»»» enabled

boolean

false

none

none

»»»»» visible

boolean

false

none

none

»»»»» defaultValue

integer(int32)

false

none

none

»»»» sourcePickList

RESTAPI.v1.DTOs.BPM.BPMComponentSourcePickListDTO

false

none

none

»»»»» additionalProperties

any

false

none

none

»»»»» displayName

string¦null

false

none

none

»»»»» displayColumn

string¦null

false

none

none

»»»»» displayColumnDBType

string

false

none

none

»»»»» idColumn

string¦null

false

none

none

»»»»» idColumnDBType

string

false

none

none

»»»»» placeholder

string¦null

false

none

none

»»»»» sort

string¦null

false

none

none

»»»»» sortOrder

string

false

none

none

»»»»» parameterName

string¦null

false

none

none

»»»»» hasError

boolean

false

none

none

»»»»» required

boolean

false

none

none

»»»»» userGenerated

boolean

false

none

none

»»»»» hideIDColumn

boolean¦null

false

none

none

»»»»» enabled

boolean

false

none

none

»»»»» visible

boolean

false

none

none

»»»»» defaultValue

string¦null

false

none

none

»»» componentMappings

[RESTAPI.v1.DTOs.BPM.BPMAutoAdjustComponentMappingDTO]¦null

false

none

none

»»»» nodeID

integer(int32)

false

none

none

»»»» nodeName

string¦null

false

none

none

»»»» tableName

string¦null

false

none

none

»»»» columnName

string¦null

false

none

none

»»»» dataType

string¦null

false

none

none

»»»» isPrimaryKey

boolean

false

none

none

»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

» bpmWorkflowPresenterFlexReportDTO

Varicent.RESTAPI.v1.DTOs.BPMWorkflowPresenterFlexReportDTO

false

none

none

»» reportId

integer(int32)

false

none

none

»» parameters

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowParameterDTO]¦null

false

none

none

»» objectRestrictions

object¦null

false

none

none

»»» additionalProperties

RESTAPI.v1.DTOs.BPM.BPMVisibilityEditabilityDTO

false

none

none

»»»» visible

boolean

false

none

none

»»»» editable

boolean

false

none

none

» bpmWorkflowPlanDocPresenterFlexReportDTO

Varicent.RESTAPI.v1.DTOs.BPMWorkflowPlanDocPresenterFlexReportDTO

false

none

none

»» reportId

integer(int32)

false

none

none

»» parameters

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowParameterDTO]¦null

false

none

none

»» templateType

string

false

none

none

» assignedReports

[string]¦null

false

none

none

» numReportsAssigned

integer(int32)

false

none

none

» permissions

Varicent.RESTAPI.v1.DTOs.WorkflowPermissionsDTO

false

none

none

»» advanceToken

[string]¦null

false

none

none

»» viewDocuments

[string]¦null

false

none

none

» parentFolder

Varicent.RESTAPI.v1.DTOs.BPMFolderDTO

false

none

none

»» folderID

integer(int32)

false

none

none

»» folderName

string¦null

false

none

none

»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» workflowType

string¦null

false

none

none

» parameters

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowParameterDTO]¦null

false

none

none

» layoutAssignment

object¦null

false

none

none

»» additionalProperties

[RESTAPI.v1.DTOs.PairDTO2[System.Boolean,System.Boolean]](#schemarestapi.v1.dtos.pairdto2[system.boolean,system.boolean])

false

none

none

» webReportID

integer(int32)

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

workflowState

Stopped

workflowState

Started

workflowState

Stopping

workflowState

Starting

workflowState

Archived

workflowState

Draft

variableType

Text

variableType

Date

variableType

Numeric

workflowType

PresenterReport

workflowType

Inquiry

workflowType

PlanApproval

workflowType

PresenterFlexReport

workflowType

PlanDocument

paramType

Text

paramType

Date

paramType

Numeric

valueType

Constant

valueType

Value

type

pickList

type

title

type

subject

type

description

type

text

type

numeric

type

sourcePickList

type

Equals

type

NotEquals

type

LessThan

type

LessThanEquals

type

GreaterThan

type

GreaterThanEquals

type

IsNull

type

IsNotNull

type

Contains

type

NotContains

type

StartWith

type

EndWith

type

InRange

type

InArray

type

NotInArray

special

CurrentWebUser

special

CurrentDate

special

CurrentRowValue

special

WorkflowFormID

displayColumnDBType

String

displayColumnDBType

LongString

displayColumnDBType

MaxString

displayColumnDBType

Date

displayColumnDBType

DateTime

displayColumnDBType

Decimal

displayColumnDBType

Int

displayColumnDBType

Long

displayColumnDBType

Float

displayColumnDBType

BLOB

displayColumnDBType

Identity

displayColumnDBType

CLOB

displayColumnDBType

RowVersion

displayColumnDBType

UID

displayColumnDBType

VarCharMax

displayColumnDBType

Boolean

idColumnDBType

String

idColumnDBType

LongString

idColumnDBType

MaxString

idColumnDBType

Date

idColumnDBType

DateTime

idColumnDBType

Decimal

idColumnDBType

Int

idColumnDBType

Long

idColumnDBType

Float

idColumnDBType

BLOB

idColumnDBType

Identity

idColumnDBType

CLOB

idColumnDBType

RowVersion

idColumnDBType

UID

idColumnDBType

VarCharMax

idColumnDBType

Boolean

sortOrder

Ascending

sortOrder

Descending

sortOrder

AscendingNullsFirst

sortOrder

DescendingNullsLast

templateType

Payee

templateType

ManagerPayee

templateType

Custom

workflowType

PresenterReport

workflowType

Inquiry

workflowType

PlanApproval

workflowType

PresenterFlexReport

workflowType

PlanDocument

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/workflowmanager/workflows/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/workflows/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "index": 0,
  "type": "Remove"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflowmanager/workflows/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/workflowmanager/workflows/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/workflowmanager/workflows/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

Get a workflow tree structure.

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.TreeNodeDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workflowmanager/workflowtreestructure", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/workflowtreestructure");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflowmanager/workflowtreestructure',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/workflowmanager/workflowtreestructure', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/workflowmanager/workflowtreestructure',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "node": null,
  "children": []
}
{"node":null,"children":[]}

Get all workflows.

Parameters

Name

In

Type

Required

Description

filter

query

string

false

####Supported operations

orderBy

query

string

false

####Description

Detailed descriptions

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

canScheduleAddPayee

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

name

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowDTO]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» description

string¦null

false

none

none

» isSingleInstance

boolean

false

none

none

» workflowState

string

false

none

none

» conditionalVars

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowConditionVariableDTO]¦null

false

none

none

»» expressionName

string¦null

false

none

none

»» name

string¦null

false

none

none

»» variableType

string

false

none

none

» columnCount

integer(int32)

false

none

none

» workflowConfig

RESTAPI.v1.DTOs.BPMWorkflowConfigDTO

false

none

none

»» pendingWorkflowEnabled

boolean

false

none

none

» runCount

integer(int32)

false

none

none

» runDate

string¦null

false

none

none

» runBy

string¦null

false

none

none

» lastActioned

string¦null

false

none

none

» workflowType

string

false

none

none

» webReport

Varicent.RESTAPI.v1.DTOs.BPMWorkflowWebReportDTO

false

none

none

»» parameters

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowParameterDTO]¦null

false

none

none

»»» paramName

string¦null

false

none

none

»»» value

string¦null

false

none

none

»»» paramType

string

false

none

none

»»» valueType

string

false

none

none

»»» usesReportValue

boolean

false

none

none

»»» isRequired

boolean

false

none

none

»» layoutAssignment

object¦null

false

none

none

»»» additionalProperties

[RESTAPI.v1.DTOs.PairDTO2[System.Boolean,System.Boolean]](#schemarestapi.v1.dtos.pairdto2[system.boolean,system.boolean])

false

none

none

»»»» first

boolean

false

none

none

»»»» second

boolean

false

none

none

»» webReportID

integer(int32)

false

none

none

» inquiry

Varicent.RESTAPI.v1.DTOs.BPMWorkflowInquiryDTO

false

none

none

»» hasRun

boolean

false

none

none

»» components

[RESTAPI.v1.DTOs.BPM.BPMComponentDTO]¦null

false

none

none

»»» workflowID

integer(int32)

false

none

none

»»» componentID

integer(int32)

false

none

none

»»» name

string¦null

false

none

none

»»» type

string

false

none

none

»»» order

integer(int32)

false

none

none

»»» categories

[RESTAPI.v1.DTOs.BPMInquiryCategoryDTO]¦null

false

none

none

»»»» categoryID

integer(int32)

false

none

none

»»»» value

string¦null

false

none

none

»»» source

RESTAPI.v1.DTOs.BPM.BPMComponentSourceDTO

false

none

none

»»»» sourceID

integer(int32)¦null

false

none

none

»»»» sourceReference

RESTAPI.v1.DTOs.BPM.BPMComponentSourceReferenceDTO

false

none

none

»»»»» tableName

string¦null

false

none

none

»»»»» calculationID

integer(int32)¦null

false

none

none

»»»»» dataStoreID

integer(int32)¦null

false

none

none

»»»»» planBuilderCalculationID

string¦null

false

none

none

»»»» sourceFilters

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFiltersDTO

false

none

none

»»»»» filters

[RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterDTO]¦null

false

none

none

»»»»»» constraint

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterConstraintDTO

false

none

none

»»»»»»» columnName

string¦null

false

none

none

»»»»»»» operator

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterOperatorDTO

false

none

none

»»»»»»»» type

string

false

none

none

»»»»»»» value

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterValueDTO

false

none

none

»»»»»»»» text

string¦null

false

none

none

»»»»»»»» numeric

number(double)¦null

false

none

none

»»»»»»»» date

string(date-time)¦null

false

none

none

»»»»»»»» special

string¦null

false

none

none

»»»»»»»» valueId

integer(int32)¦null

false

none

none

»»»»»»»» rangeValue

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexRangeValueDTO

false

none

none

»»»»»»»»» min

any

false

none

none

»»»»»»»»» max

any

false

none

none

»»»»»»» caseSensitive

boolean¦null

false

none

none

»»»»»» and

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterAndDTO

false

none

none

»»»»»»» filters

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»» or

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterOrDTO

false

none

none

»»»»»»» filters

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»» not

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterNotDTO

false

none

none

»»»»»»» filter

any

false

none

none

»»»»»» metadata

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterMetaDataDTO

false

none

none

»»»»»»» additionalProperties

any

false

none

none

»»»» columns

[RESTAPI.v1.DTOs.BPM.BPMComponentSourceColumnDTO]¦null

false

none

none

»»»»» columnName

string¦null

false

none

none

»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»» rowVersion

integer(int64)

false

none

none

»»» config

RESTAPI.v1.DTOs.BPM.BPMComponentConfigDTO

false

none

none

»»»» pickList

RESTAPI.v1.DTOs.BPM.BPMComponentPickListDTO

false

none

none

»»»»» additionalProperties

any

false

none

none

»»»»» placeholder

string¦null

false

none

none

»»»»» sort

string¦null

false

none

none

»»»»» parameterName

string¦null

false

none

none

»»»»» userGenerated

boolean

false

none

none

»»»»» hasError

boolean

false

none

none

»»»»» required

boolean

false

none

none

»»»»» enabled

boolean

false

none

none

»»»»» visible

boolean

false

none

none

»»»»» defaultValue

string¦null

false

none

none

»»»» title

RESTAPI.v1.DTOs.BPM.BPMComponentTitleDTO

false

none

none

»»»»» additionalProperties

any

false

none

none

»»»»» content

string¦null

false

none

none

»»»»» userGenerated

boolean

false

none

none

»»»»» hasError

boolean

false

none

none

»»»»» required

boolean

false

none

none

»»»»» enabled

boolean

false

none

none

»»»»» visible

boolean

false

none

none

»»»»» defaultValue

string¦null

false

none

none

»»»» subject

RESTAPI.v1.DTOs.BPM.BPMComponentSubjectDTO

false

none

none

»»»»» additionalProperties

any

false

none

none

»»»»» placeholder

string¦null

false

none

none

»»»»» parameterName

string¦null

false

none

none

»»»»» userGenerated

boolean

false

none

none

»»»»» hasError

boolean

false

none

none

»»»»» required

boolean

false

none

none

»»»»» enabled

boolean

false

none

none

»»»»» visible

boolean

false

none

none

»»»»» defaultValue

string¦null

false

none

none

»»»» description

RESTAPI.v1.DTOs.BPM.BPMComponentDescriptionDTO

false

none

none

»»»»» additionalProperties

any

false

none

none

»»»»» placeholder

string¦null

false

none

none

»»»»» parameterName

string¦null

false

none

none

»»»»» charLimit

integer(int32)

false

none

none

»»»»» userGenerated

boolean

false

none

none

»»»»» hasError

boolean

false

none

none

»»»»» required

boolean

false

none

none

»»»»» enabled

boolean

false

none

none

»»»»» visible

boolean

false

none

none

»»»»» defaultValue

string¦null

false

none

none

»»»» text

RESTAPI.v1.DTOs.BPM.BPMComponentTextDTO

false

none

none

»»»»» additionalProperties

any

false

none

none

»»»»» placeholder

string¦null

false

none

none

»»»»» charLimit

integer(int32)

false

none

none

»»»»» content

string¦null

false

none

none

»»»»» parameterName

string¦null

false

none

none

»»»»» userGenerated

boolean

false

none

none

»»»»» hasError

boolean

false

none

none

»»»»» required

boolean

false

none

none

»»»»» templateList

[RESTAPI.v1.DTOs.BPM.CommentTemplateDTO]¦null

false

none

none

»»»»»» value

string¦null

false

none

none

»»»»» enabled

boolean

false

none

none

»»»»» visible

boolean

false

none

none

»»»»» defaultValue

string¦null

false

none

none

»»»» numeric

RESTAPI.v1.DTOs.BPM.BPMComponentNumericDTO

false

none

none

»»»»» additionalProperties

any

false

none

none

»»»»» placeholder

string¦null

false

none

none

»»»»» charLimit

integer(int32)

false

none

none

»»»»» content

string¦null

false

none

none

»»»»» parameterName

string¦null

false

none

none

»»»»» userGenerated

boolean

false

none

none

»»»»» hasError

boolean

false

none

none

»»»»» required

boolean

false

none

none

»»»»» enabled

boolean

false

none

none

»»»»» visible

boolean

false

none

none

»»»»» defaultValue

integer(int32)

false

none

none

»»»» sourcePickList

RESTAPI.v1.DTOs.BPM.BPMComponentSourcePickListDTO

false

none

none

»»»»» additionalProperties

any

false

none

none

»»»»» displayName

string¦null

false

none

none

»»»»» displayColumn

string¦null

false

none

none

»»»»» displayColumnDBType

string

false

none

none

»»»»» idColumn

string¦null

false

none

none

»»»»» idColumnDBType

string

false

none

none

»»»»» placeholder

string¦null

false

none

none

»»»»» sort

string¦null

false

none

none

»»»»» sortOrder

string

false

none

none

»»»»» parameterName

string¦null

false

none

none

»»»»» hasError

boolean

false

none

none

»»»»» required

boolean

false

none

none

»»»»» userGenerated

boolean

false

none

none

»»»»» hideIDColumn

boolean¦null

false

none

none

»»»»» enabled

boolean

false

none

none

»»»»» visible

boolean

false

none

none

»»»»» defaultValue

string¦null

false

none

none

»»» componentMappings

[RESTAPI.v1.DTOs.BPM.BPMAutoAdjustComponentMappingDTO]¦null

false

none

none

»»»» nodeID

integer(int32)

false

none

none

»»»» nodeName

string¦null

false

none

none

»»»» tableName

string¦null

false

none

none

»»»» columnName

string¦null

false

none

none

»»»» dataType

string¦null

false

none

none

»»»» isPrimaryKey

boolean

false

none

none

»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

» bpmWorkflowPresenterFlexReportDTO

Varicent.RESTAPI.v1.DTOs.BPMWorkflowPresenterFlexReportDTO

false

none

none

»» reportId

integer(int32)

false

none

none

»» parameters

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowParameterDTO]¦null

false

none

none

»» objectRestrictions

object¦null

false

none

none

»»» additionalProperties

RESTAPI.v1.DTOs.BPM.BPMVisibilityEditabilityDTO

false

none

none

»»»» visible

boolean

false

none

none

»»»» editable

boolean

false

none

none

» bpmWorkflowPlanDocPresenterFlexReportDTO

Varicent.RESTAPI.v1.DTOs.BPMWorkflowPlanDocPresenterFlexReportDTO

false

none

none

»» reportId

integer(int32)

false

none

none

»» parameters

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowParameterDTO]¦null

false

none

none

»» templateType

string

false

none

none

» assignedReports

[string]¦null

false

none

none

» numReportsAssigned

integer(int32)

false

none

none

» permissions

Varicent.RESTAPI.v1.DTOs.WorkflowPermissionsDTO

false

none

none

»» advanceToken

[string]¦null

false

none

none

»» viewDocuments

[string]¦null

false

none

none

» parentFolder

Varicent.RESTAPI.v1.DTOs.BPMFolderDTO

false

none

none

»» folderID

integer(int32)

false

none

none

»» folderName

string¦null

false

none

none

»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» workflowType

string¦null

false

none

none

» parameters

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowParameterDTO]¦null

false

none

none

» layoutAssignment

object¦null

false

none

none

»» additionalProperties

[RESTAPI.v1.DTOs.PairDTO2[System.Boolean,System.Boolean]](#schemarestapi.v1.dtos.pairdto2[system.boolean,system.boolean])

false

none

none

» webReportID

integer(int32)

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

workflowState

Stopped

workflowState

Started

workflowState

Stopping

workflowState

Starting

workflowState

Archived

workflowState

Draft

variableType

Text

variableType

Date

variableType

Numeric

workflowType

PresenterReport

workflowType

Inquiry

workflowType

PlanApproval

workflowType

PresenterFlexReport

workflowType

PlanDocument

paramType

Text

paramType

Date

paramType

Numeric

valueType

Constant

valueType

Value

type

pickList

type

title

type

subject

type

description

type

text

type

numeric

type

sourcePickList

type

Equals

type

NotEquals

type

LessThan

type

LessThanEquals

type

GreaterThan

type

GreaterThanEquals

type

IsNull

type

IsNotNull

type

Contains

type

NotContains

type

StartWith

type

EndWith

type

InRange

type

InArray

type

NotInArray

special

CurrentWebUser

special

CurrentDate

special

CurrentRowValue

special

WorkflowFormID

displayColumnDBType

String

displayColumnDBType

LongString

displayColumnDBType

MaxString

displayColumnDBType

Date

displayColumnDBType

DateTime

displayColumnDBType

Decimal

displayColumnDBType

Int

displayColumnDBType

Long

displayColumnDBType

Float

displayColumnDBType

BLOB

displayColumnDBType

Identity

displayColumnDBType

CLOB

displayColumnDBType

RowVersion

displayColumnDBType

UID

displayColumnDBType

VarCharMax

displayColumnDBType

Boolean

idColumnDBType

String

idColumnDBType

LongString

idColumnDBType

MaxString

idColumnDBType

Date

idColumnDBType

DateTime

idColumnDBType

Decimal

idColumnDBType

Int

idColumnDBType

Long

idColumnDBType

Float

idColumnDBType

BLOB

idColumnDBType

Identity

idColumnDBType

CLOB

idColumnDBType

RowVersion

idColumnDBType

UID

idColumnDBType

VarCharMax

idColumnDBType

Boolean

sortOrder

Ascending

sortOrder

Descending

sortOrder

AscendingNullsFirst

sortOrder

DescendingNullsLast

templateType

Payee

templateType

ManagerPayee

templateType

Custom

workflowType

PresenterReport

workflowType

Inquiry

workflowType

PlanApproval

workflowType

PresenterFlexReport

workflowType

PlanDocument

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workflowmanager/workflows", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/workflows");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflowmanager/workflows',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/workflowmanager/workflows', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/workflowmanager/workflows',
  params: {
  }, headers: headers

p JSON.parse(result)

Create or copy a workflow when the source ID is provided.

Body parameter

{
  "workflow": {
    "id": 0,
    "name": "string",
    "description": "string",
    "isSingleInstance": true,
    "workflowState": "Stopped",
    "conditionalVars": [
      {}
    ],
    "columnCount": 0,
    "workflowConfig": {
      "pendingWorkflowEnabled": true
    },
    "runCount": 0,
    "runDate": "string",
    "runBy": "string",
    "lastActioned": "string",
    "workflowType": "PresenterReport",
    "webReport": {
      "parameters": [],
      "layoutAssignment": {},
      "webReportID": 0
    },
    "inquiry": {
      "hasRun": true,
      "components": []
    },
    "bpmWorkflowPresenterFlexReportDTO": {
      "reportId": 0,
      "parameters": [],
      "objectRestrictions": {}
    },
    "bpmWorkflowPlanDocPresenterFlexReportDTO": {
      "reportId": 0,
      "parameters": [],
      "templateType": "Payee"
    },
    "assignedReports": [
      "string"
    ],
    "numReportsAssigned": 0,
    "permissions": {
      "advanceToken": [],
      "viewDocuments": []
    },
    "parentFolder": {
      "folderID": 0,
      "folderName": "string",
      "rowVersion": {},
      "workflowType": "PresenterReport"
    },
    "parameters": [
      {}
    ],
    "layoutAssignment": {
      "property1": {},
      "property2": {}
    },
    "webReportID": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "swimLane": {
    "id": 0,
    "order": 0,
    "name": "string",
    "description": "string",
    "workflowID": 0,
    "isSystemLane": true,
    "isByRestriction": true,
    "isAdmin": true,
    "memberDefinition": {
      "query": {},
      "sourceNames": {}
    },
    "payeeIDs": [
      "string"
    ],
    "queryDelta": {
      "modification": {},
      "query": {},
      "selectAllRows": true
    },
    "adminIDs": [
      "string"
    ],
    "version": {
      "rowVersion": 0
    }
  },
  "swimLaneMemberSetModification": {
    "itemsToAdd": [
      "string"
    ],
    "itemsToRemove": [
      "string"
    ]
  },
  "parentFolderId": 0,
  "order": 0,
  "parentFolderRowVersion": {
    "rowVersion": 0
  },
  "webReportRowVersion": {
    "rowVersion": 0
  },
  "presenterflexReportRowVersion": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

source

query

integer(int32)

false

none

body

body

Varicent.RESTAPI.v1.DTOs.CreateBPMWorkflowDTO

false

none

» workflow

body

Varicent.RESTAPI.v1.DTOs.BPMWorkflowDTO

false

none

»» id

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» description

body

string¦null

false

none

»» isSingleInstance

body

boolean

false

none

»» workflowState

body

string

false

none

»» conditionalVars

body

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowConditionVariableDTO]¦null

false

none

»»» expressionName

body

string¦null

false

none

»»» name

body

string¦null

false

none

»»» variableType

body

string

false

none

»» columnCount

body

integer(int32)

false

none

»» workflowConfig

body

RESTAPI.v1.DTOs.BPMWorkflowConfigDTO

false

none

»»» pendingWorkflowEnabled

body

boolean

false

none

»» runCount

body

integer(int32)

false

none

»» runDate

body

string¦null

false

none

»» runBy

body

string¦null

false

none

»» lastActioned

body

string¦null

false

none

»» workflowType

body

string

false

none

»» webReport

body

Varicent.RESTAPI.v1.DTOs.BPMWorkflowWebReportDTO

false

none

»»» parameters

body

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowParameterDTO]¦null

false

none

»»»» paramName

body

string¦null

false

none

»»»» value

body

string¦null

false

none

»»»» paramType

body

string

false

none

»»»» valueType

body

string

false

none

»»»» usesReportValue

body

boolean

false

none

»»»» isRequired

body

boolean

false

none

»»» layoutAssignment

body

object¦null

false

none

»»»» additionalProperties

body

[RESTAPI.v1.DTOs.PairDTO2[System.Boolean,System.Boolean]](#schemarestapi.v1.dtos.pairdto2[system.boolean,system.boolean])

false

none

»»»»» first

body

boolean

false

none

»»»»» second

body

boolean

false

none

»»» webReportID

body

integer(int32)

false

none

»» inquiry

body

Varicent.RESTAPI.v1.DTOs.BPMWorkflowInquiryDTO

false

none

»»» hasRun

body

boolean

false

none

»»» components

body

[RESTAPI.v1.DTOs.BPM.BPMComponentDTO]¦null

false

none

»»»» workflowID

body

integer(int32)

false

none

»»»» componentID

body

integer(int32)

false

none

»»»» name

body

string¦null

false

none

»»»» type

body

string

false

none

»»»» order

body

integer(int32)

false

none

»»»» categories

body

[RESTAPI.v1.DTOs.BPMInquiryCategoryDTO]¦null

false

none

»»»»» categoryID

body

integer(int32)

false

none

»»»»» value

body

string¦null

false

none

»»»» source

body

RESTAPI.v1.DTOs.BPM.BPMComponentSourceDTO

false

none

»»»»» sourceID

body

integer(int32)¦null

false

none

»»»»» sourceReference

body

RESTAPI.v1.DTOs.BPM.BPMComponentSourceReferenceDTO

false

none

»»»»»» tableName

body

string¦null

false

none

»»»»»» calculationID

body

integer(int32)¦null

false

none

»»»»»» dataStoreID

body

integer(int32)¦null

false

none

»»»»»» planBuilderCalculationID

body

string¦null

false

none

»»»»» sourceFilters

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFiltersDTO

false

none

»»»»»» filters

body

[RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterDTO]¦null

false

none

»»»»»»» constraint

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterConstraintDTO

false

none

»»»»»»»» columnName

body

string¦null

false

none

»»»»»»»» operator

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterOperatorDTO

false

none

»»»»»»»»» type

body

string

false

none

»»»»»»»» value

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterValueDTO

false

none

»»»»»»»»» text

body

string¦null

false

none

»»»»»»»»» numeric

body

number(double)¦null

false

none

»»»»»»»»» date

body

string(date-time)¦null

false

none

»»»»»»»»» special

body

string¦null

false

none

»»»»»»»»» valueId

body

integer(int32)¦null

false

none

»»»»»»»»» rangeValue

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexRangeValueDTO

false

none

»»»»»»»»»» min

body

any

false

none

»»»»»»»»»» max

body

any

false

none

»»»»»»»» caseSensitive

body

boolean¦null

false

none

»»»»»»» and

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterAndDTO

false

none

»»»»»»»» filters

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»» or

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterOrDTO

false

none

»»»»»»»» filters

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»» not

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterNotDTO

false

none

»»»»»»»» filter

body

any

false

none

»»»»»»» metadata

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterMetaDataDTO

false

none

»»»»»»»» additionalProperties

body

any

false

none

»»»»» columns

body

[RESTAPI.v1.DTOs.BPM.BPMComponentSourceColumnDTO]¦null

false

none

»»»»»» columnName

body

string¦null

false

none

»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»» rowVersion

body

integer(int64)

false

none

»»»» config

body

RESTAPI.v1.DTOs.BPM.BPMComponentConfigDTO

false

none

»»»»» pickList

body

RESTAPI.v1.DTOs.BPM.BPMComponentPickListDTO

false

none

»»»»»» additionalProperties

body

any

false

none

»»»»»» placeholder

body

string¦null

false

none

»»»»»» sort

body

string¦null

false

none

»»»»»» parameterName

body

string¦null

false

none

»»»»»» userGenerated

body

boolean

false

none

»»»»»» hasError

body

boolean

false

none

»»»»»» required

body

boolean

false

none

»»»»»» enabled

body

boolean

false

none

»»»»»» visible

body

boolean

false

none

»»»»»» defaultValue

body

string¦null

false

none

»»»»» title

body

RESTAPI.v1.DTOs.BPM.BPMComponentTitleDTO

false

none

»»»»»» additionalProperties

body

any

false

none

»»»»»» content

body

string¦null

false

none

»»»»»» userGenerated

body

boolean

false

none

»»»»»» hasError

body

boolean

false

none

»»»»»» required

body

boolean

false

none

»»»»»» enabled

body

boolean

false

none

»»»»»» visible

body

boolean

false

none

»»»»»» defaultValue

body

string¦null

false

none

»»»»» subject

body

RESTAPI.v1.DTOs.BPM.BPMComponentSubjectDTO

false

none

»»»»»» additionalProperties

body

any

false

none

»»»»»» placeholder

body

string¦null

false

none

»»»»»» parameterName

body

string¦null

false

none

»»»»»» userGenerated

body

boolean

false

none

»»»»»» hasError

body

boolean

false

none

»»»»»» required

body

boolean

false

none

»»»»»» enabled

body

boolean

false

none

»»»»»» visible

body

boolean

false

none

»»»»»» defaultValue

body

string¦null

false

none

»»»»» description

body

RESTAPI.v1.DTOs.BPM.BPMComponentDescriptionDTO

false

none

»»»»»» additionalProperties

body

any

false

none

»»»»»» placeholder

body

string¦null

false

none

»»»»»» parameterName

body

string¦null

false

none

»»»»»» charLimit

body

integer(int32)

false

none

»»»»»» userGenerated

body

boolean

false

none

»»»»»» hasError

body

boolean

false

none

»»»»»» required

body

boolean

false

none

»»»»»» enabled

body

boolean

false

none

»»»»»» visible

body

boolean

false

none

»»»»»» defaultValue

body

string¦null

false

none

»»»»» text

body

RESTAPI.v1.DTOs.BPM.BPMComponentTextDTO

false

none

»»»»»» additionalProperties

body

any

false

none

»»»»»» placeholder

body

string¦null

false

none

»»»»»» charLimit

body

integer(int32)

false

none

»»»»»» content

body

string¦null

false

none

»»»»»» parameterName

body

string¦null

false

none

»»»»»» userGenerated

body

boolean

false

none

»»»»»» hasError

body

boolean

false

none

»»»»»» required

body

boolean

false

none

»»»»»» templateList

body

[RESTAPI.v1.DTOs.BPM.CommentTemplateDTO]¦null

false

none

»»»»»»» value

body

string¦null

false

none

»»»»»» enabled

body

boolean

false

none

»»»»»» visible

body

boolean

false

none

»»»»»» defaultValue

body

string¦null

false

none

»»»»» numeric

body

RESTAPI.v1.DTOs.BPM.BPMComponentNumericDTO

false

none

»»»»»» additionalProperties

body

any

false

none

»»»»»» placeholder

body

string¦null

false

none

»»»»»» charLimit

body

integer(int32)

false

none

»»»»»» content

body

string¦null

false

none

»»»»»» parameterName

body

string¦null

false

none

»»»»»» userGenerated

body

boolean

false

none

»»»»»» hasError

body

boolean

false

none

»»»»»» required

body

boolean

false

none

»»»»»» enabled

body

boolean

false

none

»»»»»» visible

body

boolean

false

none

»»»»»» defaultValue

body

integer(int32)

false

none

»»»»» sourcePickList

body

RESTAPI.v1.DTOs.BPM.BPMComponentSourcePickListDTO

false

none

»»»»»» additionalProperties

body

any

false

none

»»»»»» displayName

body

string¦null

false

none

»»»»»» displayColumn

body

string¦null

false

none

»»»»»» displayColumnDBType

body

string

false

none

»»»»»» idColumn

body

string¦null

false

none

»»»»»» idColumnDBType

body

string

false

none

»»»»»» placeholder

body

string¦null

false

none

»»»»»» sort

body

string¦null

false

none

»»»»»» sortOrder

body

string

false

none

»»»»»» parameterName

body

string¦null

false

none

»»»»»» hasError

body

boolean

false

none

»»»»»» required

body

boolean

false

none

»»»»»» userGenerated

body

boolean

false

none

»»»»»» hideIDColumn

body

boolean¦null

false

none

»»»»»» enabled

body

boolean

false

none

»»»»»» visible

body

boolean

false

none

»»»»»» defaultValue

body

string¦null

false

none

»»»» componentMappings

body

[RESTAPI.v1.DTOs.BPM.BPMAutoAdjustComponentMappingDTO]¦null

false

none

»»»»» nodeID

body

integer(int32)

false

none

»»»»» nodeName

body

string¦null

false

none

»»»»» tableName

body

string¦null

false

none

»»»»» columnName

body

string¦null

false

none

»»»»» dataType

body

string¦null

false

none

»»»»» isPrimaryKey

body

boolean

false

none

»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» bpmWorkflowPresenterFlexReportDTO

body

Varicent.RESTAPI.v1.DTOs.BPMWorkflowPresenterFlexReportDTO

false

none

»»» reportId

body

integer(int32)

false

none

»»» parameters

body

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowParameterDTO]¦null

false

none

»»» objectRestrictions

body

object¦null

false

none

»»»» additionalProperties

body

RESTAPI.v1.DTOs.BPM.BPMVisibilityEditabilityDTO

false

none

»»»»» visible

body

boolean

false

none

»»»»» editable

body

boolean

false

none

»» bpmWorkflowPlanDocPresenterFlexReportDTO

body

Varicent.RESTAPI.v1.DTOs.BPMWorkflowPlanDocPresenterFlexReportDTO

false

none

»»» reportId

body

integer(int32)

false

none

»»» parameters

body

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowParameterDTO]¦null

false

none

»»» templateType

body

string

false

none

»» assignedReports

body

[string]¦null

false

none

»» numReportsAssigned

body

integer(int32)

false

none

»» permissions

body

Varicent.RESTAPI.v1.DTOs.WorkflowPermissionsDTO

false

none

»»» advanceToken

body

[string]¦null

false

none

»»» viewDocuments

body

[string]¦null

false

none

»» parentFolder

body

Varicent.RESTAPI.v1.DTOs.BPMFolderDTO

false

none

»»» folderID

body

integer(int32)

false

none

»»» folderName

body

string¦null

false

none

»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» workflowType

body

string¦null

false

none

»» parameters

body

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowParameterDTO]¦null

false

none

»» layoutAssignment

body

object¦null

false

none

»»» additionalProperties

body

[RESTAPI.v1.DTOs.PairDTO2[System.Boolean,System.Boolean]](#schemarestapi.v1.dtos.pairdto2[system.boolean,system.boolean])

false

none

»» webReportID

body

integer(int32)

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

» swimLane

body

Varicent.RESTAPI.v1.DTOs.SwimLaneDTO

false

none

»» id

body

integer(int32)

false

none

»» order

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» description

body

string¦null

false

none

»» workflowID

body

integer(int32)

false

none

»» isSystemLane

body

boolean

false

none

»» isByRestriction

body

boolean

false

none

»» isAdmin

body

boolean

false

none

»» memberDefinition

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»»» alias

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» table

body

string¦null

false

none

»»»»» customSelect

body

string¦null

false

none

»»»»» dataType

body

string

false

none

»»»»» type

body

string

false

none

»»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»» expressionType

body

string

false

none

»»»»»» cases

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»»» expressionType

body

string

false

none

»»»»»»» cases

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» arguments

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»» constraintType

body

string

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»» condition

body

any

false

none

»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»» literalType

body

string

false

none

»»»»»»»»» value

body

any

false

none

»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»» constraints

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» literalRight

body

any

false

none

»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» right

body

any

false

none

»»»»»»»» expressionLeft

body

any

false

none

»»»»»»»» expressionRight

body

any

false

none

»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»» like

body

string¦null

false

none

»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»»» trueValue

body

any

false

none

»»»»»»» falseValue

body

any

false

none

»»»»»»» isDate

body

boolean

false

none

»»»»»»» literalType

body

string

false

none

»»»»»»» value

body

any

false

none

»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» isDate

body

boolean

false

none

»»»»»» literalType

body

string

false

none

»»»»»» value

body

any

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»»» m_namespace

body

string¦null

false

none

»»»»»» name

body

string¦null

false

none

»»»»» query

body

any

false

none

»»»»» alias

body

string¦null

false

none

»»»»» sourceType

body

string

false

none

»»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»» joinType

body

string

false

none

»»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»» constraintType

body

string

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»» caseSensitive

body

boolean

false

none

»»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»» like

body

string¦null

false

none

»»»»»» escapeWildcards

body

boolean

false

none

»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» queryDefinitionRight

body

any

false

none

»»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» direction

body

string

false

none

»»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»» distinct

body

boolean

false

none

»»»» unionWith

body

any

false

none

»»»» exceptWith

body

any

false

none

»»» sourceNames

body

object¦null

false

none

»»»» additionalProperties

body

string¦null

false

none

»» payeeIDs

body

[string]¦null

false

none

»» queryDelta

body

Varicent.RESTAPI.v1.DTOs.QueryDeltaDTO

false

none

»»» modification

body

[Varicent.RESTAPI.v1.DTOs.Core.CollectionModificationDTO1[System.String]](#schemavaricent.restapi.v1.dtos.core.collectionmodificationdto1[system.string])

false

none

»»»» itemsToAdd

body

[string]¦null

false

none

»»»» itemsToRemove

body

[string]¦null

false

none

»»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»» selectAllRows

body

boolean¦null

false

none

»» adminIDs

body

[string]¦null

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

» swimLaneMemberSetModification

body

[Varicent.RESTAPI.v1.DTOs.Core.CollectionModificationDTO1[System.String]](#schemavaricent.restapi.v1.dtos.core.collectionmodificationdto1[system.string])

false

none

» parentFolderId

body

integer(int32)

false

none

» order

body

integer(int32)

false

none

» parentFolderRowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

» webReportRowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

» presenterflexReportRowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

»» workflowState

Stopped

»» workflowState

Started

»» workflowState

Stopping

»» workflowState

Starting

»» workflowState

Archived

»» workflowState

Draft

»»» variableType

Text

»»» variableType

Date

»»» variableType

Numeric

»» workflowType

PresenterReport

»» workflowType

Inquiry

»» workflowType

PlanApproval

»» workflowType

PresenterFlexReport

»» workflowType

PlanDocument

»»»» paramType

Text

»»»» paramType

Date

»»»» paramType

Numeric

»»»» valueType

Constant

»»»» valueType

Value

»»»» type

pickList

»»»» type

title

»»»» type

subject

»»»» type

description

»»»» type

text

»»»» type

numeric

»»»» type

sourcePickList

»»»»»»»»» type

Equals

»»»»»»»»» type

NotEquals

»»»»»»»»» type

LessThan

»»»»»»»»» type

LessThanEquals

»»»»»»»»» type

GreaterThan

»»»»»»»»» type

GreaterThanEquals

»»»»»»»»» type

IsNull

»»»»»»»»» type

IsNotNull

»»»»»»»»» type

Contains

»»»»»»»»» type

NotContains

»»»»»»»»» type

StartWith

»»»»»»»»» type

EndWith

»»»»»»»»» type

InRange

»»»»»»»»» type

InArray

»»»»»»»»» type

NotInArray

»»»»»»»»» special

CurrentWebUser

»»»»»»»»» special

CurrentDate

»»»»»»»»» special

CurrentRowValue

»»»»»»»»» special

WorkflowFormID

»»»»»» displayColumnDBType

String

»»»»»» displayColumnDBType

LongString

»»»»»» displayColumnDBType

MaxString

»»»»»» displayColumnDBType

Date

»»»»»» displayColumnDBType

DateTime

»»»»»» displayColumnDBType

Decimal

»»»»»» displayColumnDBType

Int

»»»»»» displayColumnDBType

Long

»»»»»» displayColumnDBType

Float

»»»»»» displayColumnDBType

BLOB

»»»»»» displayColumnDBType

Identity

»»»»»» displayColumnDBType

CLOB

»»»»»» displayColumnDBType

RowVersion

»»»»»» displayColumnDBType

UID

»»»»»» displayColumnDBType

VarCharMax

»»»»»» displayColumnDBType

Boolean

»»»»»» idColumnDBType

String

»»»»»» idColumnDBType

LongString

»»»»»» idColumnDBType

MaxString

»»»»»» idColumnDBType

Date

»»»»»» idColumnDBType

DateTime

»»»»»» idColumnDBType

Decimal

»»»»»» idColumnDBType

Int

»»»»»» idColumnDBType

Long

»»»»»» idColumnDBType

Float

»»»»»» idColumnDBType

BLOB

»»»»»» idColumnDBType

Identity

»»»»»» idColumnDBType

CLOB

»»»»»» idColumnDBType

RowVersion

»»»»»» idColumnDBType

UID

»»»»»» idColumnDBType

VarCharMax

»»»»»» idColumnDBType

Boolean

»»»»»» sortOrder

Ascending

»»»»»» sortOrder

Descending

»»»»»» sortOrder

AscendingNullsFirst

»»»»»» sortOrder

DescendingNullsLast

»»» templateType

Payee

»»» templateType

ManagerPayee

»»» templateType

Custom

»»» advanceToken

Start

»»» advanceToken

End

»»» advanceToken

Action

»»» advanceToken

Alert

»»» advanceToken

Process

»»» advanceToken

Conditional

»»» advanceToken

AutoAdjust

»»» advanceToken

GeneratePdf

»»» advanceToken

Sign

»»» viewDocuments

Start

»»» viewDocuments

End

»»» viewDocuments

Action

»»» viewDocuments

Alert

»»» viewDocuments

Process

»»» viewDocuments

Conditional

»»» viewDocuments

AutoAdjust

»»» viewDocuments

GeneratePdf

»»» viewDocuments

Sign

»»» workflowType

PresenterReport

»»» workflowType

Inquiry

»»» workflowType

PlanApproval

»»» workflowType

PresenterFlexReport

»»» workflowType

PlanDocument

»»»»» dataType

Int

»»»»» dataType

Decimal

»»»»» dataType

DateTime

»»»»» dataType

None

»»»»» dataType

String

»»»»» type

SelectAll

»»»»» type

SelectItem

»»»»» type

SelectLiteral

»»»»» type

SelectCustom

»»»»» type

SelectExpression

»»»»»» expressionType

caseExpression

»»»»»» expressionType

dataField

»»»»»» expressionType

function

»»»»»» expressionType

ifExpression

»»»»»» expressionType

literal

»»»»»»» expressionType

caseExpression

»»»»»»» expressionType

dataField

»»»»»»» expressionType

function

»»»»»»» expressionType

ifExpression

»»»»»»» expressionType

literal

»»»»»»»» constraintType

clause

»»»»»»»» constraintType

constraint

»»»»»»»» constraintType

expressionConstraint

»»»»»»»» constraintType

likeConstraint

»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»» constraintType

subQueryConstraint

»»»»»»»»» expressionType

caseExpression

»»»»»»»»» expressionType

dataField

»»»»»»»»» expressionType

function

»»»»»»»»» expressionType

ifExpression

»»»»»»»»» expressionType

literal

»»»»»»»»» literalType

Integer

»»»»»»»»» literalType

Decimal

»»»»»»»»» literalType

Date

»»»»»»»»» literalType

DateTime

»»»»»»»»» literalType

String

»»»»»»»»» literalType

Float

»»»»»»»»» literalType

Long

»»»»»»»»» literalType

Null

»»»»»»»»» literalType

Parameter

»»»»»»»»» literalType

Guid

»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»» literalType

Boolean

»»»»»»» literalType

Integer

»»»»»»» literalType

Decimal

»»»»»»» literalType

Date

»»»»»»» literalType

DateTime

»»»»»»» literalType

String

»»»»»»» literalType

Float

»»»»»»» literalType

Long

»»»»»»» literalType

Null

»»»»»»» literalType

Parameter

»»»»»»» literalType

Guid

»»»»»»» literalType

SystemUtcTime

»»»»»»» literalType

Boolean

»»»»»» literalType

Integer

»»»»»» literalType

Decimal

»»»»»» literalType

Date

»»»»»» literalType

DateTime

»»»»»» literalType

String

»»»»»» literalType

Float

»»»»»» literalType

Long

»»»»»» literalType

Null

»»»»»» literalType

Parameter

»»»»»» literalType

Guid

»»»»»» literalType

SystemUtcTime

»»»»»» literalType

Boolean

»»»»» sourceType

Table

»»»»» sourceType

Query

»»»»» joinType

Inner

»»»»» joinType

Left

»»»»» joinType

Right

»»»»» joinType

Cross

»»»»» joinType

CrossApply

»»»»» joinType

OuterApply

»»»»»» constraintType

clause

»»»»»» constraintType

constraint

»»»»»» constraintType

expressionConstraint

»»»»»» constraintType

likeConstraint

»»»»»» constraintType

rowVersionConstraint

»»»»»» constraintType

subQueryConstraint

»»»»» direction

Ascending

»»»»» direction

Descending

»»»»» direction

AscendingNullsFirst

»»»»» direction

DescendingNullsLast

Responses

Status

Meaning

Description

Schema

201

Created

Created

RESTAPI.v1.DTOs.TreeNodeDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/workflowmanager/workflows", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/workflows");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "workflow": {
    "id": 0,
    "name": "string",
    "description": "string",
    "isSingleInstance": true,
    "workflowState": "Stopped",
    "conditionalVars": [
      {}
    ],
    "columnCount": 0,
    "workflowConfig": {
      "pendingWorkflowEnabled": true
    },
    "runCount": 0,
    "runDate": "string",
    "runBy": "string",
    "lastActioned": "string",
    "workflowType": "PresenterReport",
    "webReport": {
      "parameters": [],
      "layoutAssignment": {},
      "webReportID": 0
    },
    "inquiry": {
      "hasRun": true,
      "components": []
    },
    "bpmWorkflowPresenterFlexReportDTO": {
      "reportId": 0,
      "parameters": [],
      "objectRestrictions": {}
    },
    "bpmWorkflowPlanDocPresenterFlexReportDTO": {
      "reportId": 0,
      "parameters": [],
      "templateType": "Payee"
    },
    "assignedReports": [
      "string"
    ],
    "numReportsAssigned": 0,
    "permissions": {
      "advanceToken": [],
      "viewDocuments": []
    },
    "parentFolder": {
      "folderID": 0,
      "folderName": "string",
      "rowVersion": {},
      "workflowType": "PresenterReport"
    },
    "parameters": [
      {}
    ],
    "layoutAssignment": {
      "property1": {},
      "property2": {}
    },
    "webReportID": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "swimLane": {
    "id": 0,
    "order": 0,
    "name": "string",
    "description": "string",
    "workflowID": 0,
    "isSystemLane": true,
    "isByRestriction": true,
    "isAdmin": true,
    "memberDefinition": {
      "query": {},
      "sourceNames": {}
    },
    "payeeIDs": [
      "string"
    ],
    "queryDelta": {
      "modification": {},
      "query": {},
      "selectAllRows": true
    },
    "adminIDs": [
      "string"
    ],
    "version": {
      "rowVersion": 0
    }
  },
  "swimLaneMemberSetModification": {
    "itemsToAdd": [
      "string"
    ],
    "itemsToRemove": [
      "string"
    ]
  },
  "parentFolderId": 0,
  "order": 0,
  "parentFolderRowVersion": {
    "rowVersion": 0
  },
  "webReportRowVersion": {
    "rowVersion": 0
  },
  "presenterflexReportRowVersion": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflowmanager/workflows',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/workflowmanager/workflows', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/workflowmanager/workflows',
  params: {
  }, headers: headers

p JSON.parse(result)

Get swim lanes for a specific workflow.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.SwimLaneDTO]

false

none

none

» id

integer(int32)

false

none

none

» order

integer(int32)

false

none

none

» name

string¦null

false

none

none

» description

string¦null

false

none

none

» workflowID

integer(int32)

false

none

none

» isSystemLane

boolean

false

none

none

» isByRestriction

boolean

false

none

none

» isAdmin

boolean

false

none

none

» memberDefinition

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

»» query

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

»»» selectItems

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

none

»»»» alias

string¦null

false

none

none

»»»» column

string¦null

false

none

none

»»»» table

string¦null

false

none

none

»»»» customSelect

string¦null

false

none

none

»»»» dataType

string

false

none

none

»»»» type

string

false

none

none

»»»» value

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»» expressionType

string

false

none

none

»»»»» cases

array¦null

false

none

none

»»»»»» anonymous

any

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» column

string¦null

false

none

none

»»»»» op

string¦null

false

none

none

»»»»» arguments

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

none

[DTO version of IExpression]

»»»»»» expressionType

string

false

none

none

»»»»»» cases

array¦null

false

none

none

»»»»»»» anonymous

any

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» column

string¦null

false

none

none

»»»»»» op

string¦null

false

none

none

»»»»»» arguments

array¦null

false

none

none

»»»»»»» anonymous

any

false

none

none

»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»»» constraintType

string

false

none

none

»»»»»»» op

string¦null

false

none

none

»»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»» expressionType

string

false

none

none

»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» table

string¦null

false

none

none

»»»»»»»» column

string¦null

false

none

none

»»»»»»»» op

string¦null

false

none

none

»»»»»»»» arguments

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» condition

any

false

none

none

»»»»»»»» trueValue

any

false

none

none

»»»»»»»» falseValue

any

false

none

none

»»»»»»»» isDate

boolean

false

none

none

»»»»»»»» literalType

string

false

none

none

»»»»»»»» value

any

false

none

none

»»»»»»» caseSensitive

boolean

false

none

none

»»»»»»» constraints

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»»» literalRight

any

false

none

none

»»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»» right

any

false

none

none

»»»»»»» expressionLeft

any

false

none

none

»»»»»»» expressionRight

any

false

none

none

»»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»»» like

string¦null

false

none

none

»»»»»»» escapeWildcards

boolean

false

none

none

»»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»»» rowVersion

integer(int64)

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» queryDefinitionRight

any

false

none

none

»»»»»» trueValue

any

false

none

none

»»»»»» falseValue

any

false

none

none

»»»»»» isDate

boolean

false

none

none

»»»»»» literalType

string

false

none

none

»»»»»» value

any

false

none

none

»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»» trueValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» falseValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» isDate

boolean

false

none

none

»»»»» literalType

string

false

none

none

»»»»» value

any

false

none

none

»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»» namespaceTable

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

none

»»»»» m_namespace

string¦null

false

none

none

»»»»» name

string¦null

false

none

none

»»»» query

any

false

none

none

»»»» alias

string¦null

false

none

none

»»»» sourceType

string

false

none

none

»»» joins

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

none

»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»» joinType

string

false

none

none

»»»» onClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»» constraintType

string

false

none

none

»»»»» op

string¦null

false

none

none

»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»» caseSensitive

boolean

false

none

none

»»»»» constraints

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

none

[DTO version of IConstraint]

»»»»» literalRight

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»» right

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» expressionLeft

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» expressionRight

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» isPreciseDecimal

boolean

false

none

none

»»»»» like

string¦null

false

none

none

»»»»» escapeWildcards

boolean

false

none

none

»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» queryDefinitionRight

any

false

none

none

»»» whereClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»» order

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

none

»»»» table

string¦null

false

none

none

»»»» column

string¦null

false

none

none

»»»» direction

string

false

none

none

»»» group

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

none

»»»» table

string¦null

false

none

none

»»»» column

string¦null

false

none

none

»»» havingClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»» distinct

boolean

false

none

none

»»» unionWith

any

false

none

none

»»» exceptWith

any

false

none

none

»» sourceNames

object¦null

false

none

none

»»» additionalProperties

string¦null

false

none

none

» payeeIDs

[string]¦null

false

none

none

» queryDelta

Varicent.RESTAPI.v1.DTOs.QueryDeltaDTO

false

none

none

»» modification

[Varicent.RESTAPI.v1.DTOs.Core.CollectionModificationDTO1[System.String]](#schemavaricent.restapi.v1.dtos.core.collectionmodificationdto1[system.string])

false

none

none

»»» itemsToAdd

[string]¦null

false

none

none

»»» itemsToRemove

[string]¦null

false

none

none

»» query

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

»» selectAllRows

boolean¦null

false

none

none

» adminIDs

[string]¦null

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

dataType

Int

dataType

Decimal

dataType

DateTime

dataType

None

dataType

String

type

SelectAll

type

SelectItem

type

SelectLiteral

type

SelectCustom

type

SelectExpression

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

sourceType

Table

sourceType

Query

joinType

Inner

joinType

Left

joinType

Right

joinType

Cross

joinType

CrossApply

joinType

OuterApply

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

direction

Ascending

direction

Descending

direction

AscendingNullsFirst

direction

DescendingNullsLast

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workflowmanager/workflows/{id}/swimlanes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/workflows/{id}/swimlanes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflowmanager/workflows/{id}/swimlanes',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/workflowmanager/workflows/{id}/swimlanes', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/workflowmanager/workflows/{id}/swimlanes',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "order": 0,
    "name": "string",
    "description": "string",
    "workflowID": 0,
    "isSystemLane": true,
    "isByRestriction": true,
    "isAdmin": true,
    "memberDefinition": {
      "query": {},
      "sourceNames": {}
    },
    "payeeIDs": [
      "string"
    ],
    "queryDelta": {
      "modification": {},
      "query": {},
      "selectAllRows": true
    },
    "adminIDs": [
      "string"
    ],
    "version": {
      "rowVersion": 0
    }
  }
]
[{"id":0,"order":0,"name":"string","description":"string","workflowID":0,"isSystemLane":true,"isByRestriction":true,"isAdmin":true,"memberDefinition":{"query":{},"sourceNames":{}},"payeeIDs":["string"],"queryDelta":{"modification":{},"query":{},"selectAllRows":true},"adminIDs":["string"],"version":{"rowVersion":0}}]

Update swim lanes.

Body parameter

[
  {
    "id": 0,
    "order": 0,
    "name": "string",
    "description": "string",
    "workflowID": 0,
    "isSystemLane": true,
    "isByRestriction": true,
    "isAdmin": true,
    "memberDefinition": {
      "query": {},
      "sourceNames": {}
    },
    "payeeIDs": [
      "string"
    ],
    "queryDelta": {
      "modification": {},
      "query": {},
      "selectAllRows": true
    },
    "adminIDs": [
      "string"
    ],
    "version": {
      "rowVersion": 0
    }
  }
]

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.SwimLaneDTO

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.SwimLaneDTO]

false

none

none

» id

integer(int32)

false

none

none

» order

integer(int32)

false

none

none

» name

string¦null

false

none

none

» description

string¦null

false

none

none

» workflowID

integer(int32)

false

none

none

» isSystemLane

boolean

false

none

none

» isByRestriction

boolean

false

none

none

» isAdmin

boolean

false

none

none

» memberDefinition

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

»» query

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

»»» selectItems

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

none

»»»» alias

string¦null

false

none

none

»»»» column

string¦null

false

none

none

»»»» table

string¦null

false

none

none

»»»» customSelect

string¦null

false

none

none

»»»» dataType

string

false

none

none

»»»» type

string

false

none

none

»»»» value

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»» expressionType

string

false

none

none

»»»»» cases

array¦null

false

none

none

»»»»»» anonymous

any

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» column

string¦null

false

none

none

»»»»» op

string¦null

false

none

none

»»»»» arguments

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

none

[DTO version of IExpression]

»»»»»» expressionType

string

false

none

none

»»»»»» cases

array¦null

false

none

none

»»»»»»» anonymous

any

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» column

string¦null

false

none

none

»»»»»» op

string¦null

false

none

none

»»»»»» arguments

array¦null

false

none

none

»»»»»»» anonymous

any

false

none

none

»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»»» constraintType

string

false

none

none

»»»»»»» op

string¦null

false

none

none

»»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»» expressionType

string

false

none

none

»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» table

string¦null

false

none

none

»»»»»»»» column

string¦null

false

none

none

»»»»»»»» op

string¦null

false

none

none

»»»»»»»» arguments

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» condition

any

false

none

none

»»»»»»»» trueValue

any

false

none

none

»»»»»»»» falseValue

any

false

none

none

»»»»»»»» isDate

boolean

false

none

none

»»»»»»»» literalType

string

false

none

none

»»»»»»»» value

any

false

none

none

»»»»»»» caseSensitive

boolean

false

none

none

»»»»»»» constraints

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»»» literalRight

any

false

none

none

»»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»» right

any

false

none

none

»»»»»»» expressionLeft

any

false

none

none

»»»»»»» expressionRight

any

false

none

none

»»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»»» like

string¦null

false

none

none

»»»»»»» escapeWildcards

boolean

false

none

none

»»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»»» rowVersion

integer(int64)

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» queryDefinitionRight

any

false

none

none

»»»»»» trueValue

any

false

none

none

»»»»»» falseValue

any

false

none

none

»»»»»» isDate

boolean

false

none

none

»»»»»» literalType

string

false

none

none

»»»»»» value

any

false

none

none

»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»» trueValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» falseValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» isDate

boolean

false

none

none

»»»»» literalType

string

false

none

none

»»»»» value

any

false

none

none

»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»» namespaceTable

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

none

»»»»» m_namespace

string¦null

false

none

none

»»»»» name

string¦null

false

none

none

»»»» query

any

false

none

none

»»»» alias

string¦null

false

none

none

»»»» sourceType

string

false

none

none

»»» joins

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

none

»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»» joinType

string

false

none

none

»»»» onClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»» constraintType

string

false

none

none

»»»»» op

string¦null

false

none

none

»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»» caseSensitive

boolean

false

none

none

»»»»» constraints

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

none

[DTO version of IConstraint]

»»»»» literalRight

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»» right

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» expressionLeft

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» expressionRight

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» isPreciseDecimal

boolean

false

none

none

»»»»» like

string¦null

false

none

none

»»»»» escapeWildcards

boolean

false

none

none

»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» queryDefinitionRight

any

false

none

none

»»» whereClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»» order

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

none

»»»» table

string¦null

false

none

none

»»»» column

string¦null

false

none

none

»»»» direction

string

false

none

none

»»» group

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

none

»»»» table

string¦null

false

none

none

»»»» column

string¦null

false

none

none

»»» havingClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»» distinct

boolean

false

none

none

»»» unionWith

any

false

none

none

»»» exceptWith

any

false

none

none

»» sourceNames

object¦null

false

none

none

»»» additionalProperties

string¦null

false

none

none

» payeeIDs

[string]¦null

false

none

none

» queryDelta

Varicent.RESTAPI.v1.DTOs.QueryDeltaDTO

false

none

none

»» modification

[Varicent.RESTAPI.v1.DTOs.Core.CollectionModificationDTO1[System.String]](#schemavaricent.restapi.v1.dtos.core.collectionmodificationdto1[system.string])

false

none

none

»»» itemsToAdd

[string]¦null

false

none

none

»»» itemsToRemove

[string]¦null

false

none

none

»» query

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

»» selectAllRows

boolean¦null

false

none

none

» adminIDs

[string]¦null

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

dataType

Int

dataType

Decimal

dataType

DateTime

dataType

None

dataType

String

type

SelectAll

type

SelectItem

type

SelectLiteral

type

SelectCustom

type

SelectExpression

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

sourceType

Table

sourceType

Query

joinType

Inner

joinType

Left

joinType

Right

joinType

Cross

joinType

CrossApply

joinType

OuterApply

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

direction

Ascending

direction

Descending

direction

AscendingNullsFirst

direction

DescendingNullsLast

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/workflowmanager/workflows/{id}/swimlanes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/workflows/{id}/swimlanes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "id": 0,
    "order": 0,
    "name": "string",
    "description": "string",
    "workflowID": 0,
    "isSystemLane": true,
    "isByRestriction": true,
    "isAdmin": true,
    "memberDefinition": {
      "query": {},
      "sourceNames": {}
    },
    "payeeIDs": [
      "string"
    ],
    "queryDelta": {
      "modification": {},
      "query": {},
      "selectAllRows": true
    },
    "adminIDs": [
      "string"
    ],
    "version": {
      "rowVersion": 0
    }
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflowmanager/workflows/{id}/swimlanes',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/workflowmanager/workflows/{id}/swimlanes', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/workflowmanager/workflows/{id}/swimlanes',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "order": 0,
    "name": "string",
    "description": "string",
    "workflowID": 0,
    "isSystemLane": true,
    "isByRestriction": true,
    "isAdmin": true,
    "memberDefinition": {
      "query": {},
      "sourceNames": {}
    },
    "payeeIDs": [
      "string"
    ],
    "queryDelta": {
      "modification": {},
      "query": {},
      "selectAllRows": true
    },
    "adminIDs": [
      "string"
    ],
    "version": {
      "rowVersion": 0
    }
  }
]
[{"id":0,"order":0,"name":"string","description":"string","workflowID":0,"isSystemLane":true,"isByRestriction":true,"isAdmin":true,"memberDefinition":{"query":{},"sourceNames":{}},"payeeIDs":["string"],"queryDelta":{"modification":{},"query":{},"selectAllRows":true},"adminIDs":["string"],"version":{"rowVersion":0}}]

Copy workflows.

Body parameter

[
  {
    "workflow": {
      "id": 0,
      "name": "string",
      "description": "string",
      "isSingleInstance": true,
      "workflowState": "Stopped",
      "conditionalVars": [],
      "columnCount": 0,
      "workflowConfig": {},
      "runCount": 0,
      "runDate": "string",
      "runBy": "string",
      "lastActioned": "string",
      "workflowType": "PresenterReport",
      "webReport": {},
      "inquiry": {},
      "bpmWorkflowPresenterFlexReportDTO": {},
      "bpmWorkflowPlanDocPresenterFlexReportDTO": {},
      "assignedReports": [],
      "numReportsAssigned": 0,
      "permissions": {},
      "parentFolder": {},
      "parameters": [],
      "layoutAssignment": {},
      "webReportID": 0,
      "version": {}
    },
    "parentFolderId": 0,
    "parentFolderRowVersion": {
      "rowVersion": 0
    },
    "source": 0
  }
]

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.DuplicateBPMWorkflowDTO

false

none

Responses

Status

Meaning

Description

Schema

201

Created

Created

RESTAPI.v1.DTOs.TreeNodeDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/workflowmanager/workflows/bulkDuplicate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/workflows/bulkDuplicate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "workflow": {
      "id": 0,
      "name": "string",
      "description": "string",
      "isSingleInstance": true,
      "workflowState": "Stopped",
      "conditionalVars": [],
      "columnCount": 0,
      "workflowConfig": {},
      "runCount": 0,
      "runDate": "string",
      "runBy": "string",
      "lastActioned": "string",
      "workflowType": "PresenterReport",
      "webReport": {},
      "inquiry": {},
      "bpmWorkflowPresenterFlexReportDTO": {},
      "bpmWorkflowPlanDocPresenterFlexReportDTO": {},
      "assignedReports": [],
      "numReportsAssigned": 0,
      "permissions": {},
      "parentFolder": {},
      "parameters": [],
      "layoutAssignment": {},
      "webReportID": 0,
      "version": {}
    },
    "parentFolderId": 0,
    "parentFolderRowVersion": {
      "rowVersion": 0
    },
    "source": 0
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflowmanager/workflows/bulkDuplicate',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/workflowmanager/workflows/bulkDuplicate', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/workflowmanager/workflows/bulkDuplicate',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "node": null,
  "children": []
}
{"node":null,"children":[]}

Create a folder.

Body parameter

{
  "folder": {
    "node": null,
    "children": []
  },
  "order": 0,
  "parentFolderRowVersion": {
    "rowVersion": 0
  },
  "workflowType": "PresenterReport"
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.CreateBPMFolderDTO

false

none

» folder

body

RESTAPI.v1.DTOs.TreeNodeDTO

false

none

»» node

body

any

false

none

»» children

body

array¦null

false

none

»»» anonymous

body

any

false

none

» order

body

integer(int32)

false

none

» parentFolderRowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

» workflowType

body

string¦null

false

none

Enumerated Values

Parameter

Value

» workflowType

PresenterReport

» workflowType

Inquiry

» workflowType

PlanApproval

» workflowType

PresenterFlexReport

» workflowType

PlanDocument

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.TreeNodeDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/workflowmanager/folders", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/folders");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "folder": {
    "node": null,
    "children": []
  },
  "order": 0,
  "parentFolderRowVersion": {
    "rowVersion": 0
  },
  "workflowType": "PresenterReport"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflowmanager/folders',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/workflowmanager/folders', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/workflowmanager/folders',
  params: {
  }, headers: headers

p JSON.parse(result)

Delete workflows.

Body parameter

[
  {
    "workflow": {
      "workflow": {},
      "parentFolderId": 0
    },
    "parentFolderRowVersion": {
      "rowVersion": 0
    }
  }
]

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.DeleteBPMWorkflowDTO

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.TreeNodeDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/workflowmanager/workflows/bulkDelete", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/workflows/bulkDelete");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "workflow": {
      "workflow": {},
      "parentFolderId": 0
    },
    "parentFolderRowVersion": {
      "rowVersion": 0
    }
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflowmanager/workflows/bulkDelete',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.delete('http://localhost:8080/api/v1/workflowmanager/workflows/bulkDelete', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.delete 'http://localhost:8080/api/v1/workflowmanager/workflows/bulkDelete',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "node": null,
  "children": []
}
{"node":null,"children":[]}

Delete a folder.

Body parameter

{
  "folder": {
    "node": null,
    "children": []
  },
  "parentFolderRowVersion": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.DeleteBPMFolderDTO

false

none

» folder

body

RESTAPI.v1.DTOs.TreeNodeDTO

false

none

»» node

body

any

false

none

»» children

body

array¦null

false

none

»»» anonymous

body

any

false

none

» parentFolderRowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/internal/plandocument/folders/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plandocument/folders/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "folder": {
    "node": null,
    "children": []
  },
  "parentFolderRowVersion": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/internal/plandocument/folders/{id}',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.delete('http://localhost:8080/api/internal/plandocument/folders/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.delete 'http://localhost:8080/api/internal/plandocument/folders/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

Update a folder.

Body parameter

{
  "folder": {
    "node": null,
    "children": []
  },
  "oldOrder": 0,
  "newOrder": 0,
  "oldParentFolderRowVersion": {
    "rowVersion": 0
  },
  "newParentFolderRowVersion": {
    "rowVersion": 0
  },
  "workflowType": "PresenterReport"
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.UpdateBPMFolderDTO

false

none

» folder

body

RESTAPI.v1.DTOs.TreeNodeDTO

false

none

»» node

body

any

false

none

»» children

body

array¦null

false

none

»»» anonymous

body

any

false

none

» oldOrder

body

integer(int32)

false

none

» newOrder

body

integer(int32)

false

none

» oldParentFolderRowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

» newParentFolderRowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

» workflowType

body

string¦null

false

none

Enumerated Values

Parameter

Value

» workflowType

PresenterReport

» workflowType

Inquiry

» workflowType

PlanApproval

» workflowType

PresenterFlexReport

» workflowType

PlanDocument

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.TreeNodeDTO]

false

none

none

» node

any

false

none

none

» children

array¦null

false

none

none

»» anonymous

any

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/workflowmanager/folders/{id}/foldernode", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/folders/{id}/foldernode");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "folder": {
    "node": null,
    "children": []
  },
  "oldOrder": 0,
  "newOrder": 0,
  "oldParentFolderRowVersion": {
    "rowVersion": 0
  },
  "newParentFolderRowVersion": {
    "rowVersion": 0
  },
  "workflowType": "PresenterReport"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflowmanager/folders/{id}/foldernode',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/workflowmanager/folders/{id}/foldernode', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/workflowmanager/folders/{id}/foldernode',
  params: {
  }, headers: headers

p JSON.parse(result)

Update workflows.

Body parameter

[
  {
    "workflow": {
      "workflow": {},
      "parentFolderId": 0
    },
    "oldOrder": 0,
    "newOrder": 0,
    "oldParentFolderRowVersion": {
      "rowVersion": 0
    },
    "newParentFolderRowVersion": {
      "rowVersion": 0
    }
  }
]

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.UpdateBPMWorkflowDTO

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.TreeNodeDTO]

false

none

none

» node

any

false

none

none

» children

array¦null

false

none

none

»» anonymous

any

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/workflowmanager/workflows/bulkMove/foldernode", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/workflows/bulkMove/foldernode");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "workflow": {
      "workflow": {},
      "parentFolderId": 0
    },
    "oldOrder": 0,
    "newOrder": 0,
    "oldParentFolderRowVersion": {
      "rowVersion": 0
    },
    "newParentFolderRowVersion": {
      "rowVersion": 0
    }
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflowmanager/workflows/bulkMove/foldernode',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/workflowmanager/workflows/bulkMove/foldernode', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/workflowmanager/workflows/bulkMove/foldernode',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "node": null,
    "children": []
  }
]
[{"node":null,"children":[]}]

Update a workflow on canvas page.

Body parameter

{
  "id": 0,
  "name": "string",
  "description": "string",
  "isSingleInstance": true,
  "workflowState": "Stopped",
  "conditionalVars": [
    {
      "expressionName": "string",
      "name": "string",
      "variableType": "Text"
    }
  ],
  "columnCount": 0,
  "workflowConfig": {
    "pendingWorkflowEnabled": true
  },
  "runCount": 0,
  "runDate": "string",
  "runBy": "string",
  "lastActioned": "string",
  "workflowType": "PresenterReport",
  "webReport": {
    "parameters": [
      {}
    ],
    "layoutAssignment": {
      "property1": {},
      "property2": {}
    },
    "webReportID": 0
  },
  "inquiry": {
    "hasRun": true,
    "components": [
      {}
    ]
  },
  "bpmWorkflowPresenterFlexReportDTO": {
    "reportId": 0,
    "parameters": [
      {}
    ],
    "objectRestrictions": {
      "property1": {},
      "property2": {}
    }
  },
  "bpmWorkflowPlanDocPresenterFlexReportDTO": {
    "reportId": 0,
    "parameters": [
      {}
    ],
    "templateType": "Payee"
  },
  "assignedReports": [
    "string"
  ],
  "numReportsAssigned": 0,
  "permissions": {
    "advanceToken": [
      "Start"
    ],
    "viewDocuments": [
      "Start"
    ]
  },
  "parentFolder": {
    "folderID": 0,
    "folderName": "string",
    "rowVersion": {
      "rowVersion": 0
    },
    "workflowType": "PresenterReport"
  },
  "parameters": [
    {
      "paramName": "string",
      "value": "string",
      "paramType": "Text",
      "valueType": "Constant",
      "usesReportValue": true,
      "isRequired": true
    }
  ],
  "layoutAssignment": {
    "property1": {
      "first": true,
      "second": true
    },
    "property2": {
      "first": true,
      "second": true
    }
  },
  "webReportID": 0,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.BPMWorkflowDTO

false

none

» id

body

integer(int32)

false

none

» name

body

string¦null

false

none

» description

body

string¦null

false

none

» isSingleInstance

body

boolean

false

none

» workflowState

body

string

false

none

» conditionalVars

body

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowConditionVariableDTO]¦null

false

none

»» expressionName

body

string¦null

false

none

»» name

body

string¦null

false

none

»» variableType

body

string

false

none

» columnCount

body

integer(int32)

false

none

» workflowConfig

body

RESTAPI.v1.DTOs.BPMWorkflowConfigDTO

false

none

»» pendingWorkflowEnabled

body

boolean

false

none

» runCount

body

integer(int32)

false

none

» runDate

body

string¦null

false

none

» runBy

body

string¦null

false

none

» lastActioned

body

string¦null

false

none

» workflowType

body

string

false

none

» webReport

body

Varicent.RESTAPI.v1.DTOs.BPMWorkflowWebReportDTO

false

none

»» parameters

body

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowParameterDTO]¦null

false

none

»»» paramName

body

string¦null

false

none

»»» value

body

string¦null

false

none

»»» paramType

body

string

false

none

»»» valueType

body

string

false

none

»»» usesReportValue

body

boolean

false

none

»»» isRequired

body

boolean

false

none

»» layoutAssignment

body

object¦null

false

none

»»» additionalProperties

body

[RESTAPI.v1.DTOs.PairDTO2[System.Boolean,System.Boolean]](#schemarestapi.v1.dtos.pairdto2[system.boolean,system.boolean])

false

none

»»»» first

body

boolean

false

none

»»»» second

body

boolean

false

none

»» webReportID

body

integer(int32)

false

none

» inquiry

body

Varicent.RESTAPI.v1.DTOs.BPMWorkflowInquiryDTO

false

none

»» hasRun

body

boolean

false

none

»» components

body

[RESTAPI.v1.DTOs.BPM.BPMComponentDTO]¦null

false

none

»»» workflowID

body

integer(int32)

false

none

»»» componentID

body

integer(int32)

false

none

»»» name

body

string¦null

false

none

»»» type

body

string

false

none

»»» order

body

integer(int32)

false

none

»»» categories

body

[RESTAPI.v1.DTOs.BPMInquiryCategoryDTO]¦null

false

none

»»»» categoryID

body

integer(int32)

false

none

»»»» value

body

string¦null

false

none

»»» source

body

RESTAPI.v1.DTOs.BPM.BPMComponentSourceDTO

false

none

»»»» sourceID

body

integer(int32)¦null

false

none

»»»» sourceReference

body

RESTAPI.v1.DTOs.BPM.BPMComponentSourceReferenceDTO

false

none

»»»»» tableName

body

string¦null

false

none

»»»»» calculationID

body

integer(int32)¦null

false

none

»»»»» dataStoreID

body

integer(int32)¦null

false

none

»»»»» planBuilderCalculationID

body

string¦null

false

none

»»»» sourceFilters

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFiltersDTO

false

none

»»»»» filters

body

[RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterDTO]¦null

false

none

»»»»»» constraint

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterConstraintDTO

false

none

»»»»»»» columnName

body

string¦null

false

none

»»»»»»» operator

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterOperatorDTO

false

none

»»»»»»»» type

body

string

false

none

»»»»»»» value

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterValueDTO

false

none

»»»»»»»» text

body

string¦null

false

none

»»»»»»»» numeric

body

number(double)¦null

false

none

»»»»»»»» date

body

string(date-time)¦null

false

none

»»»»»»»» special

body

string¦null

false

none

»»»»»»»» valueId

body

integer(int32)¦null

false

none

»»»»»»»» rangeValue

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexRangeValueDTO

false

none

»»»»»»»»» min

body

any

false

none

»»»»»»»»» max

body

any

false

none

»»»»»»» caseSensitive

body

boolean¦null

false

none

»»»»»» and

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterAndDTO

false

none

»»»»»»» filters

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»» or

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterOrDTO

false

none

»»»»»»» filters

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»» not

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterNotDTO

false

none

»»»»»»» filter

body

any

false

none

»»»»»» metadata

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterMetaDataDTO

false

none

»»»»»»» additionalProperties

body

any

false

none

»»»» columns

body

[RESTAPI.v1.DTOs.BPM.BPMComponentSourceColumnDTO]¦null

false

none

»»»»» columnName

body

string¦null

false

none

»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»» rowVersion

body

integer(int64)

false

none

»»» config

body

RESTAPI.v1.DTOs.BPM.BPMComponentConfigDTO

false

none

»»»» pickList

body

RESTAPI.v1.DTOs.BPM.BPMComponentPickListDTO

false

none

»»»»» additionalProperties

body

any

false

none

»»»»» placeholder

body

string¦null

false

none

»»»»» sort

body

string¦null

false

none

»»»»» parameterName

body

string¦null

false

none

»»»»» userGenerated

body

boolean

false

none

»»»»» hasError

body

boolean

false

none

»»»»» required

body

boolean

false

none

»»»»» enabled

body

boolean

false

none

»»»»» visible

body

boolean

false

none

»»»»» defaultValue

body

string¦null

false

none

»»»» title

body

RESTAPI.v1.DTOs.BPM.BPMComponentTitleDTO

false

none

»»»»» additionalProperties

body

any

false

none

»»»»» content

body

string¦null

false

none

»»»»» userGenerated

body

boolean

false

none

»»»»» hasError

body

boolean

false

none

»»»»» required

body

boolean

false

none

»»»»» enabled

body

boolean

false

none

»»»»» visible

body

boolean

false

none

»»»»» defaultValue

body

string¦null

false

none

»»»» subject

body

RESTAPI.v1.DTOs.BPM.BPMComponentSubjectDTO

false

none

»»»»» additionalProperties

body

any

false

none

»»»»» placeholder

body

string¦null

false

none

»»»»» parameterName

body

string¦null

false

none

»»»»» userGenerated

body

boolean

false

none

»»»»» hasError

body

boolean

false

none

»»»»» required

body

boolean

false

none

»»»»» enabled

body

boolean

false

none

»»»»» visible

body

boolean

false

none

»»»»» defaultValue

body

string¦null

false

none

»»»» description

body

RESTAPI.v1.DTOs.BPM.BPMComponentDescriptionDTO

false

none

»»»»» additionalProperties

body

any

false

none

»»»»» placeholder

body

string¦null

false

none

»»»»» parameterName

body

string¦null

false

none

»»»»» charLimit

body

integer(int32)

false

none

»»»»» userGenerated

body

boolean

false

none

»»»»» hasError

body

boolean

false

none

»»»»» required

body

boolean

false

none

»»»»» enabled

body

boolean

false

none

»»»»» visible

body

boolean

false

none

»»»»» defaultValue

body

string¦null

false

none

»»»» text

body

RESTAPI.v1.DTOs.BPM.BPMComponentTextDTO

false

none

»»»»» additionalProperties

body

any

false

none

»»»»» placeholder

body

string¦null

false

none

»»»»» charLimit

body

integer(int32)

false

none

»»»»» content

body

string¦null

false

none

»»»»» parameterName

body

string¦null

false

none

»»»»» userGenerated

body

boolean

false

none

»»»»» hasError

body

boolean

false

none

»»»»» required

body

boolean

false

none

»»»»» templateList

body

[RESTAPI.v1.DTOs.BPM.CommentTemplateDTO]¦null

false

none

»»»»»» value

body

string¦null

false

none

»»»»» enabled

body

boolean

false

none

»»»»» visible

body

boolean

false

none

»»»»» defaultValue

body

string¦null

false

none

»»»» numeric

body

RESTAPI.v1.DTOs.BPM.BPMComponentNumericDTO

false

none

»»»»» additionalProperties

body

any

false

none

»»»»» placeholder

body

string¦null

false

none

»»»»» charLimit

body

integer(int32)

false

none

»»»»» content

body

string¦null

false

none

»»»»» parameterName

body

string¦null

false

none

»»»»» userGenerated

body

boolean

false

none

»»»»» hasError

body

boolean

false

none

»»»»» required

body

boolean

false

none

»»»»» enabled

body

boolean

false

none

»»»»» visible

body

boolean

false

none

»»»»» defaultValue

body

integer(int32)

false

none

»»»» sourcePickList

body

RESTAPI.v1.DTOs.BPM.BPMComponentSourcePickListDTO

false

none

»»»»» additionalProperties

body

any

false

none

»»»»» displayName

body

string¦null

false

none

»»»»» displayColumn

body

string¦null

false

none

»»»»» displayColumnDBType

body

string

false

none

»»»»» idColumn

body

string¦null

false

none

»»»»» idColumnDBType

body

string

false

none

»»»»» placeholder

body

string¦null

false

none

»»»»» sort

body

string¦null

false

none

»»»»» sortOrder

body

string

false

none

»»»»» parameterName

body

string¦null

false

none

»»»»» hasError

body

boolean

false

none

»»»»» required

body

boolean

false

none

»»»»» userGenerated

body

boolean

false

none

»»»»» hideIDColumn

body

boolean¦null

false

none

»»»»» enabled

body

boolean

false

none

»»»»» visible

body

boolean

false

none

»»»»» defaultValue

body

string¦null

false

none

»»» componentMappings

body

[RESTAPI.v1.DTOs.BPM.BPMAutoAdjustComponentMappingDTO]¦null

false

none

»»»» nodeID

body

integer(int32)

false

none

»»»» nodeName

body

string¦null

false

none

»»»» tableName

body

string¦null

false

none

»»»» columnName

body

string¦null

false

none

»»»» dataType

body

string¦null

false

none

»»»» isPrimaryKey

body

boolean

false

none

»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

» bpmWorkflowPresenterFlexReportDTO

body

Varicent.RESTAPI.v1.DTOs.BPMWorkflowPresenterFlexReportDTO

false

none

»» reportId

body

integer(int32)

false

none

»» parameters

body

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowParameterDTO]¦null

false

none

»» objectRestrictions

body

object¦null

false

none

»»» additionalProperties

body

RESTAPI.v1.DTOs.BPM.BPMVisibilityEditabilityDTO

false

none

»»»» visible

body

boolean

false

none

»»»» editable

body

boolean

false

none

» bpmWorkflowPlanDocPresenterFlexReportDTO

body

Varicent.RESTAPI.v1.DTOs.BPMWorkflowPlanDocPresenterFlexReportDTO

false

none

»» reportId

body

integer(int32)

false

none

»» parameters

body

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowParameterDTO]¦null

false

none

»» templateType

body

string

false

none

» assignedReports

body

[string]¦null

false

none

» numReportsAssigned

body

integer(int32)

false

none

» permissions

body

Varicent.RESTAPI.v1.DTOs.WorkflowPermissionsDTO

false

none

»» advanceToken

body

[string]¦null

false

none

»» viewDocuments

body

[string]¦null

false

none

» parentFolder

body

Varicent.RESTAPI.v1.DTOs.BPMFolderDTO

false

none

»» folderID

body

integer(int32)

false

none

»» folderName

body

string¦null

false

none

»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» workflowType

body

string¦null

false

none

» parameters

body

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowParameterDTO]¦null

false

none

» layoutAssignment

body

object¦null

false

none

»» additionalProperties

body

[RESTAPI.v1.DTOs.PairDTO2[System.Boolean,System.Boolean]](#schemarestapi.v1.dtos.pairdto2[system.boolean,system.boolean])

false

none

» webReportID

body

integer(int32)

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

» workflowState

Stopped

» workflowState

Started

» workflowState

Stopping

» workflowState

Starting

» workflowState

Archived

» workflowState

Draft

»» variableType

Text

»» variableType

Date

»» variableType

Numeric

» workflowType

PresenterReport

» workflowType

Inquiry

» workflowType

PlanApproval

» workflowType

PresenterFlexReport

» workflowType

PlanDocument

»»» paramType

Text

»»» paramType

Date

»»» paramType

Numeric

»»» valueType

Constant

»»» valueType

Value

»»» type

pickList

»»» type

title

»»» type

subject

»»» type

description

»»» type

text

»»» type

numeric

»»» type

sourcePickList

»»»»»»»» type

Equals

»»»»»»»» type

NotEquals

»»»»»»»» type

LessThan

»»»»»»»» type

LessThanEquals

»»»»»»»» type

GreaterThan

»»»»»»»» type

GreaterThanEquals

»»»»»»»» type

IsNull

»»»»»»»» type

IsNotNull

»»»»»»»» type

Contains

»»»»»»»» type

NotContains

»»»»»»»» type

StartWith

»»»»»»»» type

EndWith

»»»»»»»» type

InRange

»»»»»»»» type

InArray

»»»»»»»» type

NotInArray

»»»»»»»» special

CurrentWebUser

»»»»»»»» special

CurrentDate

»»»»»»»» special

CurrentRowValue

»»»»»»»» special

WorkflowFormID

»»»»» displayColumnDBType

String

»»»»» displayColumnDBType

LongString

»»»»» displayColumnDBType

MaxString

»»»»» displayColumnDBType

Date

»»»»» displayColumnDBType

DateTime

»»»»» displayColumnDBType

Decimal

»»»»» displayColumnDBType

Int

»»»»» displayColumnDBType

Long

»»»»» displayColumnDBType

Float

»»»»» displayColumnDBType

BLOB

»»»»» displayColumnDBType

Identity

»»»»» displayColumnDBType

CLOB

»»»»» displayColumnDBType

RowVersion

»»»»» displayColumnDBType

UID

»»»»» displayColumnDBType

VarCharMax

»»»»» displayColumnDBType

Boolean

»»»»» idColumnDBType

String

»»»»» idColumnDBType

LongString

»»»»» idColumnDBType

MaxString

»»»»» idColumnDBType

Date

»»»»» idColumnDBType

DateTime

»»»»» idColumnDBType

Decimal

»»»»» idColumnDBType

Int

»»»»» idColumnDBType

Long

»»»»» idColumnDBType

Float

»»»»» idColumnDBType

BLOB

»»»»» idColumnDBType

Identity

»»»»» idColumnDBType

CLOB

»»»»» idColumnDBType

RowVersion

»»»»» idColumnDBType

UID

»»»»» idColumnDBType

VarCharMax

»»»»» idColumnDBType

Boolean

»»»»» sortOrder

Ascending

»»»»» sortOrder

Descending

»»»»» sortOrder

AscendingNullsFirst

»»»»» sortOrder

DescendingNullsLast

»» templateType

Payee

»» templateType

ManagerPayee

»» templateType

Custom

»» advanceToken

Start

»» advanceToken

End

»» advanceToken

Action

»» advanceToken

Alert

»» advanceToken

Process

»» advanceToken

Conditional

»» advanceToken

AutoAdjust

»» advanceToken

GeneratePdf

»» advanceToken

Sign

»» viewDocuments

Start

»» viewDocuments

End

»» viewDocuments

Action

»» viewDocuments

Alert

»» viewDocuments

Process

»» viewDocuments

Conditional

»» viewDocuments

AutoAdjust

»» viewDocuments

GeneratePdf

»» viewDocuments

Sign

»» workflowType

PresenterReport

»» workflowType

Inquiry

»» workflowType

PlanApproval

»» workflowType

PresenterFlexReport

»» workflowType

PlanDocument

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.BPMWorkflowDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/workflowmanager/workflow/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/workflow/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "name": "string",
  "description": "string",
  "isSingleInstance": true,
  "workflowState": "Stopped",
  "conditionalVars": [
    {
      "expressionName": "string",
      "name": "string",
      "variableType": "Text"
    }
  ],
  "columnCount": 0,
  "workflowConfig": {
    "pendingWorkflowEnabled": true
  },
  "runCount": 0,
  "runDate": "string",
  "runBy": "string",
  "lastActioned": "string",
  "workflowType": "PresenterReport",
  "webReport": {
    "parameters": [
      {}
    ],
    "layoutAssignment": {
      "property1": {},
      "property2": {}
    },
    "webReportID": 0
  },
  "inquiry": {
    "hasRun": true,
    "components": [
      {}
    ]
  },
  "bpmWorkflowPresenterFlexReportDTO": {
    "reportId": 0,
    "parameters": [
      {}
    ],
    "objectRestrictions": {
      "property1": {},
      "property2": {}
    }
  },
  "bpmWorkflowPlanDocPresenterFlexReportDTO": {
    "reportId": 0,
    "parameters": [
      {}
    ],
    "templateType": "Payee"
  },
  "assignedReports": [
    "string"
  ],
  "numReportsAssigned": 0,
  "permissions": {
    "advanceToken": [
      "Start"
    ],
    "viewDocuments": [
      "Start"
    ]
  },
  "parentFolder": {
    "folderID": 0,
    "folderName": "string",
    "rowVersion": {
      "rowVersion": 0
    },
    "workflowType": "PresenterReport"
  },
  "parameters": [
    {
      "paramName": "string",
      "value": "string",
      "paramType": "Text",
      "valueType": "Constant",
      "usesReportValue": true,
      "isRequired": true
    }
  ],
  "layoutAssignment": {
    "property1": {
      "first": true,
      "second": true
    },
    "property2": {
      "first": true,
      "second": true
    }
  },
  "webReportID": 0,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflowmanager/workflow/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/workflowmanager/workflow/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/workflowmanager/workflow/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

Create a swim lane.

Body parameter

[
  {
    "id": 0,
    "order": 0,
    "name": "string",
    "description": "string",
    "workflowID": 0,
    "isSystemLane": true,
    "isByRestriction": true,
    "isAdmin": true,
    "memberDefinition": {
      "query": {},
      "sourceNames": {}
    },
    "payeeIDs": [
      "string"
    ],
    "queryDelta": {
      "modification": {},
      "query": {},
      "selectAllRows": true
    },
    "adminIDs": [
      "string"
    ],
    "version": {
      "rowVersion": 0
    }
  }
]

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

order

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.SwimLaneDTO

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.SwimLaneDTO]

false

none

none

» id

integer(int32)

false

none

none

» order

integer(int32)

false

none

none

» name

string¦null

false

none

none

» description

string¦null

false

none

none

» workflowID

integer(int32)

false

none

none

» isSystemLane

boolean

false

none

none

» isByRestriction

boolean

false

none

none

» isAdmin

boolean

false

none

none

» memberDefinition

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

»» query

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

»»» selectItems

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

none

»»»» alias

string¦null

false

none

none

»»»» column

string¦null

false

none

none

»»»» table

string¦null

false

none

none

»»»» customSelect

string¦null

false

none

none

»»»» dataType

string

false

none

none

»»»» type

string

false

none

none

»»»» value

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»» expressionType

string

false

none

none

»»»»» cases

array¦null

false

none

none

»»»»»» anonymous

any

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» column

string¦null

false

none

none

»»»»» op

string¦null

false

none

none

»»»»» arguments

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

none

[DTO version of IExpression]

»»»»»» expressionType

string

false

none

none

»»»»»» cases

array¦null

false

none

none

»»»»»»» anonymous

any

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» column

string¦null

false

none

none

»»»»»» op

string¦null

false

none

none

»»»»»» arguments

array¦null

false

none

none

»»»»»»» anonymous

any

false

none

none

»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»»» constraintType

string

false

none

none

»»»»»»» op

string¦null

false

none

none

»»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»» expressionType

string

false

none

none

»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» table

string¦null

false

none

none

»»»»»»»» column

string¦null

false

none

none

»»»»»»»» op

string¦null

false

none

none

»»»»»»»» arguments

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» condition

any

false

none

none

»»»»»»»» trueValue

any

false

none

none

»»»»»»»» falseValue

any

false

none

none

»»»»»»»» isDate

boolean

false

none

none

»»»»»»»» literalType

string

false

none

none

»»»»»»»» value

any

false

none

none

»»»»»»» caseSensitive

boolean

false

none

none

»»»»»»» constraints

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»»» literalRight

any

false

none

none

»»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»» right

any

false

none

none

»»»»»»» expressionLeft

any

false

none

none

»»»»»»» expressionRight

any

false

none

none

»»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»»» like

string¦null

false

none

none

»»»»»»» escapeWildcards

boolean

false

none

none

»»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»»» rowVersion

integer(int64)

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» queryDefinitionRight

any

false

none

none

»»»»»» trueValue

any

false

none

none

»»»»»» falseValue

any

false

none

none

»»»»»» isDate

boolean

false

none

none

»»»»»» literalType

string

false

none

none

»»»»»» value

any

false

none

none

»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»» trueValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» falseValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» isDate

boolean

false

none

none

»»»»» literalType

string

false

none

none

»»»»» value

any

false

none

none

»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»» namespaceTable

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

none

»»»»» m_namespace

string¦null

false

none

none

»»»»» name

string¦null

false

none

none

»»»» query

any

false

none

none

»»»» alias

string¦null

false

none

none

»»»» sourceType

string

false

none

none

»»» joins

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

none

»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»» joinType

string

false

none

none

»»»» onClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»» constraintType

string

false

none

none

»»»»» op

string¦null

false

none

none

»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»» caseSensitive

boolean

false

none

none

»»»»» constraints

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

none

[DTO version of IConstraint]

»»»»» literalRight

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»» right

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» expressionLeft

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» expressionRight

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» isPreciseDecimal

boolean

false

none

none

»»»»» like

string¦null

false

none

none

»»»»» escapeWildcards

boolean

false

none

none

»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» queryDefinitionRight

any

false

none

none

»»» whereClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»» order

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

none

»»»» table

string¦null

false

none

none

»»»» column

string¦null

false

none

none

»»»» direction

string

false

none

none

»»» group

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

none

»»»» table

string¦null

false

none

none

»»»» column

string¦null

false

none

none

»»» havingClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»» distinct

boolean

false

none

none

»»» unionWith

any

false

none

none

»»» exceptWith

any

false

none

none

»» sourceNames

object¦null

false

none

none

»»» additionalProperties

string¦null

false

none

none

» payeeIDs

[string]¦null

false

none

none

» queryDelta

Varicent.RESTAPI.v1.DTOs.QueryDeltaDTO

false

none

none

»» modification

[Varicent.RESTAPI.v1.DTOs.Core.CollectionModificationDTO1[System.String]](#schemavaricent.restapi.v1.dtos.core.collectionmodificationdto1[system.string])

false

none

none

»»» itemsToAdd

[string]¦null

false

none

none

»»» itemsToRemove

[string]¦null

false

none

none

»» query

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

»» selectAllRows

boolean¦null

false

none

none

» adminIDs

[string]¦null

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

dataType

Int

dataType

Decimal

dataType

DateTime

dataType

None

dataType

String

type

SelectAll

type

SelectItem

type

SelectLiteral

type

SelectCustom

type

SelectExpression

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

sourceType

Table

sourceType

Query

joinType

Inner

joinType

Left

joinType

Right

joinType

Cross

joinType

CrossApply

joinType

OuterApply

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

direction

Ascending

direction

Descending

direction

AscendingNullsFirst

direction

DescendingNullsLast

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/workflowmanager/workflows/{id}/swimlanes/{order}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/workflows/{id}/swimlanes/{order}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "id": 0,
    "order": 0,
    "name": "string",
    "description": "string",
    "workflowID": 0,
    "isSystemLane": true,
    "isByRestriction": true,
    "isAdmin": true,
    "memberDefinition": {
      "query": {},
      "sourceNames": {}
    },
    "payeeIDs": [
      "string"
    ],
    "queryDelta": {
      "modification": {},
      "query": {},
      "selectAllRows": true
    },
    "adminIDs": [
      "string"
    ],
    "version": {
      "rowVersion": 0
    }
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflowmanager/workflows/{id}/swimlanes/{order}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/workflowmanager/workflows/{id}/swimlanes/{order}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/workflowmanager/workflows/{id}/swimlanes/{order}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "order": 0,
    "name": "string",
    "description": "string",
    "workflowID": 0,
    "isSystemLane": true,
    "isByRestriction": true,
    "isAdmin": true,
    "memberDefinition": {
      "query": {},
      "sourceNames": {}
    },
    "payeeIDs": [
      "string"
    ],
    "queryDelta": {
      "modification": {},
      "query": {},
      "selectAllRows": true
    },
    "adminIDs": [
      "string"
    ],
    "version": {
      "rowVersion": 0
    }
  }
]
[{"id":0,"order":0,"name":"string","description":"string","workflowID":0,"isSystemLane":true,"isByRestriction":true,"isAdmin":true,"memberDefinition":{"query":{},"sourceNames":{}},"payeeIDs":["string"],"queryDelta":{"modification":{},"query":{},"selectAllRows":true},"adminIDs":["string"],"version":{"rowVersion":0}}]

Delete a swim lane.

Body parameter

[
  {
    "id": 0,
    "order": 0,
    "name": "string",
    "description": "string",
    "workflowID": 0,
    "isSystemLane": true,
    "isByRestriction": true,
    "isAdmin": true,
    "memberDefinition": {
      "query": {},
      "sourceNames": {}
    },
    "payeeIDs": [
      "string"
    ],
    "queryDelta": {
      "modification": {},
      "query": {},
      "selectAllRows": true
    },
    "adminIDs": [
      "string"
    ],
    "version": {
      "rowVersion": 0
    }
  }
]

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

order

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.SwimLaneDTO

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.SwimLaneDTO]

false

none

none

» id

integer(int32)

false

none

none

» order

integer(int32)

false

none

none

» name

string¦null

false

none

none

» description

string¦null

false

none

none

» workflowID

integer(int32)

false

none

none

» isSystemLane

boolean

false

none

none

» isByRestriction

boolean

false

none

none

» isAdmin

boolean

false

none

none

» memberDefinition

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

»» query

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

»»» selectItems

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

none

»»»» alias

string¦null

false

none

none

»»»» column

string¦null

false

none

none

»»»» table

string¦null

false

none

none

»»»» customSelect

string¦null

false

none

none

»»»» dataType

string

false

none

none

»»»» type

string

false

none

none

»»»» value

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»» expressionType

string

false

none

none

»»»»» cases

array¦null

false

none

none

»»»»»» anonymous

any

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» column

string¦null

false

none

none

»»»»» op

string¦null

false

none

none

»»»»» arguments

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

none

[DTO version of IExpression]

»»»»»» expressionType

string

false

none

none

»»»»»» cases

array¦null

false

none

none

»»»»»»» anonymous

any

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» column

string¦null

false

none

none

»»»»»» op

string¦null

false

none

none

»»»»»» arguments

array¦null

false

none

none

»»»»»»» anonymous

any

false

none

none

»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»»» constraintType

string

false

none

none

»»»»»»» op

string¦null

false

none

none

»»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»» expressionType

string

false

none

none

»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» table

string¦null

false

none

none

»»»»»»»» column

string¦null

false

none

none

»»»»»»»» op

string¦null

false

none

none

»»»»»»»» arguments

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» condition

any

false

none

none

»»»»»»»» trueValue

any

false

none

none

»»»»»»»» falseValue

any

false

none

none

»»»»»»»» isDate

boolean

false

none

none

»»»»»»»» literalType

string

false

none

none

»»»»»»»» value

any

false

none

none

»»»»»»» caseSensitive

boolean

false

none

none

»»»»»»» constraints

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»»» literalRight

any

false

none

none

»»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»» right

any

false

none

none

»»»»»»» expressionLeft

any

false

none

none

»»»»»»» expressionRight

any

false

none

none

»»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»»» like

string¦null

false

none

none

»»»»»»» escapeWildcards

boolean

false

none

none

»»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»»» rowVersion

integer(int64)

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» queryDefinitionRight

any

false

none

none

»»»»»» trueValue

any

false

none

none

»»»»»» falseValue

any

false

none

none

»»»»»» isDate

boolean

false

none

none

»»»»»» literalType

string

false

none

none

»»»»»» value

any

false

none

none

»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»» trueValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» falseValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» isDate

boolean

false

none

none

»»»»» literalType

string

false

none

none

»»»»» value

any

false

none

none

»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»» namespaceTable

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

none

»»»»» m_namespace

string¦null

false

none

none

»»»»» name

string¦null

false

none

none

»»»» query

any

false

none

none

»»»» alias

string¦null

false

none

none

»»»» sourceType

string

false

none

none

»»» joins

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

none

»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»» joinType

string

false

none

none

»»»» onClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»» constraintType

string

false

none

none

»»»»» op

string¦null

false

none

none

»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»» caseSensitive

boolean

false

none

none

»»»»» constraints

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

none

[DTO version of IConstraint]

»»»»» literalRight

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»» right

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» expressionLeft

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» expressionRight

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» isPreciseDecimal

boolean

false

none

none

»»»»» like

string¦null

false

none

none

»»»»» escapeWildcards

boolean

false

none

none

»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» queryDefinitionRight

any

false

none

none

»»» whereClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»» order

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

none

»»»» table

string¦null

false

none

none

»»»» column

string¦null

false

none

none

»»»» direction

string

false

none

none

»»» group

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

none

»»»» table

string¦null

false

none

none

»»»» column

string¦null

false

none

none

»»» havingClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»» distinct

boolean

false

none

none

»»» unionWith

any

false

none

none

»»» exceptWith

any

false

none

none

»» sourceNames

object¦null

false

none

none

»»» additionalProperties

string¦null

false

none

none

» payeeIDs

[string]¦null

false

none

none

» queryDelta

Varicent.RESTAPI.v1.DTOs.QueryDeltaDTO

false

none

none

»» modification

[Varicent.RESTAPI.v1.DTOs.Core.CollectionModificationDTO1[System.String]](#schemavaricent.restapi.v1.dtos.core.collectionmodificationdto1[system.string])

false

none

none

»»» itemsToAdd

[string]¦null

false

none

none

»»» itemsToRemove

[string]¦null

false

none

none

»» query

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

»» selectAllRows

boolean¦null

false

none

none

» adminIDs

[string]¦null

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

dataType

Int

dataType

Decimal

dataType

DateTime

dataType

None

dataType

String

type

SelectAll

type

SelectItem

type

SelectLiteral

type

SelectCustom

type

SelectExpression

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

sourceType

Table

sourceType

Query

joinType

Inner

joinType

Left

joinType

Right

joinType

Cross

joinType

CrossApply

joinType

OuterApply

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

direction

Ascending

direction

Descending

direction

AscendingNullsFirst

direction

DescendingNullsLast

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/workflowmanager/workflows/{id}/swimlanes/{order}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/workflows/{id}/swimlanes/{order}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "id": 0,
    "order": 0,
    "name": "string",
    "description": "string",
    "workflowID": 0,
    "isSystemLane": true,
    "isByRestriction": true,
    "isAdmin": true,
    "memberDefinition": {
      "query": {},
      "sourceNames": {}
    },
    "payeeIDs": [
      "string"
    ],
    "queryDelta": {
      "modification": {},
      "query": {},
      "selectAllRows": true
    },
    "adminIDs": [
      "string"
    ],
    "version": {
      "rowVersion": 0
    }
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflowmanager/workflows/{id}/swimlanes/{order}',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.delete('http://localhost:8080/api/v1/workflowmanager/workflows/{id}/swimlanes/{order}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.delete 'http://localhost:8080/api/v1/workflowmanager/workflows/{id}/swimlanes/{order}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "order": 0,
    "name": "string",
    "description": "string",
    "workflowID": 0,
    "isSystemLane": true,
    "isByRestriction": true,
    "isAdmin": true,
    "memberDefinition": {
      "query": {},
      "sourceNames": {}
    },
    "payeeIDs": [
      "string"
    ],
    "queryDelta": {
      "modification": {},
      "query": {},
      "selectAllRows": true
    },
    "adminIDs": [
      "string"
    ],
    "version": {
      "rowVersion": 0
    }
  }
]
[{"id":0,"order":0,"name":"string","description":"string","workflowID":0,"isSystemLane":true,"isByRestriction":true,"isAdmin":true,"memberDefinition":{"query":{},"sourceNames":{}},"payeeIDs":["string"],"queryDelta":{"modification":{},"query":{},"selectAllRows":true},"adminIDs":["string"],"version":{"rowVersion":0}}]

Get nodes.

Parameters

Name

In

Type

Required

Description

workflowId

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.BPMNodeDTO]

false

none

none

» id

integer(int32)

false

none

none

» swimLaneId

integer(int32)

false

none

none

» name

string¦null

false

none

none

» description

string¦null

false

none

none

» order

integer(int32)

false

none

none

» paths

[RESTAPI.v1.DTOs.BPM.BPMPathDTO]¦null

false

none

none

»» pathID

integer(int32)

false

none

none

»» name

string¦null

false

none

none

»» originNodeID

integer(int32)

false

none

none

»» destinationNodeID

integer(int32)¦null

false

none

none

»» allMember

boolean

false

none

none

»» allSubmit

boolean

false

none

none

»» saveAndSubmit

boolean

false

none

none

»» reviewResult

string

false

none

none

»» position

integer(int32)

false

none

none

»» condition

string¦null

false

none

none

»» isDefault

boolean

false

none

none

»» isSign

boolean

false

none

none

» nodeType

string

false

none

none

» schedulerFolderId

integer(int32)¦null

false

none

none

» layoutAssignment

object¦null

false

none

none

»» additionalProperties

[RESTAPI.v1.DTOs.PairDTO2[System.Boolean,System.Boolean]](#schemarestapi.v1.dtos.pairdto2[system.boolean,system.boolean])

false

none

none

»»» first

boolean

false

none

none

»»» second

boolean

false

none

none

» expiryType

string

false

none

none

» screenshotType

string¦null

false

none

none

» useVaricentLogo

boolean¦null

false

none

none

» expiryDateTime

string(date-time)¦null

false

none

none

» expiryTimeLength

integer(int64)¦null

false

none

none

» expiryPathID

integer(int32)¦null

false

none

none

» sendNotification

boolean¦null

false

none

none

» inquiryStatus

string¦null

false

none

none

» alertType

string¦null

false

none

none

» subject

string¦null

false

none

none

» body

string¦null

false

none

none

» externalEmails

[Varicent.RESTAPI.v1.DTOs.ExternalEmailDTO]¦null

false

none

none

»» email

string¦null

false

none

none

»» isCC

boolean

false

none

none

» autoAdjust

RESTAPI.v1.DTOs.BPM.BPMAutoAdjustNodeFieldDTO

false

none

none

»» sourceTableName

string¦null

false

none

none

»» columnMappings

array¦null

false

none

none

»»» anonymous

any

false

none

none

» isAdmin

boolean

false

none

none

» swimLaneName

string¦null

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

» objectRestrictions

object¦null

false

none

none

»» additionalProperties

RESTAPI.v1.DTOs.BPM.BPMVisibilityEditabilityDTO

false

none

none

»»» visible

boolean

false

none

none

»»» editable

boolean

false

none

none

» workflowId

integer(int32)¦null

false

none

none

» reportId

integer(int32)¦null

false

none

none

» isAppendPdf

boolean¦null

false

none

none

» uploadedPdfName

string¦null

false

none

none

» uploadedPdf

string¦null

false

none

none

» pdfAppendOrder

string¦null

false

none

none

» isUploadedExistingPdf

boolean¦null

false

none

none

Enumerated Values

Property

Value

reviewResult

Rejected

reviewResult

Approved

reviewResult

None

nodeType

Start

nodeType

End

nodeType

Action

nodeType

Alert

nodeType

Process

nodeType

Conditional

nodeType

AutoAdjust

nodeType

GeneratePdf

nodeType

Sign

expiryType

None

expiryType

DateTime

expiryType

TimeLength

screenshotType

Unkown

screenshotType

Full

screenshotType

Preview

screenshotType

None

inquiryStatus

Entered

inquiryStatus

Investigating

inquiryStatus

Escalated

inquiryStatus

WaitingForApproval

inquiryStatus

MoreInfoRequired

inquiryStatus

Resolved

inquiryStatus

Closed

alertType

Email

alertType

InternalAndEmail

alertType

Internal

pdfAppendOrder

Unknown

pdfAppendOrder

AfterAgreement

pdfAppendOrder

BeforeAgreement

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workflowmanager/workflows/{workflowId}/nodes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/workflows/{workflowId}/nodes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflowmanager/workflows/{workflowId}/nodes',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/workflowmanager/workflows/{workflowId}/nodes', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/workflowmanager/workflows/{workflowId}/nodes',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "swimLaneId": 0,
    "name": "string",
    "description": "string",
    "order": 0,
    "paths": [
      {}
    ],
    "nodeType": "Start",
    "schedulerFolderId": 0,
    "layoutAssignment": {
      "property1": {},
      "property2": {}
    },
    "expiryType": "None",
    "screenshotType": "Unkown",
    "useVaricentLogo": true,
    "expiryDateTime": "2019-08-24T14:15:22Z",
    "expiryTimeLength": 0,
    "expiryPathID": 0,
    "sendNotification": true,
    "inquiryStatus": "Entered",
    "alertType": "Email",
    "subject": "string",
    "body": "string",
    "externalEmails": [
      {}
    ],
    "autoAdjust": {
      "sourceTableName": "string",
      "columnMappings": []
    },
    "isAdmin": true,
    "swimLaneName": "string",
    "version": {
      "rowVersion": 0
    },
    "objectRestrictions": {
      "property1": {},
      "property2": {}
    },
    "workflowId": 0,
    "reportId": 0,
    "isAppendPdf": true,
    "uploadedPdfName": "string",
    "uploadedPdf": "string",
    "pdfAppendOrder": "Unknown",
    "isUploadedExistingPdf": true
  }
]
[{"id":0,"swimLaneId":0,"name":"string","description":"string","order":0,"paths":[{}],"nodeType":"Start","schedulerFolderId":0,"layoutAssignment":{"property1":{},"property2":{}},"expiryType":"None","screenshotType":"Unkown","useVaricentLogo":true,"expiryDateTime":"2019-08-24T14:15:22Z","expiryTimeLength":0,"expiryPathID":0,"sendNotification":true,"inquiryStatus":"Entered","alertType":"Email","subject":"string","body":"string","externalEmails":[{}],"autoAdjust":{"sourceTableName":"string","columnMappings":[]},"isAdmin":true,"swimLaneName":"string","version":{"rowVersion":0},"objectRestrictions":{"property1":{},"property2":{}},"workflowId":0,"reportId":0,"isAppendPdf":true,"uploadedPdfName":"string","uploadedPdf":"string","pdfAppendOrder":"Unknown","isUploadedExistingPdf":true}]

Create a node.

Body parameter

{
  "id": 0,
  "swimLaneId": 0,
  "name": "string",
  "description": "string",
  "order": 0,
  "paths": [
    {
      "pathID": 0,
      "name": "string",
      "originNodeID": 0,
      "destinationNodeID": 0,
      "allMember": true,
      "allSubmit": true,
      "saveAndSubmit": true,
      "reviewResult": "Rejected",
      "position": 0,
      "condition": "string",
      "isDefault": true,
      "isSign": true
    }
  ],
  "nodeType": "Start",
  "schedulerFolderId": 0,
  "layoutAssignment": {
    "property1": {
      "first": true,
      "second": true
    },
    "property2": {
      "first": true,
      "second": true
    }
  },
  "expiryType": "None",
  "screenshotType": "Unkown",
  "useVaricentLogo": true,
  "expiryDateTime": "2019-08-24T14:15:22Z",
  "expiryTimeLength": 0,
  "expiryPathID": 0,
  "sendNotification": true,
  "inquiryStatus": "Entered",
  "alertType": "Email",
  "subject": "string",
  "body": "string",
  "externalEmails": [
    {
      "email": "string",
      "isCC": true
    }
  ],
  "autoAdjust": {
    "sourceTableName": "string",
    "columnMappings": []
  },
  "isAdmin": true,
  "swimLaneName": "string",
  "version": {
    "rowVersion": 0
  },
  "objectRestrictions": {
    "property1": {
      "visible": true,
      "editable": true
    },
    "property2": {
      "visible": true,
      "editable": true
    }
  },
  "workflowId": 0,
  "reportId": 0,
  "isAppendPdf": true,
  "uploadedPdfName": "string",
  "uploadedPdf": "string",
  "pdfAppendOrder": "Unknown",
  "isUploadedExistingPdf": true
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.BPMNodeDTO

false

none

» id

body

integer(int32)

false

none

» swimLaneId

body

integer(int32)

false

none

» name

body

string¦null

false

none

» description

body

string¦null

false

none

» order

body

integer(int32)

false

none

» paths

body

[RESTAPI.v1.DTOs.BPM.BPMPathDTO]¦null

false

none

»» pathID

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» originNodeID

body

integer(int32)

false

none

»» destinationNodeID

body

integer(int32)¦null

false

none

»» allMember

body

boolean

false

none

»» allSubmit

body

boolean

false

none

»» saveAndSubmit

body

boolean

false

none

»» reviewResult

body

string

false

none

»» position

body

integer(int32)

false

none

»» condition

body

string¦null

false

none

»» isDefault

body

boolean

false

none

»» isSign

body

boolean

false

none

» nodeType

body

string

false

none

» schedulerFolderId

body

integer(int32)¦null

false

none

» layoutAssignment

body

object¦null

false

none

»» additionalProperties

body

[RESTAPI.v1.DTOs.PairDTO2[System.Boolean,System.Boolean]](#schemarestapi.v1.dtos.pairdto2[system.boolean,system.boolean])

false

none

»»» first

body

boolean

false

none

»»» second

body

boolean

false

none

» expiryType

body

string

false

none

» screenshotType

body

string¦null

false

none

» useVaricentLogo

body

boolean¦null

false

none

» expiryDateTime

body

string(date-time)¦null

false

none

» expiryTimeLength

body

integer(int64)¦null

false

none

» expiryPathID

body

integer(int32)¦null

false

none

» sendNotification

body

boolean¦null

false

none

» inquiryStatus

body

string¦null

false

none

» alertType

body

string¦null

false

none

» subject

body

string¦null

false

none

» body

body

string¦null

false

none

» externalEmails

body

[Varicent.RESTAPI.v1.DTOs.ExternalEmailDTO]¦null

false

none

»» email

body

string¦null

false

none

»» isCC

body

boolean

false

none

» autoAdjust

body

RESTAPI.v1.DTOs.BPM.BPMAutoAdjustNodeFieldDTO

false

none

»» sourceTableName

body

string¦null

false

none

»» columnMappings

body

array¦null

false

none

»»» anonymous

body

any

false

none

» isAdmin

body

boolean

false

none

» swimLaneName

body

string¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

» objectRestrictions

body

object¦null

false

none

»» additionalProperties

body

RESTAPI.v1.DTOs.BPM.BPMVisibilityEditabilityDTO

false

none

»»» visible

body

boolean

false

none

»»» editable

body

boolean

false

none

» workflowId

body

integer(int32)¦null

false

none

» reportId

body

integer(int32)¦null

false

none

» isAppendPdf

body

boolean¦null

false

none

» uploadedPdfName

body

string¦null

false

none

» uploadedPdf

body

string¦null

false

none

» pdfAppendOrder

body

string¦null

false

none

» isUploadedExistingPdf

body

boolean¦null

false

none

Enumerated Values

Parameter

Value

»» reviewResult

Rejected

»» reviewResult

Approved

»» reviewResult

None

» nodeType

Start

» nodeType

End

» nodeType

Action

» nodeType

Alert

» nodeType

Process

» nodeType

Conditional

» nodeType

AutoAdjust

» nodeType

GeneratePdf

» nodeType

Sign

» expiryType

None

» expiryType

DateTime

» expiryType

TimeLength

» screenshotType

Unkown

» screenshotType

Full

» screenshotType

Preview

» screenshotType

None

» inquiryStatus

Entered

» inquiryStatus

Investigating

» inquiryStatus

Escalated

» inquiryStatus

WaitingForApproval

» inquiryStatus

MoreInfoRequired

» inquiryStatus

Resolved

» inquiryStatus

Closed

» alertType

Email

» alertType

InternalAndEmail

» alertType

Internal

» pdfAppendOrder

Unknown

» pdfAppendOrder

AfterAgreement

» pdfAppendOrder

BeforeAgreement

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.BPMNodeDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/workflowmanager/workflows/{id}/nodes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/workflows/{id}/nodes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "swimLaneId": 0,
  "name": "string",
  "description": "string",
  "order": 0,
  "paths": [
    {
      "pathID": 0,
      "name": "string",
      "originNodeID": 0,
      "destinationNodeID": 0,
      "allMember": true,
      "allSubmit": true,
      "saveAndSubmit": true,
      "reviewResult": "Rejected",
      "position": 0,
      "condition": "string",
      "isDefault": true,
      "isSign": true
    }
  ],
  "nodeType": "Start",
  "schedulerFolderId": 0,
  "layoutAssignment": {
    "property1": {
      "first": true,
      "second": true
    },
    "property2": {
      "first": true,
      "second": true
    }
  },
  "expiryType": "None",
  "screenshotType": "Unkown",
  "useVaricentLogo": true,
  "expiryDateTime": "2019-08-24T14:15:22Z",
  "expiryTimeLength": 0,
  "expiryPathID": 0,
  "sendNotification": true,
  "inquiryStatus": "Entered",
  "alertType": "Email",
  "subject": "string",
  "body": "string",
  "externalEmails": [
    {
      "email": "string",
      "isCC": true
    }
  ],
  "autoAdjust": {
    "sourceTableName": "string",
    "columnMappings": []
  },
  "isAdmin": true,
  "swimLaneName": "string",
  "version": {
    "rowVersion": 0
  },
  "objectRestrictions": {
    "property1": {
      "visible": true,
      "editable": true
    },
    "property2": {
      "visible": true,
      "editable": true
    }
  },
  "workflowId": 0,
  "reportId": 0,
  "isAppendPdf": true,
  "uploadedPdfName": "string",
  "uploadedPdf": "string",
  "pdfAppendOrder": "Unknown",
  "isUploadedExistingPdf": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflowmanager/workflows/{id}/nodes',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/workflowmanager/workflows/{id}/nodes', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/workflowmanager/workflows/{id}/nodes',
  params: {
  }, headers: headers

p JSON.parse(result)

Update a node.

Body parameter

{
  "id": 0,
  "swimLaneId": 0,
  "name": "string",
  "description": "string",
  "order": 0,
  "paths": [
    {
      "pathID": 0,
      "name": "string",
      "originNodeID": 0,
      "destinationNodeID": 0,
      "allMember": true,
      "allSubmit": true,
      "saveAndSubmit": true,
      "reviewResult": "Rejected",
      "position": 0,
      "condition": "string",
      "isDefault": true,
      "isSign": true
    }
  ],
  "nodeType": "Start",
  "schedulerFolderId": 0,
  "layoutAssignment": {
    "property1": {
      "first": true,
      "second": true
    },
    "property2": {
      "first": true,
      "second": true
    }
  },
  "expiryType": "None",
  "screenshotType": "Unkown",
  "useVaricentLogo": true,
  "expiryDateTime": "2019-08-24T14:15:22Z",
  "expiryTimeLength": 0,
  "expiryPathID": 0,
  "sendNotification": true,
  "inquiryStatus": "Entered",
  "alertType": "Email",
  "subject": "string",
  "body": "string",
  "externalEmails": [
    {
      "email": "string",
      "isCC": true
    }
  ],
  "autoAdjust": {
    "sourceTableName": "string",
    "columnMappings": []
  },
  "isAdmin": true,
  "swimLaneName": "string",
  "version": {
    "rowVersion": 0
  },
  "objectRestrictions": {
    "property1": {
      "visible": true,
      "editable": true
    },
    "property2": {
      "visible": true,
      "editable": true
    }
  },
  "workflowId": 0,
  "reportId": 0,
  "isAppendPdf": true,
  "uploadedPdfName": "string",
  "uploadedPdf": "string",
  "pdfAppendOrder": "Unknown",
  "isUploadedExistingPdf": true
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

nodeid

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.BPMNodeDTO

false

none

» id

body

integer(int32)

false

none

» swimLaneId

body

integer(int32)

false

none

» name

body

string¦null

false

none

» description

body

string¦null

false

none

» order

body

integer(int32)

false

none

» paths

body

[RESTAPI.v1.DTOs.BPM.BPMPathDTO]¦null

false

none

»» pathID

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» originNodeID

body

integer(int32)

false

none

»» destinationNodeID

body

integer(int32)¦null

false

none

»» allMember

body

boolean

false

none

»» allSubmit

body

boolean

false

none

»» saveAndSubmit

body

boolean

false

none

»» reviewResult

body

string

false

none

»» position

body

integer(int32)

false

none

»» condition

body

string¦null

false

none

»» isDefault

body

boolean

false

none

»» isSign

body

boolean

false

none

» nodeType

body

string

false

none

» schedulerFolderId

body

integer(int32)¦null

false

none

» layoutAssignment

body

object¦null

false

none

»» additionalProperties

body

[RESTAPI.v1.DTOs.PairDTO2[System.Boolean,System.Boolean]](#schemarestapi.v1.dtos.pairdto2[system.boolean,system.boolean])

false

none

»»» first

body

boolean

false

none

»»» second

body

boolean

false

none

» expiryType

body

string

false

none

» screenshotType

body

string¦null

false

none

» useVaricentLogo

body

boolean¦null

false

none

» expiryDateTime

body

string(date-time)¦null

false

none

» expiryTimeLength

body

integer(int64)¦null

false

none

» expiryPathID

body

integer(int32)¦null

false

none

» sendNotification

body

boolean¦null

false

none

» inquiryStatus

body

string¦null

false

none

» alertType

body

string¦null

false

none

» subject

body

string¦null

false

none

» body

body

string¦null

false

none

» externalEmails

body

[Varicent.RESTAPI.v1.DTOs.ExternalEmailDTO]¦null

false

none

»» email

body

string¦null

false

none

»» isCC

body

boolean

false

none

» autoAdjust

body

RESTAPI.v1.DTOs.BPM.BPMAutoAdjustNodeFieldDTO

false

none

»» sourceTableName

body

string¦null

false

none

»» columnMappings

body

array¦null

false

none

»»» anonymous

body

any

false

none

» isAdmin

body

boolean

false

none

» swimLaneName

body

string¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

» objectRestrictions

body

object¦null

false

none

»» additionalProperties

body

RESTAPI.v1.DTOs.BPM.BPMVisibilityEditabilityDTO

false

none

»»» visible

body

boolean

false

none

»»» editable

body

boolean

false

none

» workflowId

body

integer(int32)¦null

false

none

» reportId

body

integer(int32)¦null

false

none

» isAppendPdf

body

boolean¦null

false

none

» uploadedPdfName

body

string¦null

false

none

» uploadedPdf

body

string¦null

false

none

» pdfAppendOrder

body

string¦null

false

none

» isUploadedExistingPdf

body

boolean¦null

false

none

Enumerated Values

Parameter

Value

»» reviewResult

Rejected

»» reviewResult

Approved

»» reviewResult

None

» nodeType

Start

» nodeType

End

» nodeType

Action

» nodeType

Alert

» nodeType

Process

» nodeType

Conditional

» nodeType

AutoAdjust

» nodeType

GeneratePdf

» nodeType

Sign

» expiryType

None

» expiryType

DateTime

» expiryType

TimeLength

» screenshotType

Unkown

» screenshotType

Full

» screenshotType

Preview

» screenshotType

None

» inquiryStatus

Entered

» inquiryStatus

Investigating

» inquiryStatus

Escalated

» inquiryStatus

WaitingForApproval

» inquiryStatus

MoreInfoRequired

» inquiryStatus

Resolved

» inquiryStatus

Closed

» alertType

Email

» alertType

InternalAndEmail

» alertType

Internal

» pdfAppendOrder

Unknown

» pdfAppendOrder

AfterAgreement

» pdfAppendOrder

BeforeAgreement

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.BPMNodeDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/workflowmanager/workflows/{id}/nodes/{nodeid}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/workflows/{id}/nodes/{nodeid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "swimLaneId": 0,
  "name": "string",
  "description": "string",
  "order": 0,
  "paths": [
    {
      "pathID": 0,
      "name": "string",
      "originNodeID": 0,
      "destinationNodeID": 0,
      "allMember": true,
      "allSubmit": true,
      "saveAndSubmit": true,
      "reviewResult": "Rejected",
      "position": 0,
      "condition": "string",
      "isDefault": true,
      "isSign": true
    }
  ],
  "nodeType": "Start",
  "schedulerFolderId": 0,
  "layoutAssignment": {
    "property1": {
      "first": true,
      "second": true
    },
    "property2": {
      "first": true,
      "second": true
    }
  },
  "expiryType": "None",
  "screenshotType": "Unkown",
  "useVaricentLogo": true,
  "expiryDateTime": "2019-08-24T14:15:22Z",
  "expiryTimeLength": 0,
  "expiryPathID": 0,
  "sendNotification": true,
  "inquiryStatus": "Entered",
  "alertType": "Email",
  "subject": "string",
  "body": "string",
  "externalEmails": [
    {
      "email": "string",
      "isCC": true
    }
  ],
  "autoAdjust": {
    "sourceTableName": "string",
    "columnMappings": []
  },
  "isAdmin": true,
  "swimLaneName": "string",
  "version": {
    "rowVersion": 0
  },
  "objectRestrictions": {
    "property1": {
      "visible": true,
      "editable": true
    },
    "property2": {
      "visible": true,
      "editable": true
    }
  },
  "workflowId": 0,
  "reportId": 0,
  "isAppendPdf": true,
  "uploadedPdfName": "string",
  "uploadedPdf": "string",
  "pdfAppendOrder": "Unknown",
  "isUploadedExistingPdf": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflowmanager/workflows/{id}/nodes/{nodeid}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/workflowmanager/workflows/{id}/nodes/{nodeid}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/workflowmanager/workflows/{id}/nodes/{nodeid}',
  params: {
  }, headers: headers

p JSON.parse(result)

Delete a node.

Body parameter

{
  "id": 0,
  "swimLaneId": 0,
  "name": "string",
  "description": "string",
  "order": 0,
  "paths": [
    {
      "pathID": 0,
      "name": "string",
      "originNodeID": 0,
      "destinationNodeID": 0,
      "allMember": true,
      "allSubmit": true,
      "saveAndSubmit": true,
      "reviewResult": "Rejected",
      "position": 0,
      "condition": "string",
      "isDefault": true,
      "isSign": true
    }
  ],
  "nodeType": "Start",
  "schedulerFolderId": 0,
  "layoutAssignment": {
    "property1": {
      "first": true,
      "second": true
    },
    "property2": {
      "first": true,
      "second": true
    }
  },
  "expiryType": "None",
  "screenshotType": "Unkown",
  "useVaricentLogo": true,
  "expiryDateTime": "2019-08-24T14:15:22Z",
  "expiryTimeLength": 0,
  "expiryPathID": 0,
  "sendNotification": true,
  "inquiryStatus": "Entered",
  "alertType": "Email",
  "subject": "string",
  "body": "string",
  "externalEmails": [
    {
      "email": "string",
      "isCC": true
    }
  ],
  "autoAdjust": {
    "sourceTableName": "string",
    "columnMappings": []
  },
  "isAdmin": true,
  "swimLaneName": "string",
  "version": {
    "rowVersion": 0
  },
  "objectRestrictions": {
    "property1": {
      "visible": true,
      "editable": true
    },
    "property2": {
      "visible": true,
      "editable": true
    }
  },
  "workflowId": 0,
  "reportId": 0,
  "isAppendPdf": true,
  "uploadedPdfName": "string",
  "uploadedPdf": "string",
  "pdfAppendOrder": "Unknown",
  "isUploadedExistingPdf": true
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

nodeid

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.BPMNodeDTO

false

none

» id

body

integer(int32)

false

none

» swimLaneId

body

integer(int32)

false

none

» name

body

string¦null

false

none

» description

body

string¦null

false

none

» order

body

integer(int32)

false

none

» paths

body

[RESTAPI.v1.DTOs.BPM.BPMPathDTO]¦null

false

none

»» pathID

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» originNodeID

body

integer(int32)

false

none

»» destinationNodeID

body

integer(int32)¦null

false

none

»» allMember

body

boolean

false

none

»» allSubmit

body

boolean

false

none

»» saveAndSubmit

body

boolean

false

none

»» reviewResult

body

string

false

none

»» position

body

integer(int32)

false

none

»» condition

body

string¦null

false

none

»» isDefault

body

boolean

false

none

»» isSign

body

boolean

false

none

» nodeType

body

string

false

none

» schedulerFolderId

body

integer(int32)¦null

false

none

» layoutAssignment

body

object¦null

false

none

»» additionalProperties

body

[RESTAPI.v1.DTOs.PairDTO2[System.Boolean,System.Boolean]](#schemarestapi.v1.dtos.pairdto2[system.boolean,system.boolean])

false

none

»»» first

body

boolean

false

none

»»» second

body

boolean

false

none

» expiryType

body

string

false

none

» screenshotType

body

string¦null

false

none

» useVaricentLogo

body

boolean¦null

false

none

» expiryDateTime

body

string(date-time)¦null

false

none

» expiryTimeLength

body

integer(int64)¦null

false

none

» expiryPathID

body

integer(int32)¦null

false

none

» sendNotification

body

boolean¦null

false

none

» inquiryStatus

body

string¦null

false

none

» alertType

body

string¦null

false

none

» subject

body

string¦null

false

none

» body

body

string¦null

false

none

» externalEmails

body

[Varicent.RESTAPI.v1.DTOs.ExternalEmailDTO]¦null

false

none

»» email

body

string¦null

false

none

»» isCC

body

boolean

false

none

» autoAdjust

body

RESTAPI.v1.DTOs.BPM.BPMAutoAdjustNodeFieldDTO

false

none

»» sourceTableName

body

string¦null

false

none

»» columnMappings

body

array¦null

false

none

»»» anonymous

body

any

false

none

» isAdmin

body

boolean

false

none

» swimLaneName

body

string¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

» objectRestrictions

body

object¦null

false

none

»» additionalProperties

body

RESTAPI.v1.DTOs.BPM.BPMVisibilityEditabilityDTO

false

none

»»» visible

body

boolean

false

none

»»» editable

body

boolean

false

none

» workflowId

body

integer(int32)¦null

false

none

» reportId

body

integer(int32)¦null

false

none

» isAppendPdf

body

boolean¦null

false

none

» uploadedPdfName

body

string¦null

false

none

» uploadedPdf

body

string¦null

false

none

» pdfAppendOrder

body

string¦null

false

none

» isUploadedExistingPdf

body

boolean¦null

false

none

Enumerated Values

Parameter

Value

»» reviewResult

Rejected

»» reviewResult

Approved

»» reviewResult

None

» nodeType

Start

» nodeType

End

» nodeType

Action

» nodeType

Alert

» nodeType

Process

» nodeType

Conditional

» nodeType

AutoAdjust

» nodeType

GeneratePdf

» nodeType

Sign

» expiryType

None

» expiryType

DateTime

» expiryType

TimeLength

» screenshotType

Unkown

» screenshotType

Full

» screenshotType

Preview

» screenshotType

None

» inquiryStatus

Entered

» inquiryStatus

Investigating

» inquiryStatus

Escalated

» inquiryStatus

WaitingForApproval

» inquiryStatus

MoreInfoRequired

» inquiryStatus

Resolved

» inquiryStatus

Closed

» alertType

Email

» alertType

InternalAndEmail

» alertType

Internal

» pdfAppendOrder

Unknown

» pdfAppendOrder

AfterAgreement

» pdfAppendOrder

BeforeAgreement

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/workflowmanager/workflows/{id}/nodes/{nodeid}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/workflows/{id}/nodes/{nodeid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "swimLaneId": 0,
  "name": "string",
  "description": "string",
  "order": 0,
  "paths": [
    {
      "pathID": 0,
      "name": "string",
      "originNodeID": 0,
      "destinationNodeID": 0,
      "allMember": true,
      "allSubmit": true,
      "saveAndSubmit": true,
      "reviewResult": "Rejected",
      "position": 0,
      "condition": "string",
      "isDefault": true,
      "isSign": true
    }
  ],
  "nodeType": "Start",
  "schedulerFolderId": 0,
  "layoutAssignment": {
    "property1": {
      "first": true,
      "second": true
    },
    "property2": {
      "first": true,
      "second": true
    }
  },
  "expiryType": "None",
  "screenshotType": "Unkown",
  "useVaricentLogo": true,
  "expiryDateTime": "2019-08-24T14:15:22Z",
  "expiryTimeLength": 0,
  "expiryPathID": 0,
  "sendNotification": true,
  "inquiryStatus": "Entered",
  "alertType": "Email",
  "subject": "string",
  "body": "string",
  "externalEmails": [
    {
      "email": "string",
      "isCC": true
    }
  ],
  "autoAdjust": {
    "sourceTableName": "string",
    "columnMappings": []
  },
  "isAdmin": true,
  "swimLaneName": "string",
  "version": {
    "rowVersion": 0
  },
  "objectRestrictions": {
    "property1": {
      "visible": true,
      "editable": true
    },
    "property2": {
      "visible": true,
      "editable": true
    }
  },
  "workflowId": 0,
  "reportId": 0,
  "isAppendPdf": true,
  "uploadedPdfName": "string",
  "uploadedPdf": "string",
  "pdfAppendOrder": "Unknown",
  "isUploadedExistingPdf": true
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/workflowmanager/workflows/{id}/nodes/{nodeid}',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.delete('http://localhost:8080/api/v1/workflowmanager/workflows/{id}/nodes/{nodeid}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.delete 'http://localhost:8080/api/v1/workflowmanager/workflows/{id}/nodes/{nodeid}',
  params: {
  }, headers: headers

p JSON.parse(result)

Update a token (this is used to reassign error action).

Body parameter

{
  "name": "string",
  "id": "string"
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

tokenId

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.PayeeNameDTO

false

none

» name

body

string¦null

false

none

» id

body

string¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/workflowmanager/workflows/{id}/tokens/{tokenId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/workflows/{id}/tokens/{tokenId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "name": "string",
  "id": "string"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/workflowmanager/workflows/{id}/tokens/{tokenId}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/workflowmanager/workflows/{id}/tokens/{tokenId}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/workflowmanager/workflows/{id}/tokens/{tokenId}',
  params: {
  }, headers: headers

p JSON.parse(result)

Remove a token (this is used to remove an errored BPM action).

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

tokenId

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/workflowmanager/workflows/{id}/tokens/{tokenId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/workflows/{id}/tokens/{tokenId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/workflowmanager/workflows/{id}/tokens/{tokenId}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/workflowmanager/workflows/{id}/tokens/{tokenId}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/workflowmanager/workflows/{id}/tokens/{tokenId}',
  params: {
  }

p JSON.parse(result)

Get a workflow overview (error number, and so on).

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.BPMWorkflowInformationDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workflowmanager/workflows/{id}/information", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/workflows/{id}/information");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflowmanager/workflows/{id}/information',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/workflowmanager/workflows/{id}/information', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/workflowmanager/workflows/{id}/information',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "errors": 0,
  "pendingActions": 0,
  "history": 0
}
{"id":0,"errors":0,"pendingActions":0,"history":0}

Set the payees for a workflow swim lane.

Body parameter

{
  "modification": {
    "itemsToAdd": [
      "string"
    ],
    "itemsToRemove": [
      "string"
    ]
  },
  "query": {
    "selectItems": [
      {}
    ],
    "source": {
      "namespaceTable": {},
      "query": null,
      "alias": "string",
      "sourceType": "Table"
    },
    "joins": [
      {}
    ],
    "whereClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "order": [
      {}
    ],
    "group": [
      {}
    ],
    "havingClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "distinct": true,
    "unionWith": null,
    "exceptWith": null
  },
  "selectAllRows": true
}

Parameters

Name

In

Type

Required

Description

workflowId

path

integer(int32)

true

Workflow id

swimLaneId

path

integer(int32)

true

Swim lane id

body

body

Varicent.RESTAPI.v1.DTOs.QueryDeltaDTO

false

The query used to modify the payee list. Only allows additions.

» modification

body

[Varicent.RESTAPI.v1.DTOs.Core.CollectionModificationDTO1[System.String]](#schemavaricent.restapi.v1.dtos.core.collectionmodificationdto1[system.string])

false

none

»» itemsToAdd

body

[string]¦null

false

none

»» itemsToRemove

body

[string]¦null

false

none

» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»» alias

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» table

body

string¦null

false

none

»»» customSelect

body

string¦null

false

none

»»» dataType

body

string

false

none

»»» type

body

string

false

none

»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» expressionType

body

string

false

none

»»»» cases

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» op

body

string¦null

false

none

»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»» constraintType

body

string

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» expressionType

body

string

false

none

»»»»»»» cases

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» arguments

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» condition

body

any

false

none

»»»»»»» trueValue

body

any

false

none

»»»»»»» falseValue

body

any

false

none

»»»»»»» isDate

body

boolean

false

none

»»»»»»» literalType

body

string

false

none

»»»»»»» value

body

any

false

none

»»»»»» caseSensitive

body

boolean

false

none

»»»»»» constraints

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» literalRight

body

any

false

none

»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»» right

body

any

false

none

»»»»»» expressionLeft

body

any

false

none

»»»»»» expressionRight

body

any

false

none

»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»» like

body

string¦null

false

none

»»»»»» escapeWildcards

body

boolean

false

none

»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» queryDefinitionRight

body

any

false

none

»»»»» trueValue

body

any

false

none

»»»»» falseValue

body

any

false

none

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» isDate

body

boolean

false

none

»»»» literalType

body

string

false

none

»»»» value

body

any

false

none

»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»» m_namespace

body

string¦null

false

none

»»»» name

body

string¦null

false

none

»»» query

body

any

false

none

»»» alias

body

string¦null

false

none

»»» sourceType

body

string

false

none

»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»» joinType

body

string

false

none

»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»» constraintType

body

string

false

none

»»»» op

body

string¦null

false

none

»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» caseSensitive

body

boolean

false

none

»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» isPreciseDecimal

body

boolean

false

none

»»»» like

body

string¦null

false

none

»»»» escapeWildcards

body

boolean

false

none

»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»» table

body

string¦null

false

none

»»»» queryDefinitionRight

body

any

false

none

»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» direction

body

string

false

none

»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» distinct

body

boolean

false

none

»» unionWith

body

any

false

none

»» exceptWith

body

any

false

none

» selectAllRows

body

boolean¦null

false

none

Enumerated Values

Parameter

Value

»»» dataType

Int

»»» dataType

Decimal

»»» dataType

DateTime

»»» dataType

None

»»» dataType

String

»»» type

SelectAll

»»» type

SelectItem

»»» type

SelectLiteral

»»» type

SelectCustom

»»» type

SelectExpression

»»»» expressionType

caseExpression

»»»» expressionType

dataField

»»»» expressionType

function

»»»» expressionType

ifExpression

»»»» expressionType

literal

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» constraintType

clause

»»»»»» constraintType

constraint

»»»»»» constraintType

expressionConstraint

»»»»»» constraintType

likeConstraint

»»»»»» constraintType

rowVersionConstraint

»»»»»» constraintType

subQueryConstraint

»»»»»»» expressionType

caseExpression

»»»»»»» expressionType

dataField

»»»»»»» expressionType

function

»»»»»»» expressionType

ifExpression

»»»»»»» expressionType

literal

»»»»»»» literalType

Integer

»»»»»»» literalType

Decimal

»»»»»»» literalType

Date

»»»»»»» literalType

DateTime

»»»»»»» literalType

String

»»»»»»» literalType

Float

»»»»»»» literalType

Long

»»»»»»» literalType

Null

»»»»»»» literalType

Parameter

»»»»»»» literalType

Guid

»»»»»»» literalType

SystemUtcTime

»»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» literalType

Integer

»»»» literalType

Decimal

»»»» literalType

Date

»»»» literalType

DateTime

»»»» literalType

String

»»»» literalType

Float

»»»» literalType

Long

»»»» literalType

Null

»»»» literalType

Parameter

»»»» literalType

Guid

»»»» literalType

SystemUtcTime

»»»» literalType

Boolean

»»» sourceType

Table

»»» sourceType

Query

»»» joinType

Inner

»»» joinType

Left

»»» joinType

Right

»»» joinType

Cross

»»» joinType

CrossApply

»»» joinType

OuterApply

»»»» constraintType

clause

»»»» constraintType

constraint

»»»» constraintType

expressionConstraint

»»»» constraintType

likeConstraint

»»»» constraintType

rowVersionConstraint

»»»» constraintType

subQueryConstraint

»»» direction

Ascending

»»» direction

Descending

»»» direction

AscendingNullsFirst

»»» direction

DescendingNullsLast

Responses

Status

Meaning

Description

Schema

200

OK

Add payees to a workflow swim lane

Varicent.RESTAPI.v1.DTOs.BPMWorkflowDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/workflows/{workflowId}/swimlanes/{swimLaneId}/payeesByQuery", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflows/{workflowId}/swimlanes/{swimLaneId}/payeesByQuery");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "modification": {
    "itemsToAdd": [
      "string"
    ],
    "itemsToRemove": [
      "string"
    ]
  },
  "query": {
    "selectItems": [
      {}
    ],
    "source": {
      "namespaceTable": {},
      "query": null,
      "alias": "string",
      "sourceType": "Table"
    },
    "joins": [
      {}
    ],
    "whereClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "order": [
      {}
    ],
    "group": [
      {}
    ],
    "havingClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "distinct": true,
    "unionWith": null,
    "exceptWith": null
  },
  "selectAllRows": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflows/{workflowId}/swimlanes/{swimLaneId}/payeesByQuery',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/workflows/{workflowId}/swimlanes/{swimLaneId}/payeesByQuery', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/workflows/{workflowId}/swimlanes/{swimLaneId}/payeesByQuery',
  params: {
  }, headers: headers

p JSON.parse(result)

Set the payees for a workflow swim lane. As opposed to PUT, this method should be used on a stopped workflow.

Body parameter

{
  "itemsToAdd": [
    "string"
  ],
  "itemsToRemove": [
    "string"
  ]
}

Parameters

Name

In

Type

Required

Description

workflowId

path

integer(int32)

true

Workflow id

swimLaneId

path

integer(int32)

true

Swim lane id

body

body

[Varicent.RESTAPI.v1.DTOs.Core.CollectionModificationDTO1[System.String]](#schemavaricent.restapi.v1.dtos.core.collectionmodificationdto1[system.string])

false

A list of IDs of payees to add to the swimlane and a list of IDs to remove

» itemsToAdd

body

[string]¦null

false

none

» itemsToRemove

body

[string]¦null

false

none

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/workflows/{workflowId}/swimlanes/{swimLaneId}/payees", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflows/{workflowId}/swimlanes/{swimLaneId}/payees");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "itemsToAdd": [
    "string"
  ],
  "itemsToRemove": [
    "string"
  ]
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/workflows/{workflowId}/swimlanes/{swimLaneId}/payees',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/workflows/{workflowId}/swimlanes/{swimLaneId}/payees', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/workflows/{workflowId}/swimlanes/{swimLaneId}/payees',
  params: {
  }, headers: headers

p JSON.parse(result)

Get the payees for a workflow swim lane, with pagination included.

Parameters

Name

In

Type

Required

Description

workflowId

path

integer(int32)

true

Workflow id

swimLaneId

path

integer(int32)

true

Swim lane id

offset

query

integer(int32)

false

none

limit

query

integer(int32)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.ResultSetDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workflows/{workflowId}/swimlanes/{swimLaneId}/payees", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflows/{workflowId}/swimlanes/{swimLaneId}/payees");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflows/{workflowId}/swimlanes/{swimLaneId}/payees',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/workflows/{workflowId}/swimlanes/{swimLaneId}/payees', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/workflows/{workflowId}/swimlanes/{swimLaneId}/payees',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "columnDefinitions": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "data": [
    null
  ],
  "columnSourceMap": {
    "property1": "string",
    "property2": "string"
  },
  "isDataSynced": true,
  "hierarchyMetadata": {
    "tableName": "string",
    "idColumnName": "string",
    "parentColumnName": "string"
  }
}
{"columnDefinitions":[{"name":"string","type":"String","isKey":true,"nullable":true,"values":"string","lockedPeriod":{},"referencedCol":"string","picklistFilter":"string","displayName":"string","isELTPeriod":true}],"data":[null],"columnSourceMap":{"property1":"string","property2":"string"},"isDataSynced":true,"hierarchyMetadata":{"tableName":"string","idColumnName":"string","parentColumnName":"string"}}

Removes payees from the initiator swimlane of a currently running workflow.

Body parameter

[
  "string"
]

Parameters

Name

In

Type

Required

Description

workflowId

path

integer(int32)

true

Workflow id

body

body

array[string]

false

An array of payee ids

Responses

Status

Meaning

Description

Schema

200

OK

Remove payees from a workflow swim lane

Varicent.RESTAPI.v1.DTOs.BPMWorkflowDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/workflows/{workflowId}/initiatorPayees", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflows/{workflowId}/initiatorPayees");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  "string"
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflows/{workflowId}/initiatorPayees',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.delete('http://localhost:8080/api/v1/workflows/{workflowId}/initiatorPayees', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.delete 'http://localhost:8080/api/v1/workflows/{workflowId}/initiatorPayees',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "description": "string",
  "isSingleInstance": true,
  "workflowState": "Stopped",
  "conditionalVars": [
    {
      "expressionName": "string",
      "name": "string",
      "variableType": "Text"
    }
  ],
  "columnCount": 0,
  "workflowConfig": {
    "pendingWorkflowEnabled": true
  },
  "runCount": 0,
  "runDate": "string",
  "runBy": "string",
  "lastActioned": "string",
  "workflowType": "PresenterReport",
  "webReport": {
    "parameters": [
      {}
    ],
    "layoutAssignment": {
      "property1": {},
      "property2": {}
    },
    "webReportID": 0
  },
  "inquiry": {
    "hasRun": true,
    "components": [
      {}
    ]
  },
  "bpmWorkflowPresenterFlexReportDTO": {
    "reportId": 0,
    "parameters": [
      {}
    ],
    "objectRestrictions": {
      "property1": {},
      "property2": {}
    }
  },
  "bpmWorkflowPlanDocPresenterFlexReportDTO": {
    "reportId": 0,
    "parameters": [
      {}
    ],
    "templateType": "Payee"
  },
  "assignedReports": [
    "string"
  ],
  "numReportsAssigned": 0,
  "permissions": {
    "advanceToken": [
      "Start"
    ],
    "viewDocuments": [
      "Start"
    ]
  },
  "parentFolder": {
    "folderID": 0,
    "folderName": "string",
    "rowVersion": {
      "rowVersion": 0
    },
    "workflowType": "PresenterReport"
  },
  "parameters": [
    {
      "paramName": "string",
      "value": "string",
      "paramType": "Text",
      "valueType": "Constant",
      "usesReportValue": true,
      "isRequired": true
    }
  ],
  "layoutAssignment": {
    "property1": {
      "first": true,
      "second": true
    },
    "property2": {
      "first": true,
      "second": true
    }
  },
  "webReportID": 0,
  "version": {
    "rowVersion": 0
  }
}
{"id":0,"name":"string","description":"string","isSingleInstance":true,"workflowState":"Stopped","conditionalVars":[{"expressionName":"string","name":"string","variableType":"Text"}],"columnCount":0,"workflowConfig":{"pendingWorkflowEnabled":true},"runCount":0,"runDate":"string","runBy":"string","lastActioned":"string","workflowType":"PresenterReport","webReport":{"parameters":[{}],"layoutAssignment":{"property1":{},"property2":{}},"webReportID":0},"inquiry":{"hasRun":true,"components":[{}]},"bpmWorkflowPresenterFlexReportDTO":{"reportId":0,"parameters":[{}],"objectRestrictions":{"property1":{},"property2":{}}},"bpmWorkflowPlanDocPresenterFlexReportDTO":{"reportId":0,"parameters":[{}],"templateType":"Payee"},"assignedReports":["string"],"numReportsAssigned":0,"permissions":{"advanceToken":["Start"],"viewDocuments":["Start"]},"parentFolder":{"folderID":0,"folderName":"string","rowVersion":{"rowVersion":0},"workflowType":"PresenterReport"},"parameters":[{"paramName":"string","value":"string","paramType":"Text","valueType":"Constant","usesReportValue":true,"isRequired":true}],"layoutAssignment":{"property1":{"first":true,"second":true},"property2":{"first":true,"second":true}},"webReportID":0,"version":{"rowVersion":0}}

Gets all payees and marks which ones are currently in the swimlane.

Body parameter

{
  "swimlaneId": 0,
  "queryDTO": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "limit": 0,
    "offset": 0,
    "timeout": 0,
    "retrieveFromDataServer": "QUERY_SQL",
    "exportFileFormat": "Excel"
  },
  "restrictQuery": true
}

Parameters

Name

In

Type

Required

Description

offset

query

integer(int32)

false

none

limit

query

integer(int32)

false

none

filter

query

string

false

none

fields

query

string

false

none

unique

query

boolean

false

none

body

body

RESTAPI.v1.DTOs.BPM.BPMGetSelectedPayeesDTO

false

none

» swimlaneId

body

integer(int32)¦null

false

none

» queryDTO

body

Varicent.RESTAPI.v1.DTOs.RunQueryDefinitionDTO

false

none

»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»» alias

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» table

body

string¦null

false

none

»»»» customSelect

body

string¦null

false

none

»»»» dataType

body

string

false

none

»»»» type

body

string

false

none

»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»» expressionType

body

string

false

none

»»»»»» cases

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» arguments

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»» constraintType

body

string

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» condition

body

any

false

none

»»»»»»»» trueValue

body

any

false

none

»»»»»»»» falseValue

body

any

false

none

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»» constraints

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» literalRight

body

any

false

none

»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» right

body

any

false

none

»»»»»»» expressionLeft

body

any

false

none

»»»»»»» expressionRight

body

any

false

none

»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»» like

body

string¦null

false

none

»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»» trueValue

body

any

false

none

»»»»»» falseValue

body

any

false

none

»»»»»» isDate

body

boolean

false

none

»»»»»» literalType

body

string

false

none

»»»»»» value

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»» m_namespace

body

string¦null

false

none

»»»»» name

body

string¦null

false

none

»»»» query

body

any

false

none

»»»» alias

body

string¦null

false

none

»»»» sourceType

body

string

false

none

»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» joinType

body

string

false

none

»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» constraintType

body

string

false

none

»»»»» op

body

string¦null

false

none

»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» caseSensitive

body

boolean

false

none

»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isPreciseDecimal

body

boolean

false

none

»»»»» like

body

string¦null

false

none

»»»»» escapeWildcards

body

boolean

false

none

»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»» table

body

string¦null

false

none

»»»»» queryDefinitionRight

body

any

false

none

»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» direction

body

string

false

none

»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» distinct

body

boolean

false

none

»»» unionWith

body

any

false

none

»»» exceptWith

body

any

false

none

»» limit

body

integer(int32)

false

none

»» offset

body

integer(int32)

false

none

»» timeout

body

integer(int32)

false

none

»» retrieveFromDataServer

body

string

false

none

»» exportFileFormat

body

string

false

none

» restrictQuery

body

boolean

false

none

Enumerated Values

Parameter

Value

»»»» dataType

Int

»»»» dataType

Decimal

»»»» dataType

DateTime

»»»» dataType

None

»»»» dataType

String

»»»» type

SelectAll

»»»» type

SelectItem

»»»» type

SelectLiteral

»»»» type

SelectCustom

»»»» type

SelectExpression

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» expressionType

caseExpression

»»»»»» expressionType

dataField

»»»»»» expressionType

function

»»»»»» expressionType

ifExpression

»»»»»» expressionType

literal

»»»»»»» constraintType

clause

»»»»»»» constraintType

constraint

»»»»»»» constraintType

expressionConstraint

»»»»»»» constraintType

likeConstraint

»»»»»»» constraintType

rowVersionConstraint

»»»»»»» constraintType

subQueryConstraint

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»» literalType

Integer

»»»»»» literalType

Decimal

»»»»»» literalType

Date

»»»»»» literalType

DateTime

»»»»»» literalType

String

»»»»»» literalType

Float

»»»»»» literalType

Long

»»»»»» literalType

Null

»»»»»» literalType

Parameter

»»»»»» literalType

Guid

»»»»»» literalType

SystemUtcTime

»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» sourceType

Table

»»»» sourceType

Query

»»»» joinType

Inner

»»»» joinType

Left

»»»» joinType

Right

»»»» joinType

Cross

»»»» joinType

CrossApply

»»»» joinType

OuterApply

»»»»» constraintType

clause

»»»»» constraintType

constraint

»»»»» constraintType

expressionConstraint

»»»»» constraintType

likeConstraint

»»»»» constraintType

rowVersionConstraint

»»»»» constraintType

subQueryConstraint

»»»» direction

Ascending

»»»» direction

Descending

»»»» direction

AscendingNullsFirst

»»»» direction

DescendingNullsLast

»» retrieveFromDataServer

QUERY_SQL

»» retrieveFromDataServer

QUERY_SPARK

»» retrieveFromDataServer

QUERY_PRESTO

»» exportFileFormat

Excel

»» exportFileFormat

MSCRM

»» exportFileFormat

Pdf

»» exportFileFormat

Salesforce

»» exportFileFormat

Text

»» exportFileFormat

COS

»» exportFileFormat

Zip

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.ResultSetDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/workflows/getselectedpayees", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflows/getselectedpayees");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "swimlaneId": 0,
  "queryDTO": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "limit": 0,
    "offset": 0,
    "timeout": 0,
    "retrieveFromDataServer": "QUERY_SQL",
    "exportFileFormat": "Excel"
  },
  "restrictQuery": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflows/getselectedpayees',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/workflows/getselectedpayees', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/workflows/getselectedpayees',
  params: {
  }, headers: headers

p JSON.parse(result)

Get a list of the payees that can be added to the workflow

Body parameter

{
  "query": {
    "selectItems": [
      {}
    ],
    "source": {
      "namespaceTable": {},
      "query": null,
      "alias": "string",
      "sourceType": "Table"
    },
    "joins": [
      {}
    ],
    "whereClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "order": [
      {}
    ],
    "group": [
      {}
    ],
    "havingClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "distinct": true,
    "unionWith": null,
    "exceptWith": null
  },
  "limit": 0,
  "offset": 0,
  "timeout": 0,
  "retrieveFromDataServer": "QUERY_SQL",
  "exportFileFormat": "Excel"
}

Parameters

Name

In

Type

Required

Description

workflowId

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.RunQueryDefinitionDTO

false

none

» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»» alias

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» table

body

string¦null

false

none

»»» customSelect

body

string¦null

false

none

»»» dataType

body

string

false

none

»»» type

body

string

false

none

»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» expressionType

body

string

false

none

»»»» cases

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» op

body

string¦null

false

none

»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»» constraintType

body

string

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» expressionType

body

string

false

none

»»»»»»» cases

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» arguments

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» condition

body

any

false

none

»»»»»»» trueValue

body

any

false

none

»»»»»»» falseValue

body

any

false

none

»»»»»»» isDate

body

boolean

false

none

»»»»»»» literalType

body

string

false

none

»»»»»»» value

body

any

false

none

»»»»»» caseSensitive

body

boolean

false

none

»»»»»» constraints

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» literalRight

body

any

false

none

»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»» right

body

any

false

none

»»»»»» expressionLeft

body

any

false

none

»»»»»» expressionRight

body

any

false

none

»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»» like

body

string¦null

false

none

»»»»»» escapeWildcards

body

boolean

false

none

»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» queryDefinitionRight

body

any

false

none

»»»»» trueValue

body

any

false

none

»»»»» falseValue

body

any

false

none

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» isDate

body

boolean

false

none

»»»» literalType

body

string

false

none

»»»» value

body

any

false

none

»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»» m_namespace

body

string¦null

false

none

»»»» name

body

string¦null

false

none

»»» query

body

any

false

none

»»» alias

body

string¦null

false

none

»»» sourceType

body

string

false

none

»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»» joinType

body

string

false

none

»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»» constraintType

body

string

false

none

»»»» op

body

string¦null

false

none

»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» caseSensitive

body

boolean

false

none

»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» isPreciseDecimal

body

boolean

false

none

»»»» like

body

string¦null

false

none

»»»» escapeWildcards

body

boolean

false

none

»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»» table

body

string¦null

false

none

»»»» queryDefinitionRight

body

any

false

none

»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» direction

body

string

false

none

»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» distinct

body

boolean

false

none

»» unionWith

body

any

false

none

»» exceptWith

body

any

false

none

» limit

body

integer(int32)

false

none

» offset

body

integer(int32)

false

none

» timeout

body

integer(int32)

false

none

» retrieveFromDataServer

body

string

false

none

» exportFileFormat

body

string

false

none

Enumerated Values

Parameter

Value

»»» dataType

Int

»»» dataType

Decimal

»»» dataType

DateTime

»»» dataType

None

»»» dataType

String

»»» type

SelectAll

»»» type

SelectItem

»»» type

SelectLiteral

»»» type

SelectCustom

»»» type

SelectExpression

»»»» expressionType

caseExpression

»»»» expressionType

dataField

»»»» expressionType

function

»»»» expressionType

ifExpression

»»»» expressionType

literal

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» constraintType

clause

»»»»»» constraintType

constraint

»»»»»» constraintType

expressionConstraint

»»»»»» constraintType

likeConstraint

»»»»»» constraintType

rowVersionConstraint

»»»»»» constraintType

subQueryConstraint

»»»»»»» expressionType

caseExpression

»»»»»»» expressionType

dataField

»»»»»»» expressionType

function

»»»»»»» expressionType

ifExpression

»»»»»»» expressionType

literal

»»»»»»» literalType

Integer

»»»»»»» literalType

Decimal

»»»»»»» literalType

Date

»»»»»»» literalType

DateTime

»»»»»»» literalType

String

»»»»»»» literalType

Float

»»»»»»» literalType

Long

»»»»»»» literalType

Null

»»»»»»» literalType

Parameter

»»»»»»» literalType

Guid

»»»»»»» literalType

SystemUtcTime

»»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» literalType

Integer

»»»» literalType

Decimal

»»»» literalType

Date

»»»» literalType

DateTime

»»»» literalType

String

»»»» literalType

Float

»»»» literalType

Long

»»»» literalType

Null

»»»» literalType

Parameter

»»»» literalType

Guid

»»»» literalType

SystemUtcTime

»»»» literalType

Boolean

»»» sourceType

Table

»»» sourceType

Query

»»» joinType

Inner

»»» joinType

Left

»»» joinType

Right

»»» joinType

Cross

»»» joinType

CrossApply

»»» joinType

OuterApply

»»»» constraintType

clause

»»»» constraintType

constraint

»»»» constraintType

expressionConstraint

»»»» constraintType

likeConstraint

»»»» constraintType

rowVersionConstraint

»»»» constraintType

subQueryConstraint

»»» direction

Ascending

»»» direction

Descending

»»» direction

AscendingNullsFirst

»»» direction

DescendingNullsLast

» retrieveFromDataServer

QUERY_SQL

» retrieveFromDataServer

QUERY_SPARK

» retrieveFromDataServer

QUERY_PRESTO

» exportFileFormat

Excel

» exportFileFormat

MSCRM

» exportFileFormat

Pdf

» exportFileFormat

Salesforce

» exportFileFormat

Text

» exportFileFormat

COS

» exportFileFormat

Zip

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.ResultSetDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/workflows/{workflowId}/availablePayees", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflows/{workflowId}/availablePayees");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "query": {
    "selectItems": [
      {}
    ],
    "source": {
      "namespaceTable": {},
      "query": null,
      "alias": "string",
      "sourceType": "Table"
    },
    "joins": [
      {}
    ],
    "whereClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "order": [
      {}
    ],
    "group": [
      {}
    ],
    "havingClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "distinct": true,
    "unionWith": null,
    "exceptWith": null
  },
  "limit": 0,
  "offset": 0,
  "timeout": 0,
  "retrieveFromDataServer": "QUERY_SQL",
  "exportFileFormat": "Excel"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflows/{workflowId}/availablePayees',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/workflows/{workflowId}/availablePayees', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/workflows/{workflowId}/availablePayees',
  params: {
  }, headers: headers

p JSON.parse(result)

Start a workflow.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Workflow id

Responses

Status

Meaning

Description

Schema

200

OK

Start a workflow

Varicent.RESTAPI.v1.DTOs.BPMWorkflowDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/workflows/{id}/start", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/workflows/{id}/start");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/workflows/{id}/start',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/workflows/{id}/start', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/workflows/{id}/start',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "description": "string",
  "isSingleInstance": true,
  "workflowState": "Stopped",
  "conditionalVars": [
    {
      "expressionName": "string",
      "name": "string",
      "variableType": "Text"
    }
  ],
  "columnCount": 0,
  "workflowConfig": {
    "pendingWorkflowEnabled": true
  },
  "runCount": 0,
  "runDate": "string",
  "runBy": "string",
  "lastActioned": "string",
  "workflowType": "PresenterReport",
  "webReport": {
    "parameters": [
      {}
    ],
    "layoutAssignment": {
      "property1": {},
      "property2": {}
    },
    "webReportID": 0
  },
  "inquiry": {
    "hasRun": true,
    "components": [
      {}
    ]
  },
  "bpmWorkflowPresenterFlexReportDTO": {
    "reportId": 0,
    "parameters": [
      {}
    ],
    "objectRestrictions": {
      "property1": {},
      "property2": {}
    }
  },
  "bpmWorkflowPlanDocPresenterFlexReportDTO": {
    "reportId": 0,
    "parameters": [
      {}
    ],
    "templateType": "Payee"
  },
  "assignedReports": [
    "string"
  ],
  "numReportsAssigned": 0,
  "permissions": {
    "advanceToken": [
      "Start"
    ],
    "viewDocuments": [
      "Start"
    ]
  },
  "parentFolder": {
    "folderID": 0,
    "folderName": "string",
    "rowVersion": {
      "rowVersion": 0
    },
    "workflowType": "PresenterReport"
  },
  "parameters": [
    {
      "paramName": "string",
      "value": "string",
      "paramType": "Text",
      "valueType": "Constant",
      "usesReportValue": true,
      "isRequired": true
    }
  ],
  "layoutAssignment": {
    "property1": {
      "first": true,
      "second": true
    },
    "property2": {
      "first": true,
      "second": true
    }
  },
  "webReportID": 0,
  "version": {
    "rowVersion": 0
  }
}
{"id":0,"name":"string","description":"string","isSingleInstance":true,"workflowState":"Stopped","conditionalVars":[{"expressionName":"string","name":"string","variableType":"Text"}],"columnCount":0,"workflowConfig":{"pendingWorkflowEnabled":true},"runCount":0,"runDate":"string","runBy":"string","lastActioned":"string","workflowType":"PresenterReport","webReport":{"parameters":[{}],"layoutAssignment":{"property1":{},"property2":{}},"webReportID":0},"inquiry":{"hasRun":true,"components":[{}]},"bpmWorkflowPresenterFlexReportDTO":{"reportId":0,"parameters":[{}],"objectRestrictions":{"property1":{},"property2":{}}},"bpmWorkflowPlanDocPresenterFlexReportDTO":{"reportId":0,"parameters":[{}],"templateType":"Payee"},"assignedReports":["string"],"numReportsAssigned":0,"permissions":{"advanceToken":["Start"],"viewDocuments":["Start"]},"parentFolder":{"folderID":0,"folderName":"string","rowVersion":{"rowVersion":0},"workflowType":"PresenterReport"},"parameters":[{"paramName":"string","value":"string","paramType":"Text","valueType":"Constant","usesReportValue":true,"isRequired":true}],"layoutAssignment":{"property1":{"first":true,"second":true},"property2":{"first":true,"second":true}},"webReportID":0,"version":{"rowVersion":0}}

Stop a workflow.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Workflow id

Responses

Status

Meaning

Description

Schema

200

OK

Stop a workflow

Varicent.RESTAPI.v1.DTOs.BPMWorkflowDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/workflows/{id}/stop", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/workflows/{id}/stop");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/workflows/{id}/stop',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/workflows/{id}/stop', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/workflows/{id}/stop',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "description": "string",
  "isSingleInstance": true,
  "workflowState": "Stopped",
  "conditionalVars": [
    {
      "expressionName": "string",
      "name": "string",
      "variableType": "Text"
    }
  ],
  "columnCount": 0,
  "workflowConfig": {
    "pendingWorkflowEnabled": true
  },
  "runCount": 0,
  "runDate": "string",
  "runBy": "string",
  "lastActioned": "string",
  "workflowType": "PresenterReport",
  "webReport": {
    "parameters": [
      {}
    ],
    "layoutAssignment": {
      "property1": {},
      "property2": {}
    },
    "webReportID": 0
  },
  "inquiry": {
    "hasRun": true,
    "components": [
      {}
    ]
  },
  "bpmWorkflowPresenterFlexReportDTO": {
    "reportId": 0,
    "parameters": [
      {}
    ],
    "objectRestrictions": {
      "property1": {},
      "property2": {}
    }
  },
  "bpmWorkflowPlanDocPresenterFlexReportDTO": {
    "reportId": 0,
    "parameters": [
      {}
    ],
    "templateType": "Payee"
  },
  "assignedReports": [
    "string"
  ],
  "numReportsAssigned": 0,
  "permissions": {
    "advanceToken": [
      "Start"
    ],
    "viewDocuments": [
      "Start"
    ]
  },
  "parentFolder": {
    "folderID": 0,
    "folderName": "string",
    "rowVersion": {
      "rowVersion": 0
    },
    "workflowType": "PresenterReport"
  },
  "parameters": [
    {
      "paramName": "string",
      "value": "string",
      "paramType": "Text",
      "valueType": "Constant",
      "usesReportValue": true,
      "isRequired": true
    }
  ],
  "layoutAssignment": {
    "property1": {
      "first": true,
      "second": true
    },
    "property2": {
      "first": true,
      "second": true
    }
  },
  "webReportID": 0,
  "version": {
    "rowVersion": 0
  }
}
{"id":0,"name":"string","description":"string","isSingleInstance":true,"workflowState":"Stopped","conditionalVars":[{"expressionName":"string","name":"string","variableType":"Text"}],"columnCount":0,"workflowConfig":{"pendingWorkflowEnabled":true},"runCount":0,"runDate":"string","runBy":"string","lastActioned":"string","workflowType":"PresenterReport","webReport":{"parameters":[{}],"layoutAssignment":{"property1":{},"property2":{}},"webReportID":0},"inquiry":{"hasRun":true,"components":[{}]},"bpmWorkflowPresenterFlexReportDTO":{"reportId":0,"parameters":[{}],"objectRestrictions":{"property1":{},"property2":{}}},"bpmWorkflowPlanDocPresenterFlexReportDTO":{"reportId":0,"parameters":[{}],"templateType":"Payee"},"assignedReports":["string"],"numReportsAssigned":0,"permissions":{"advanceToken":["Start"],"viewDocuments":["Start"]},"parentFolder":{"folderID":0,"folderName":"string","rowVersion":{"rowVersion":0},"workflowType":"PresenterReport"},"parameters":[{"paramName":"string","value":"string","paramType":"Text","valueType":"Constant","usesReportValue":true,"isRequired":true}],"layoutAssignment":{"property1":{"first":true,"second":true},"property2":{"first":true,"second":true}},"webReportID":0,"version":{"rowVersion":0}}

Get the pending actions of a workflow.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Workflow id

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

orderBy

query

string

false

####Description

filter

query

string

false

####Supported operations

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

tokenID, nodeName, assignee, assigneeName, assignedAt, initiator, initiatorName, createdAt, nodeType

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

tokenID, nodeName, assignee, assigneeName, assignedAt, initiator, initiatorName, createdAt, nodeType

Responses

Status

Meaning

Description

Schema

200

OK

Get data, ordered by key column, for given table (limit, offset, filter supported)

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.BPM.BPMPendingActionStatusDTO]

false

none

none

» tokenID

integer(int32)

false

none

none

» nodeName

string¦null

false

none

none

» assignee

string¦null

false

none

none

» assigneeName

string¦null

false

none

none

» assignedAt

string(date-time)

false

none

none

» initiator

string¦null

false

none

none

» initiatorName

string¦null

false

none

none

» createdAt

string(date-time)

false

none

none

» nodeType

string

false

none

none

» paths

[RESTAPI.v1.DTOs.BPM.BPMPathDTO]¦null

false

none

none

»» pathID

integer(int32)

false

none

none

»» name

string¦null

false

none

none

»» originNodeID

integer(int32)

false

none

none

»» destinationNodeID

integer(int32)¦null

false

none

none

»» allMember

boolean

false

none

none

»» allSubmit

boolean

false

none

none

»» saveAndSubmit

boolean

false

none

none

»» reviewResult

string

false

none

none

»» position

integer(int32)

false

none

none

»» condition

string¦null

false

none

none

»» isDefault

boolean

false

none

none

»» isSign

boolean

false

none

none

Enumerated Values

Property

Value

nodeType

Start

nodeType

End

nodeType

Action

nodeType

Alert

nodeType

Process

nodeType

Conditional

nodeType

AutoAdjust

nodeType

GeneratePdf

nodeType

Sign

reviewResult

Rejected

reviewResult

Approved

reviewResult

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workflows/{id}/pending", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflows/{id}/pending");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflows/{id}/pending',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/workflows/{id}/pending', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/workflows/{id}/pending',
  params: {
  }, headers: headers

p JSON.parse(result)

Force a pending action.

Body parameter

{
  "tokenID": 0,
  "assignee": "string",
  "pathID": 0,
  "updateReportParams": {
    "reportID": 0,
    "parameters": {
      "property1": "string",
      "property2": "string"
    }
  }
}

Parameters

Name

In

Type

Required

Description

planDocumentId

path

integer(int32)

true

none

body

body

RESTAPI.v1.DTOs.BPM.BPMForcePendingActionDTO

false

none

» tokenID

body

integer(int32)

false

none

» assignee

body

string¦null

false

none

» pathID

body

integer(int32)

false

none

» updateReportParams

body

RESTAPI.v1.DTOs.BPM.BPMUpdateReportParametersDTO

false

none

»» reportID

body

integer(int32)

false

none

»» parameters

body

object¦null

false

none

»»» additionalProperties

body

string¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/internal/plandocument/{planDocumentId}/adminaction", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plandocument/{planDocumentId}/adminaction");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "tokenID": 0,
  "assignee": "string",
  "pathID": 0,
  "updateReportParams": {
    "reportID": 0,
    "parameters": {
      "property1": "string",
      "property2": "string"
    }
  }
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/internal/plandocument/{planDocumentId}/adminaction',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/internal/plandocument/{planDocumentId}/adminaction', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/internal/plandocument/{planDocumentId}/adminaction',
  params: {
  }, headers: headers

p JSON.parse(result)

Submit a new inquiry workflow.

Body parameter

{
  "inquiry": {
    "inquiryID": 0,
    "objectName": "string",
    "objectType": "string",
    "tokenID": 0,
    "dateCreated": "2019-08-24T14:15:22Z",
    "creator": "string",
    "payeeId": "string",
    "workflowID": 0,
    "workflowObjectID": 0,
    "adminOwner": {
      "adminSwimLaneID": 0,
      "assignee": "string",
      "adminSwimlaneName": "string"
    },
    "status": "Entered",
    "inquiryState": "Default",
    "subjectName": "string",
    "openFor": 0,
    "actionRequired": true,
    "canReopen": true,
    "lastUpdate": "2019-08-24T14:15:22Z",
    "isOpen": true,
    "isNew": true,
    "pickListValue": "string",
    "copiedRow": "string",
    "reportName": "string",
    "componentValueList": {
      "property1": {},
      "property2": {}
    },
    "rowVersion": {
      "rowVersion": 0
    }
  },
  "componentSelectionList": [
    {
      "inquiryID": 0,
      "componentID": 0,
      "componentName": "string",
      "componentType": "pickList",
      "componentValue": "string",
      "componentSourceDrivenID": "string"
    }
  ],
  "attachmentList": [
    {
      "bytes": "string",
      "path": "string"
    }
  ],
  "reportType": "PresenterAdaptive",
  "reportScreenshot": {
    "bytes": "string",
    "path": "string"
  }
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.BPMInquirySubmissionDTO

false

Inquiry workflow DTO

» inquiry

body

Varicent.RESTAPI.v1.DTOs.BPMInquiryDTO

false

none

»» inquiryID

body

integer(int32)

false

none

»» objectName

body

string¦null

false

none

»» objectType

body

string¦null

false

none

»» tokenID

body

integer(int32)

false

none

»» dateCreated

body

string(date-time)

false

none

»» creator

body

string¦null

false

none

»» payeeId

body

string¦null

false

none

»» workflowID

body

integer(int32)

false

none

»» workflowObjectID

body

integer(int32)

false

none

»» adminOwner

body

Varicent.RESTAPI.v1.DTOs.BPMInquiryOwnerDTO

false

none

»»» adminSwimLaneID

body

integer(int32)

false

none

»»» assignee

body

string¦null

false

none

»»» adminSwimlaneName

body

string¦null

false

none

»» status

body

string

false

none

»» inquiryState

body

string

false

none

»» subjectName

body

string¦null

false

none

»» openFor

body

integer(int32)

false

none

»» actionRequired

body

boolean

false

none

»» canReopen

body

boolean

false

none

»» lastUpdate

body

string(date-time)

false

none

»» isOpen

body

boolean

false

none

»» isNew

body

boolean

false

none

»» pickListValue

body

string¦null

false

none

»» copiedRow

body

string¦null

false

none

»» reportName

body

string¦null

false

none

»» componentValueList

body

object¦null

false

none

»»» additionalProperties

body

[System.Tuple3[System.String,System.String,System.String]](#schemasystem.tuple3[system.string,system.string,system.string])

false

none

»»»» item1

body

string¦null

false

none

»»»» item2

body

string¦null

false

none

»»»» item3

body

string¦null

false

none

»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» rowVersion

body

integer(int64)

false

none

» componentSelectionList

body

[Varicent.RESTAPI.v1.DTOs.BPMComponentSelectionDTO]¦null

false

none

»» inquiryID

body

integer(int32)

false

none

»» componentID

body

integer(int32)

false

none

»» componentName

body

string¦null

false

none

»» componentType

body

string

false

none

»» componentValue

body

string¦null

false

none

»» componentSourceDrivenID

body

string¦null

false

none

» attachmentList

body

[Varicent.RESTAPI.v1.DTOs.PortalAccess.AttachmentItemDTO]¦null

false

none

»» bytes

body

string¦null

false

none

»» path

body

string¦null

false

none

» reportType

body

string

false

none

» reportScreenshot

body

Varicent.RESTAPI.v1.DTOs.PortalAccess.AttachmentItemDTO

false

none

Enumerated Values

Parameter

Value

»» status

Entered

»» status

Investigating

»» status

Escalated

»» status

WaitingForApproval

»» status

MoreInfoRequired

»» status

Resolved

»» status

Closed

»» inquiryState

Default

»» inquiryState

FormFieldsReadOnly

»» inquiryState

ActionDisabled

»» componentType

pickList

»» componentType

title

»» componentType

subject

»» componentType

description

»» componentType

text

»» componentType

numeric

»» componentType

sourcePickList

» reportType

PresenterAdaptive

» reportType

DDE

» reportType

Rapid

» reportType

PresenterStructured

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.BPMInquiryDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/payee/workflowmanager/bpmInquiries", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payee/workflowmanager/bpmInquiries");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "inquiry": {
    "inquiryID": 0,
    "objectName": "string",
    "objectType": "string",
    "tokenID": 0,
    "dateCreated": "2019-08-24T14:15:22Z",
    "creator": "string",
    "payeeId": "string",
    "workflowID": 0,
    "workflowObjectID": 0,
    "adminOwner": {
      "adminSwimLaneID": 0,
      "assignee": "string",
      "adminSwimlaneName": "string"
    },
    "status": "Entered",
    "inquiryState": "Default",
    "subjectName": "string",
    "openFor": 0,
    "actionRequired": true,
    "canReopen": true,
    "lastUpdate": "2019-08-24T14:15:22Z",
    "isOpen": true,
    "isNew": true,
    "pickListValue": "string",
    "copiedRow": "string",
    "reportName": "string",
    "componentValueList": {
      "property1": {},
      "property2": {}
    },
    "rowVersion": {
      "rowVersion": 0
    }
  },
  "componentSelectionList": [
    {
      "inquiryID": 0,
      "componentID": 0,
      "componentName": "string",
      "componentType": "pickList",
      "componentValue": "string",
      "componentSourceDrivenID": "string"
    }
  ],
  "attachmentList": [
    {
      "bytes": "string",
      "path": "string"
    }
  ],
  "reportType": "PresenterAdaptive",
  "reportScreenshot": {
    "bytes": "string",
    "path": "string"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/payee/workflowmanager/bpmInquiries',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/payee/workflowmanager/bpmInquiries', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/payee/workflowmanager/bpmInquiries',
  params: {
  }, headers: headers

p JSON.parse(result)

Force a pending action on inquiry workflow for payee.

Body parameter

{
  "tokenID": 0,
  "pathID": 0,
  "inquiryID": 0
}

Parameters

Name

In

Type

Required

Description

workflowID

path

integer(int32)

true

Workflow id

body

body

RESTAPI.v1.DTOs.BPM.BPMForcePendingActionInquiryDTO

false

Force Pending Action DTO

» tokenID

body

integer(int32)

false

none

» pathID

body

integer(int32)

false

none

» inquiryID

body

integer(int32)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/payee/workflowmanager/bpmInquiries/{workflowID}/inquiryPending", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payee/workflowmanager/bpmInquiries/{workflowID}/inquiryPending");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "tokenID": 0,
  "pathID": 0,
  "inquiryID": 0
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/payee/workflowmanager/bpmInquiries/{workflowID}/inquiryPending',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/payee/workflowmanager/bpmInquiries/{workflowID}/inquiryPending', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/payee/workflowmanager/bpmInquiries/{workflowID}/inquiryPending',
  params: {
  }, headers: headers

p JSON.parse(result)

Force a pending action on inquiry workflow for admin.

Body parameter

{
  "tokenID": 0,
  "pathID": 0,
  "inquiryID": 0
}

Parameters

Name

In

Type

Required

Description

workflowID

path

integer(int32)

true

Workflow id

body

body

RESTAPI.v1.DTOs.BPM.BPMForcePendingActionInquiryDTO

false

Force Pending Action DTO

» tokenID

body

integer(int32)

false

none

» pathID

body

integer(int32)

false

none

» inquiryID

body

integer(int32)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/workflowmanager/bpmInquiries/{workflowID}/inquiryPending", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/bpmInquiries/{workflowID}/inquiryPending");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "tokenID": 0,
  "pathID": 0,
  "inquiryID": 0
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/workflowmanager/bpmInquiries/{workflowID}/inquiryPending',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/workflowmanager/bpmInquiries/{workflowID}/inquiryPending', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/workflowmanager/bpmInquiries/{workflowID}/inquiryPending',
  params: {
  }, headers: headers

p JSON.parse(result)

Get service node errors.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Workflow ID

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

orderBy

query

string

false

####Description

filter

query

string

false

####Supported operations

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

Any field

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

Any field

Responses

Status

Meaning

Description

Schema

200

OK

Get service node errors

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.BPM.Errors.BPMServiceNodeErrorStatusDTO]

false

none

none

» node

string¦null

false

none

none

» error

string¦null

false

none

none

» time

string(date-time)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workflows/{id}/errors/services", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflows/{id}/errors/services");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflows/{id}/errors/services',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/workflows/{id}/errors/services', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/workflows/{id}/errors/services',
  params: {
  }, headers: headers

p JSON.parse(result)

Get sign node errors.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Workflow ID

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

orderBy

query

string

false

####Description

filter

query

string

false

####Supported operations

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

Any field

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

Any field

Responses

Status

Meaning

Description

Schema

200

OK

Get sign node errors

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.BPM.Errors.BPMServiceNodeErrorStatusDTO]

false

none

none

» node

string¦null

false

none

none

» error

string¦null

false

none

none

» time

string(date-time)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workflows/{id}/errors/signs", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflows/{id}/errors/signs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflows/{id}/errors/signs',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/workflows/{id}/errors/signs', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/workflows/{id}/errors/signs',
  params: {
  }, headers: headers

p JSON.parse(result)

Get generate pdf node errors.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Workflow ID

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

orderBy

query

string

false

####Description

filter

query

string

false

####Supported operations

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

Any field

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

Any field

Responses

Status

Meaning

Description

Schema

200

OK

Get generate pdf node errors

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.BPM.Errors.BPMServiceNodeErrorStatusDTO]

false

none

none

» node

string¦null

false

none

none

» error

string¦null

false

none

none

» time

string(date-time)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workflows/{id}/errors/generatePdfs", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflows/{id}/errors/generatePdfs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflows/{id}/errors/generatePdfs',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/workflows/{id}/errors/generatePdfs', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/workflows/{id}/errors/generatePdfs',
  params: {
  }, headers: headers

p JSON.parse(result)

Get action node errors.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Workflow ID

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

orderBy

query

string

false

####Description

filter

query

string

false

####Supported operations

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

tokenID, nodeName, assignedAt, initiator, initiatorName, createdAt

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

tokenID, nodeName, assignedAt, initiator, initiatorName, createdAt

Responses

Status

Meaning

Description

Schema

200

OK

Get action node errors

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.BPM.Errors.BPMActionNodeErrorStatusDTO]

false

none

none

» tokenID

integer(int32)

false

none

none

» nodeName

string¦null

false

none

none

» assignedAt

string(date-time)

false

none

none

» initiator

string¦null

false

none

none

» initiatorName

string¦null

false

none

none

» createdAt

string(date-time)

false

none

none

» error

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workflows/{id}/errors/actions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflows/{id}/errors/actions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflows/{id}/errors/actions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/workflows/{id}/errors/actions', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/workflows/{id}/errors/actions',
  params: {
  }, headers: headers

p JSON.parse(result)

Get alert node errors.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

orderBy

query

string

false

####Description

filter

query

string

false

####Supported operations

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

Any field

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

Any field

Responses

Status

Meaning

Description

Schema

200

OK

Get alert node errors

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.BPM.Errors.BPMAlertNodeErrorStatusDTO]

false

none

none

» id

integer(int32)

false

none

none

» tokenId

integer(int32)

false

none

none

» nodeId

integer(int32)

false

none

none

» _nodeName

string¦null

false

none

none

» initiator

string¦null

false

none

none

» initiatorName

string¦null

false

none

none

» date

string(date-time)

false

none

none

» error

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workflows/{id}/errors/alerts", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflows/{id}/errors/alerts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflows/{id}/errors/alerts',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/workflows/{id}/errors/alerts', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/workflows/{id}/errors/alerts',
  params: {
  }, headers: headers

p JSON.parse(result)

Resend an alert.

Body parameter

{
  "id": 0,
  "tokenId": 0,
  "nodeId": 0,
  "_nodeName": "string",
  "initiator": "string",
  "initiatorName": "string",
  "date": "2019-08-24T14:15:22Z",
  "error": "string"
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Workflow id

body

body

RESTAPI.v1.DTOs.BPM.Errors.BPMAlertNodeErrorStatusDTO

false

Alert node error DTO. Only id, tokenID and nodeID fields are required.

» id

body

integer(int32)

false

none

» tokenId

body

integer(int32)

false

none

» nodeId

body

integer(int32)

false

none

» _nodeName

body

string¦null

false

none

» initiator

body

string¦null

false

none

» initiatorName

body

string¦null

false

none

» date

body

string(date-time)

false

none

» error

body

string¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/workflows/{id}/errors/alerts/resend", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/workflows/{id}/errors/alerts/resend");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "tokenId": 0,
  "nodeId": 0,
  "_nodeName": "string",
  "initiator": "string",
  "initiatorName": "string",
  "date": "2019-08-24T14:15:22Z",
  "error": "string"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/workflows/{id}/errors/alerts/resend',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/workflows/{id}/errors/alerts/resend', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/workflows/{id}/errors/alerts/resend',
  params: {
  }, headers: headers

p JSON.parse(result)

Ignore an alert node error.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Workflow id

errorId

path

integer(int32)

true

Alert node error ID

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/workflows/{id}/errors/alerts/{errorId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflows/{id}/errors/alerts/{errorId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/workflows/{id}/errors/alerts/{errorId}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/workflows/{id}/errors/alerts/{errorId}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/workflows/{id}/errors/alerts/{errorId}',
  params: {
  }

p JSON.parse(result)

Get a workflow node history.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Workflow ID

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

orderBy

query

string

false

####Description

filter

query

string

false

####Supported operations

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

Any field

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

Any field

Responses

Status

Meaning

Description

Schema

200

OK

Get workflow node history

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.BPM.Errors.BPMNodeHistoryStatusDTO]

false

none

none

» id

integer(int32)

false

none

none

» workflowID

integer(int32)

false

none

none

» nodeName

string¦null

false

none

none

» initiator

string¦null

false

none

none

» initiatorName

string¦null

false

none

none

» actor

string¦null

false

none

none

» actorName

string¦null

false

none

none

» isForcedBy

string¦null

false

none

none

» action

string¦null

false

none

none

» dateActioned

string(date-time)

false

none

none

» webReportName

string¦null

false

none

none

» attachments

string¦null

false

none

none

» documentID

integer(int32)

false

none

none

» tokenID

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workflows/{id}/history", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflows/{id}/history");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflows/{id}/history',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/workflows/{id}/history', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/workflows/{id}/history',
  params: {
  }, headers: headers

p JSON.parse(result)

Clear a workflow node history.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Clear workflow node history

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.BPM.Errors.BPMNodeHistoryStatusDTO]

false

none

none

» id

integer(int32)

false

none

none

» workflowID

integer(int32)

false

none

none

» nodeName

string¦null

false

none

none

» initiator

string¦null

false

none

none

» initiatorName

string¦null

false

none

none

» actor

string¦null

false

none

none

» actorName

string¦null

false

none

none

» isForcedBy

string¦null

false

none

none

» action

string¦null

false

none

none

» dateActioned

string(date-time)

false

none

none

» webReportName

string¦null

false

none

none

» attachments

string¦null

false

none

none

» documentID

integer(int32)

false

none

none

» tokenID

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/workflows/{id}/history", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflows/{id}/history");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflows/{id}/history',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('http://localhost:8080/api/v1/workflows/{id}/history', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.delete 'http://localhost:8080/api/v1/workflows/{id}/history',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "workflowID": 0,
    "nodeName": "string",
    "initiator": "string",
    "initiatorName": "string",
    "actor": "string",
    "actorName": "string",
    "isForcedBy": "string",
    "action": "string",
    "dateActioned": "2019-08-24T14:15:22Z",
    "webReportName": "string",
    "attachments": "string",
    "documentID": 0,
    "tokenID": "string"
  }
]
[{"id":0,"workflowID":0,"nodeName":"string","initiator":"string","initiatorName":"string","actor":"string","actorName":"string","isForcedBy":"string","action":"string","dateActioned":"2019-08-24T14:15:22Z","webReportName":"string","attachments":"string","documentID":0,"tokenID":"string"}]

Export a workflow node history.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

orderBy

query

string

false

####Description

filter

query

string

false

####Supported operations

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: none

limit: Number of records to retrieve.

Default: 50

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

initiator, actor, isForcedBy, action, dateActioned, webReportName

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

Any column

Responses

Status

Meaning

Description

Schema

200

OK

Export workflow node history

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.BPM.Errors.BPMNodeHistoryStatusDTO]

false

none

none

» id

integer(int32)

false

none

none

» workflowID

integer(int32)

false

none

none

» nodeName

string¦null

false

none

none

» initiator

string¦null

false

none

none

» initiatorName

string¦null

false

none

none

» actor

string¦null

false

none

none

» actorName

string¦null

false

none

none

» isForcedBy

string¦null

false

none

none

» action

string¦null

false

none

none

» dateActioned

string(date-time)

false

none

none

» webReportName

string¦null

false

none

none

» attachments

string¦null

false

none

none

» documentID

integer(int32)

false

none

none

» tokenID

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workflows/{id}/history/export", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflows/{id}/history/export");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflows/{id}/history/export',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/workflows/{id}/history/export', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/workflows/{id}/history/export',
  params: {
  }, headers: headers

p JSON.parse(result)

Get a workflow overview (error number and so on).

Body parameter

{
  "formula": "string",
  "swimLaneID": 0
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Workflow.ValidateConditionalNodeDTO

false

none

» formula

body

string¦null

false

none

» swimLaneID

body

integer(int32)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

boolean

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/workflowmanager/workflows/validateformula", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/workflowmanager/workflows/validateformula");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "formula": "string",
  "swimLaneID": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/workflowmanager/workflows/validateformula',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/workflowmanager/workflows/validateformula', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/workflowmanager/workflows/validateformula',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
true
true

Get a workflow data source wizard preview.

Body parameter

{
  "sourceDefinition": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "formInitiator": "string",
  "restrictions": {
    "constraintType": "clause",
    "op": "string",
    "dataFieldLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "caseSensitive": true,
    "constraints": [
      {}
    ],
    "literalRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "dataFieldRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "right": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "isPreciseDecimal": true,
    "like": "string",
    "escapeWildcards": true,
    "rowVersion": {
      "rowVersion": 0
    },
    "table": "string",
    "queryDefinitionRight": null
  },
  "dependencies": [
    "string"
  ],
  "reportId": 0,
  "selectedNames": [
    "string"
  ],
  "workflowId": 0,
  "workflowType": "PresenterReport"
}

Parameters

Name

In

Type

Required

Description

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

orderBy

query

string

false

####Description

body

body

Varicent.RESTAPI.v1.DTOs.Preview.BPMPreviewStateDTO

false

none

» sourceDefinition

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»» alias

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» table

body

string¦null

false

none

»»»» customSelect

body

string¦null

false

none

»»»» dataType

body

string

false

none

»»»» type

body

string

false

none

»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»» expressionType

body

string

false

none

»»»»»» cases

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» arguments

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»» constraintType

body

string

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» condition

body

any

false

none

»»»»»»»» trueValue

body

any

false

none

»»»»»»»» falseValue

body

any

false

none

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»» constraints

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» literalRight

body

any

false

none

»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» right

body

any

false

none

»»»»»»» expressionLeft

body

any

false

none

»»»»»»» expressionRight

body

any

false

none

»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»» like

body

string¦null

false

none

»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»» trueValue

body

any

false

none

»»»»»» falseValue

body

any

false

none

»»»»»» isDate

body

boolean

false

none

»»»»»» literalType

body

string

false

none

»»»»»» value

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»» m_namespace

body

string¦null

false

none

»»»»» name

body

string¦null

false

none

»»»» query

body

any

false

none

»»»» alias

body

string¦null

false

none

»»»» sourceType

body

string

false

none

»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» joinType

body

string

false

none

»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» constraintType

body

string

false

none

»»»»» op

body

string¦null

false

none

»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» caseSensitive

body

boolean

false

none

»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isPreciseDecimal

body

boolean

false

none

»»»»» like

body

string¦null

false

none

»»»»» escapeWildcards

body

boolean

false

none

»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»» table

body

string¦null

false

none

»»»»» queryDefinitionRight

body

any

false

none

»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» direction

body

string

false

none

»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» distinct

body

boolean

false

none

»»» unionWith

body

any

false

none

»»» exceptWith

body

any

false

none

»» sourceNames

body

object¦null

false

none

»»» additionalProperties

body

string¦null

false

none

» formInitiator

body

string¦null

false

none

» restrictions

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

» dependencies

body

[string]¦null

false

none

» reportId

body

integer(int32)

false

none

» selectedNames

body

[string]¦null

false

none

» workflowId

body

integer(int32)

false

none

» workflowType

body

string

false

none

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 100

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

Any column in selectedNames

Enumerated Values

Parameter

Value

»»»» dataType

Int

»»»» dataType

Decimal

»»»» dataType

DateTime

»»»» dataType

None

»»»» dataType

String

»»»» type

SelectAll

»»»» type

SelectItem

»»»» type

SelectLiteral

»»»» type

SelectCustom

»»»» type

SelectExpression

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» expressionType

caseExpression

»»»»»» expressionType

dataField

»»»»»» expressionType

function

»»»»»» expressionType

ifExpression

»»»»»» expressionType

literal

»»»»»»» constraintType

clause

»»»»»»» constraintType

constraint

»»»»»»» constraintType

expressionConstraint

»»»»»»» constraintType

likeConstraint

»»»»»»» constraintType

rowVersionConstraint

»»»»»»» constraintType

subQueryConstraint

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»» literalType

Integer

»»»»»» literalType

Decimal

»»»»»» literalType

Date

»»»»»» literalType

DateTime

»»»»»» literalType

String

»»»»»» literalType

Float

»»»»»» literalType

Long

»»»»»» literalType

Null

»»»»»» literalType

Parameter

»»»»»» literalType

Guid

»»»»»» literalType

SystemUtcTime

»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» sourceType

Table

»»»» sourceType

Query

»»»» joinType

Inner

»»»» joinType

Left

»»»» joinType

Right

»»»» joinType

Cross

»»»» joinType

CrossApply

»»»» joinType

OuterApply

»»»»» constraintType

clause

»»»»» constraintType

constraint

»»»»» constraintType

expressionConstraint

»»»»» constraintType

likeConstraint

»»»»» constraintType

rowVersionConstraint

»»»»» constraintType

subQueryConstraint

»»»» direction

Ascending

»»»» direction

Descending

»»»» direction

AscendingNullsFirst

»»»» direction

DescendingNullsLast

» workflowType

PresenterReport

» workflowType

Inquiry

» workflowType

PlanApproval

» workflowType

PresenterFlexReport

» workflowType

PlanDocument

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.ResultSetDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/workflowmanager/workflows/preview", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/workflows/preview");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "sourceDefinition": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "formInitiator": "string",
  "restrictions": {
    "constraintType": "clause",
    "op": "string",
    "dataFieldLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "caseSensitive": true,
    "constraints": [
      {}
    ],
    "literalRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "dataFieldRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "right": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "isPreciseDecimal": true,
    "like": "string",
    "escapeWildcards": true,
    "rowVersion": {
      "rowVersion": 0
    },
    "table": "string",
    "queryDefinitionRight": null
  },
  "dependencies": [
    "string"
  ],
  "reportId": 0,
  "selectedNames": [
    "string"
  ],
  "workflowId": 0,
  "workflowType": "PresenterReport"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflowmanager/workflows/preview',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/workflowmanager/workflows/preview', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/workflowmanager/workflows/preview',
  params: {
  }, headers: headers

p JSON.parse(result)

Get documents by workflow instance token ID.

Parameters

Name

In

Type

Required

Description

workflowID

path

integer(int32)

true

Workflow ID

tokenID

path

integer(int32)

true

Workflow instance token ID

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.Domain.BPM.BPMDocument]

false

none

none

» documentID

integer(int32)

false

none

none

» tokenID

integer(int32)

false

none

none

» name

string¦null

false

none

none

» type

string

false

none

none

Enumerated Values

Property

Value

type

Attachment

type

GeneratedPdf

type

SignedPdf

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workflowmanager/workflows/{workflowID}/tokens/{tokenID}/documents", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/workflows/{workflowID}/tokens/{tokenID}/documents");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflowmanager/workflows/{workflowID}/tokens/{tokenID}/documents',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/workflowmanager/workflows/{workflowID}/tokens/{tokenID}/documents', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/workflowmanager/workflows/{workflowID}/tokens/{tokenID}/documents',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "documentID": 0,
    "tokenID": 0,
    "name": "string",
    "type": "Attachment"
  }
]
[{"documentID":0,"tokenID":0,"name":"string","type":"Attachment"}]

Add new document to workflow instance.

Body parameter

{
  "name": "string",
  "content": "string",
  "portalTreeName": "string",
  "uploaderName": "string",
  "isInitiatedWorkflow": true
}

Parameters

Name

In

Type

Required

Description

workflowID

path

integer(int32)

true

Workflow ID

tokenID

path

integer(int32)

true

Workflow instance token ID

body

body

Varicent.RESTAPI.v1.DTOs.DocumentUploadDTO

false

none

» name

body

string¦null

false

none

» content

body

string¦null

false

none

» portalTreeName

body

string¦null

false

none

» uploaderName

body

string¦null

false

none

» isInitiatedWorkflow

body

boolean¦null

false

none

Responses

Status

Meaning

Description

Schema

201

Created

Created

RESTAPI.v1.DTOs.BPM.BPMDocumentDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/workflowmanager/workflows/{workflowID}/tokens/{tokenID}/documents", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/workflows/{workflowID}/tokens/{tokenID}/documents");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "name": "string",
  "content": "string",
  "portalTreeName": "string",
  "uploaderName": "string",
  "isInitiatedWorkflow": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflowmanager/workflows/{workflowID}/tokens/{tokenID}/documents',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/workflowmanager/workflows/{workflowID}/tokens/{tokenID}/documents', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/workflowmanager/workflows/{workflowID}/tokens/{tokenID}/documents',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "documentID": 0,
  "tokenID": 0,
  "name": "string",
  "type": "Attachment"
}
{"documentID":0,"tokenID":0,"name":"string","type":"Attachment"}

Get specific BPM document by token ID and document ID.

Parameters

Name

In

Type

Required

Description

workflowID

path

integer(int32)

true

Workflow ID

tokenID

path

integer(int32)

true

Workflow instance token ID

documentID

path

integer(int32)

true

BPM Document ID

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.FileContentDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workflowmanager/workflows/{workflowID}/tokens/{tokenID}/documents/{documentID}/file", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/workflows/{workflowID}/tokens/{tokenID}/documents/{documentID}/file");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflowmanager/workflows/{workflowID}/tokens/{tokenID}/documents/{documentID}/file',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/workflowmanager/workflows/{workflowID}/tokens/{tokenID}/documents/{documentID}/file', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/workflowmanager/workflows/{workflowID}/tokens/{tokenID}/documents/{documentID}/file',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "filename": "string",
  "data64": "string"
}
{"filename":"string","data64":"string"}

Delete BPM document by token ID and document ID.

Parameters

Name

In

Type

Required

Description

workflowID

path

integer(int32)

true

Workflow ID

tokenID

path

integer(int32)

true

Workflow instance token ID

documentID

path

integer(int32)

true

BPM Document ID

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/workflowmanager/workflows/{workflowID}/tokens/{tokenID}/documents/{documentID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/workflows/{workflowID}/tokens/{tokenID}/documents/{documentID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/workflowmanager/workflows/{workflowID}/tokens/{tokenID}/documents/{documentID}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/workflowmanager/workflows/{workflowID}/tokens/{tokenID}/documents/{documentID}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/workflowmanager/workflows/{workflowID}/tokens/{tokenID}/documents/{documentID}',
  params: {
  }

p JSON.parse(result)

BPMControllerV1_GetActionPaths

Parameters

Name

In

Type

Required

Description

workflowID

path

integer(int32)

true

none

tokenID

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workflowmanager/workflows/{workflowID}/paths/{tokenID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/workflows/{workflowID}/paths/{tokenID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/workflowmanager/workflows/{workflowID}/paths/{tokenID}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.get('http://localhost:8080/api/v1/workflowmanager/workflows/{workflowID}/paths/{tokenID}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.get 'http://localhost:8080/api/v1/workflowmanager/workflows/{workflowID}/paths/{tokenID}',
  params: {
  }

p JSON.parse(result)

Rerun a failed BPM process by adding it back to BPMScheduledProcess

Parameters

Name

In

Type

Required

Description

tokenID

path

integer(int32)

true

Workflow instance token ID

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/workflowmanager/token/{tokenID}/rerunbpmprocess", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/token/{tokenID}/rerunbpmprocess");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/workflowmanager/token/{tokenID}/rerunbpmprocess',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/v1/workflowmanager/token/{tokenID}/rerunbpmprocess')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/v1/workflowmanager/token/{tokenID}/rerunbpmprocess',
  params: {
  }

p JSON.parse(result)

BPMControllerV1_GetInquiryAdmin

Parameters

Name

In

Type

Required

Description

inquiryID

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get inquiry detail of an inquiy

Varicent.RESTAPI.v1.DTOs.BPMInquiryViewDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/inquirymanager/getInquiries/{inquiryID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/inquirymanager/getInquiries/{inquiryID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/inquirymanager/getInquiries/{inquiryID}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/inquirymanager/getInquiries/{inquiryID}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/inquirymanager/getInquiries/{inquiryID}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "inquiry": {
    "inquiryID": 0,
    "objectName": "string",
    "objectType": "string",
    "tokenID": 0,
    "dateCreated": "2019-08-24T14:15:22Z",
    "creator": "string",
    "payeeId": "string",
    "workflowID": 0,
    "workflowObjectID": 0,
    "adminOwner": {
      "adminSwimLaneID": 0,
      "assignee": "string",
      "adminSwimlaneName": "string"
    },
    "status": "Entered",
    "inquiryState": "Default",
    "subjectName": "string",
    "openFor": 0,
    "actionRequired": true,
    "canReopen": true,
    "lastUpdate": "2019-08-24T14:15:22Z",
    "isOpen": true,
    "isNew": true,
    "pickListValue": "string",
    "copiedRow": "string",
    "reportName": "string",
    "componentValueList": {
      "property1": {},
      "property2": {}
    },
    "rowVersion": {
      "rowVersion": 0
    }
  },
  "paths": [
    {
      "pathID": 0,
      "name": "string",
      "originNodeID": 0,
      "destinationNodeID": 0,
      "allMember": true,
      "allSubmit": true,
      "saveAndSubmit": true,
      "reviewResult": "Rejected",
      "position": 0,
      "condition": "string",
      "isDefault": true,
      "isSign": true
    }
  ],
  "comments": [
    {
      "commentID": 0,
      "author": "string",
      "authorName": "string",
      "admin": "string",
      "adminName": "string",
      "created": "2019-08-24T14:15:22Z",
      "text": "string",
      "commentType": "Comment",
      "componentName": "string",
      "prevComponentValue": "string",
      "newComponentValue": "string"
    }
  ],
  "attachments": [
    "string"
  ]
}
{"inquiry":{"inquiryID":0,"objectName":"string","objectType":"string","tokenID":0,"dateCreated":"2019-08-24T14:15:22Z","creator":"string","payeeId":"string","workflowID":0,"workflowObjectID":0,"adminOwner":{"adminSwimLaneID":0,"assignee":"string","adminSwimlaneName":"string"},"status":"Entered","inquiryState":"Default","subjectName":"string","openFor":0,"actionRequired":true,"canReopen":true,"lastUpdate":"2019-08-24T14:15:22Z","isOpen":true,"isNew":true,"pickListValue":"string","copiedRow":"string","reportName":"string","componentValueList":{"property1":{},"property2":{}},"rowVersion":{"rowVersion":0}},"paths":[{"pathID":0,"name":"string","originNodeID":0,"destinationNodeID":0,"allMember":true,"allSubmit":true,"saveAndSubmit":true,"reviewResult":"Rejected","position":0,"condition":"string","isDefault":true,"isSign":true}],"comments":[{"commentID":0,"author":"string","authorName":"string","admin":"string","adminName":"string","created":"2019-08-24T14:15:22Z","text":"string","commentType":"Comment","componentName":"string","prevComponentValue":"string","newComponentValue":"string"}],"attachments":["string"]}

BPMControllerV1_GetInquiry

Parameters

Name

In

Type

Required

Description

inquiryID

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get inquiry detail of an inquiy

Varicent.RESTAPI.v1.DTOs.BPMInquiryViewDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/payee/workflowmanager/bpmInquiries/{inquiryID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payee/workflowmanager/bpmInquiries/{inquiryID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/payee/workflowmanager/bpmInquiries/{inquiryID}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/payee/workflowmanager/bpmInquiries/{inquiryID}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/payee/workflowmanager/bpmInquiries/{inquiryID}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "inquiry": {
    "inquiryID": 0,
    "objectName": "string",
    "objectType": "string",
    "tokenID": 0,
    "dateCreated": "2019-08-24T14:15:22Z",
    "creator": "string",
    "payeeId": "string",
    "workflowID": 0,
    "workflowObjectID": 0,
    "adminOwner": {
      "adminSwimLaneID": 0,
      "assignee": "string",
      "adminSwimlaneName": "string"
    },
    "status": "Entered",
    "inquiryState": "Default",
    "subjectName": "string",
    "openFor": 0,
    "actionRequired": true,
    "canReopen": true,
    "lastUpdate": "2019-08-24T14:15:22Z",
    "isOpen": true,
    "isNew": true,
    "pickListValue": "string",
    "copiedRow": "string",
    "reportName": "string",
    "componentValueList": {
      "property1": {},
      "property2": {}
    },
    "rowVersion": {
      "rowVersion": 0
    }
  },
  "paths": [
    {
      "pathID": 0,
      "name": "string",
      "originNodeID": 0,
      "destinationNodeID": 0,
      "allMember": true,
      "allSubmit": true,
      "saveAndSubmit": true,
      "reviewResult": "Rejected",
      "position": 0,
      "condition": "string",
      "isDefault": true,
      "isSign": true
    }
  ],
  "comments": [
    {
      "commentID": 0,
      "author": "string",
      "authorName": "string",
      "admin": "string",
      "adminName": "string",
      "created": "2019-08-24T14:15:22Z",
      "text": "string",
      "commentType": "Comment",
      "componentName": "string",
      "prevComponentValue": "string",
      "newComponentValue": "string"
    }
  ],
  "attachments": [
    "string"
  ]
}
{"inquiry":{"inquiryID":0,"objectName":"string","objectType":"string","tokenID":0,"dateCreated":"2019-08-24T14:15:22Z","creator":"string","payeeId":"string","workflowID":0,"workflowObjectID":0,"adminOwner":{"adminSwimLaneID":0,"assignee":"string","adminSwimlaneName":"string"},"status":"Entered","inquiryState":"Default","subjectName":"string","openFor":0,"actionRequired":true,"canReopen":true,"lastUpdate":"2019-08-24T14:15:22Z","isOpen":true,"isNew":true,"pickListValue":"string","copiedRow":"string","reportName":"string","componentValueList":{"property1":{},"property2":{}},"rowVersion":{"rowVersion":0}},"paths":[{"pathID":0,"name":"string","originNodeID":0,"destinationNodeID":0,"allMember":true,"allSubmit":true,"saveAndSubmit":true,"reviewResult":"Rejected","position":0,"condition":"string","isDefault":true,"isSign":true}],"comments":[{"commentID":0,"author":"string","authorName":"string","admin":"string","adminName":"string","created":"2019-08-24T14:15:22Z","text":"string","commentType":"Comment","componentName":"string","prevComponentValue":"string","newComponentValue":"string"}],"attachments":["string"]}

Get the workflow inquiry form.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Workflow ID

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.BPM.BPMComponentDTO]

false

none

none

» workflowID

integer(int32)

false

none

none

» componentID

integer(int32)

false

none

none

» name

string¦null

false

none

none

» type

string

false

none

none

» order

integer(int32)

false

none

none

» categories

[RESTAPI.v1.DTOs.BPMInquiryCategoryDTO]¦null

false

none

none

»» categoryID

integer(int32)

false

none

none

»» value

string¦null

false

none

none

» source

RESTAPI.v1.DTOs.BPM.BPMComponentSourceDTO

false

none

none

»» sourceID

integer(int32)¦null

false

none

none

»» sourceReference

RESTAPI.v1.DTOs.BPM.BPMComponentSourceReferenceDTO

false

none

none

»»» tableName

string¦null

false

none

none

»»» calculationID

integer(int32)¦null

false

none

none

»»» dataStoreID

integer(int32)¦null

false

none

none

»»» planBuilderCalculationID

string¦null

false

none

none

»» sourceFilters

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFiltersDTO

false

none

none

»»» filters

[RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterDTO]¦null

false

none

none

»»»» constraint

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterConstraintDTO

false

none

none

»»»»» columnName

string¦null

false

none

none

»»»»» operator

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterOperatorDTO

false

none

none

»»»»»» type

string

false

none

none

»»»»» value

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterValueDTO

false

none

none

»»»»»» text

string¦null

false

none

none

»»»»»» numeric

number(double)¦null

false

none

none

»»»»»» date

string(date-time)¦null

false

none

none

»»»»»» special

string¦null

false

none

none

»»»»»» valueId

integer(int32)¦null

false

none

none

»»»»»» rangeValue

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexRangeValueDTO

false

none

none

»»»»»»» min

any

false

none

none

»»»»»»» max

any

false

none

none

»»»»» caseSensitive

boolean¦null

false

none

none

»»»» and

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterAndDTO

false

none

none

»»»»» filters

array¦null

false

none

none

»»»»»» anonymous

any

false

none

none

»»»» or

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterOrDTO

false

none

none

»»»»» filters

array¦null

false

none

none

»»»»»» anonymous

any

false

none

none

»»»» not

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterNotDTO

false

none

none

»»»»» filter

any

false

none

none

»»»» metadata

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterMetaDataDTO

false

none

none

»»»»» additionalProperties

any

false

none

none

»» columns

[RESTAPI.v1.DTOs.BPM.BPMComponentSourceColumnDTO]¦null

false

none

none

»»» columnName

string¦null

false

none

none

»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»» rowVersion

integer(int64)

false

none

none

» config

RESTAPI.v1.DTOs.BPM.BPMComponentConfigDTO

false

none

none

»» pickList

RESTAPI.v1.DTOs.BPM.BPMComponentPickListDTO

false

none

none

»»» additionalProperties

any

false

none

none

»»» placeholder

string¦null

false

none

none

»»» sort

string¦null

false

none

none

»»» parameterName

string¦null

false

none

none

»»» userGenerated

boolean

false

none

none

»»» hasError

boolean

false

none

none

»»» required

boolean

false

none

none

»»» enabled

boolean

false

none

none

»»» visible

boolean

false

none

none

»»» defaultValue

string¦null

false

none

none

»» title

RESTAPI.v1.DTOs.BPM.BPMComponentTitleDTO

false

none

none

»»» additionalProperties

any

false

none

none

»»» content

string¦null

false

none

none

»»» userGenerated

boolean

false

none

none

»»» hasError

boolean

false

none

none

»»» required

boolean

false

none

none

»»» enabled

boolean

false

none

none

»»» visible

boolean

false

none

none

»»» defaultValue

string¦null

false

none

none

»» subject

RESTAPI.v1.DTOs.BPM.BPMComponentSubjectDTO

false

none

none

»»» additionalProperties

any

false

none

none

»»» placeholder

string¦null

false

none

none

»»» parameterName

string¦null

false

none

none

»»» userGenerated

boolean

false

none

none

»»» hasError

boolean

false

none

none

»»» required

boolean

false

none

none

»»» enabled

boolean

false

none

none

»»» visible

boolean

false

none

none

»»» defaultValue

string¦null

false

none

none

»» description

RESTAPI.v1.DTOs.BPM.BPMComponentDescriptionDTO

false

none

none

»»» additionalProperties

any

false

none

none

»»» placeholder

string¦null

false

none

none

»»» parameterName

string¦null

false

none

none

»»» charLimit

integer(int32)

false

none

none

»»» userGenerated

boolean

false

none

none

»»» hasError

boolean

false

none

none

»»» required

boolean

false

none

none

»»» enabled

boolean

false

none

none

»»» visible

boolean

false

none

none

»»» defaultValue

string¦null

false

none

none

»» text

RESTAPI.v1.DTOs.BPM.BPMComponentTextDTO

false

none

none

»»» additionalProperties

any

false

none

none

»»» placeholder

string¦null

false

none

none

»»» charLimit

integer(int32)

false

none

none

»»» content

string¦null

false

none

none

»»» parameterName

string¦null

false

none

none

»»» userGenerated

boolean

false

none

none

»»» hasError

boolean

false

none

none

»»» required

boolean

false

none

none

»»» templateList

[RESTAPI.v1.DTOs.BPM.CommentTemplateDTO]¦null

false

none

none

»»»» value

string¦null

false

none

none

»»» enabled

boolean

false

none

none

»»» visible

boolean

false

none

none

»»» defaultValue

string¦null

false

none

none

»» numeric

RESTAPI.v1.DTOs.BPM.BPMComponentNumericDTO

false

none

none

»»» additionalProperties

any

false

none

none

»»» placeholder

string¦null

false

none

none

»»» charLimit

integer(int32)

false

none

none

»»» content

string¦null

false

none

none

»»» parameterName

string¦null

false

none

none

»»» userGenerated

boolean

false

none

none

»»» hasError

boolean

false

none

none

»»» required

boolean

false

none

none

»»» enabled

boolean

false

none

none

»»» visible

boolean

false

none

none

»»» defaultValue

integer(int32)

false

none

none

»» sourcePickList

RESTAPI.v1.DTOs.BPM.BPMComponentSourcePickListDTO

false

none

none

»»» additionalProperties

any

false

none

none

»»» displayName

string¦null

false

none

none

»»» displayColumn

string¦null

false

none

none

»»» displayColumnDBType

string

false

none

none

»»» idColumn

string¦null

false

none

none

»»» idColumnDBType

string

false

none

none

»»» placeholder

string¦null

false

none

none

»»» sort

string¦null

false

none

none

»»» sortOrder

string

false

none

none

»»» parameterName

string¦null

false

none

none

»»» hasError

boolean

false

none

none

»»» required

boolean

false

none

none

»»» userGenerated

boolean

false

none

none

»»» hideIDColumn

boolean¦null

false

none

none

»»» enabled

boolean

false

none

none

»»» visible

boolean

false

none

none

»»» defaultValue

string¦null

false

none

none

» componentMappings

[RESTAPI.v1.DTOs.BPM.BPMAutoAdjustComponentMappingDTO]¦null

false

none

none

»» nodeID

integer(int32)

false

none

none

»» nodeName

string¦null

false

none

none

»» tableName

string¦null

false

none

none

»» columnName

string¦null

false

none

none

»» dataType

string¦null

false

none

none

»» isPrimaryKey

boolean

false

none

none

» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

type

pickList

type

title

type

subject

type

description

type

text

type

numeric

type

sourcePickList

type

Equals

type

NotEquals

type

LessThan

type

LessThanEquals

type

GreaterThan

type

GreaterThanEquals

type

IsNull

type

IsNotNull

type

Contains

type

NotContains

type

StartWith

type

EndWith

type

InRange

type

InArray

type

NotInArray

special

CurrentWebUser

special

CurrentDate

special

CurrentRowValue

special

WorkflowFormID

displayColumnDBType

String

displayColumnDBType

LongString

displayColumnDBType

MaxString

displayColumnDBType

Date

displayColumnDBType

DateTime

displayColumnDBType

Decimal

displayColumnDBType

Int

displayColumnDBType

Long

displayColumnDBType

Float

displayColumnDBType

BLOB

displayColumnDBType

Identity

displayColumnDBType

CLOB

displayColumnDBType

RowVersion

displayColumnDBType

UID

displayColumnDBType

VarCharMax

displayColumnDBType

Boolean

idColumnDBType

String

idColumnDBType

LongString

idColumnDBType

MaxString

idColumnDBType

Date

idColumnDBType

DateTime

idColumnDBType

Decimal

idColumnDBType

Int

idColumnDBType

Long

idColumnDBType

Float

idColumnDBType

BLOB

idColumnDBType

Identity

idColumnDBType

CLOB

idColumnDBType

RowVersion

idColumnDBType

UID

idColumnDBType

VarCharMax

idColumnDBType

Boolean

sortOrder

Ascending

sortOrder

Descending

sortOrder

AscendingNullsFirst

sortOrder

DescendingNullsLast

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workflows/{id}/InquiryFormComponent", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflows/{id}/InquiryFormComponent");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflows/{id}/InquiryFormComponent',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/workflows/{id}/InquiryFormComponent', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/workflows/{id}/InquiryFormComponent',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "workflowID": 0,
    "componentID": 0,
    "name": "string",
    "type": "pickList",
    "order": 0,
    "categories": [
      {}
    ],
    "source": {
      "sourceID": 0,
      "sourceReference": {},
      "sourceFilters": {},
      "columns": [],
      "rowVersion": {}
    },
    "config": {
      "pickList": {},
      "title": {},
      "subject": {},
      "description": {},
      "text": {},
      "numeric": {},
      "sourcePickList": {}
    },
    "componentMappings": [
      {}
    ],
    "rowVersion": {
      "rowVersion": 0
    }
  }
]
[{"workflowID":0,"componentID":0,"name":"string","type":"pickList","order":0,"categories":[{}],"source":{"sourceID":0,"sourceReference":{},"sourceFilters":{},"columns":[],"rowVersion":{}},"config":{"pickList":{},"title":{},"subject":{},"description":{},"text":{},"numeric":{},"sourcePickList":{}},"componentMappings":[{}],"rowVersion":{"rowVersion":0}}]

save workflow inquiry form.

Body parameter

[
  {
    "workflowID": 0,
    "componentID": 0,
    "name": "string",
    "type": "pickList",
    "order": 0,
    "categories": [
      {}
    ],
    "source": {
      "sourceID": 0,
      "sourceReference": {},
      "sourceFilters": {},
      "columns": [],
      "rowVersion": {}
    },
    "config": {
      "pickList": {},
      "title": {},
      "subject": {},
      "description": {},
      "text": {},
      "numeric": {},
      "sourcePickList": {}
    },
    "componentMappings": [
      {}
    ],
    "rowVersion": {
      "rowVersion": 0
    }
  }
]

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

RESTAPI.v1.DTOs.BPM.BPMComponentDTO RESTAPI.v1.DTOs.BPM.BPMComponentDTO

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/workflows/{id}/InquiryFormComponent", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflows/{id}/InquiryFormComponent");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "workflowID": 0,
    "componentID": 0,
    "name": "string",
    "type": "pickList",
    "order": 0,
    "categories": [
      {}
    ],
    "source": {
      "sourceID": 0,
      "sourceReference": {},
      "sourceFilters": {},
      "columns": [],
      "rowVersion": {}
    },
    "config": {
      "pickList": {},
      "title": {},
      "subject": {},
      "description": {},
      "text": {},
      "numeric": {},
      "sourcePickList": {}
    },
    "componentMappings": [
      {}
    ],
    "rowVersion": {
      "rowVersion": 0
    }
  }
]';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/workflows/{id}/InquiryFormComponent',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/workflows/{id}/InquiryFormComponent', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/workflows/{id}/InquiryFormComponent',
  params: {
  }, headers: headers

p JSON.parse(result)

Update workflow inquiry form.

Body parameter

{
  "components": [
    {
      "workflowID": 0,
      "componentID": 0,
      "name": "string",
      "type": "pickList",
      "order": 0,
      "categories": [],
      "source": {},
      "config": {},
      "componentMappings": [],
      "rowVersion": {}
    }
  ],
  "rules": [
    {
      "id": 0,
      "ruleName": "string",
      "outcomeComponentID": 0,
      "workflowID": 0,
      "sortOrder": 0,
      "description": "string",
      "metadata": {},
      "outcome": {},
      "conditions": {},
      "rowVersion": {}
    }
  ]
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

RESTAPI.v1.DTOs.BPM.BPMInquiryFormDTO

false

none

» components

body

[RESTAPI.v1.DTOs.BPM.BPMComponentDTO]¦null

false

none

»» workflowID

body

integer(int32)

false

none

»» componentID

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» type

body

string

false

none

»» order

body

integer(int32)

false

none

»» categories

body

[RESTAPI.v1.DTOs.BPMInquiryCategoryDTO]¦null

false

none

»»» categoryID

body

integer(int32)

false

none

»»» value

body

string¦null

false

none

»» source

body

RESTAPI.v1.DTOs.BPM.BPMComponentSourceDTO

false

none

»»» sourceID

body

integer(int32)¦null

false

none

»»» sourceReference

body

RESTAPI.v1.DTOs.BPM.BPMComponentSourceReferenceDTO

false

none

»»»» tableName

body

string¦null

false

none

»»»» calculationID

body

integer(int32)¦null

false

none

»»»» dataStoreID

body

integer(int32)¦null

false

none

»»»» planBuilderCalculationID

body

string¦null

false

none

»»» sourceFilters

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFiltersDTO

false

none

»»»» filters

body

[RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterDTO]¦null

false

none

»»»»» constraint

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterConstraintDTO

false

none

»»»»»» columnName

body

string¦null

false

none

»»»»»» operator

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterOperatorDTO

false

none

»»»»»»» type

body

string

false

none

»»»»»» value

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterValueDTO

false

none

»»»»»»» text

body

string¦null

false

none

»»»»»»» numeric

body

number(double)¦null

false

none

»»»»»»» date

body

string(date-time)¦null

false

none

»»»»»»» special

body

string¦null

false

none

»»»»»»» valueId

body

integer(int32)¦null

false

none

»»»»»»» rangeValue

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexRangeValueDTO

false

none

»»»»»»»» min

body

any

false

none

»»»»»»»» max

body

any

false

none

»»»»»» caseSensitive

body

boolean¦null

false

none

»»»»» and

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterAndDTO

false

none

»»»»»» filters

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»» or

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterOrDTO

false

none

»»»»»» filters

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»» not

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterNotDTO

false

none

»»»»»» filter

body

any

false

none

»»»»» metadata

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterMetaDataDTO

false

none

»»»»»» additionalProperties

body

any

false

none

»»» columns

body

[RESTAPI.v1.DTOs.BPM.BPMComponentSourceColumnDTO]¦null

false

none

»»»» columnName

body

string¦null

false

none

»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»» rowVersion

body

integer(int64)

false

none

»» config

body

RESTAPI.v1.DTOs.BPM.BPMComponentConfigDTO

false

none

»»» pickList

body

RESTAPI.v1.DTOs.BPM.BPMComponentPickListDTO

false

none

»»»» additionalProperties

body

any

false

none

»»»» placeholder

body

string¦null

false

none

»»»» sort

body

string¦null

false

none

»»»» parameterName

body

string¦null

false

none

»»»» userGenerated

body

boolean

false

none

»»»» hasError

body

boolean

false

none

»»»» required

body

boolean

false

none

»»»» enabled

body

boolean

false

none

»»»» visible

body

boolean

false

none

»»»» defaultValue

body

string¦null

false

none

»»» title

body

RESTAPI.v1.DTOs.BPM.BPMComponentTitleDTO

false

none

»»»» additionalProperties

body

any

false

none

»»»» content

body

string¦null

false

none

»»»» userGenerated

body

boolean

false

none

»»»» hasError

body

boolean

false

none

»»»» required

body

boolean

false

none

»»»» enabled

body

boolean

false

none

»»»» visible

body

boolean

false

none

»»»» defaultValue

body

string¦null

false

none

»»» subject

body

RESTAPI.v1.DTOs.BPM.BPMComponentSubjectDTO

false

none

»»»» additionalProperties

body

any

false

none

»»»» placeholder

body

string¦null

false

none

»»»» parameterName

body

string¦null

false

none

»»»» userGenerated

body

boolean

false

none

»»»» hasError

body

boolean

false

none

»»»» required

body

boolean

false

none

»»»» enabled

body

boolean

false

none

»»»» visible

body

boolean

false

none

»»»» defaultValue

body

string¦null

false

none

»»» description

body

RESTAPI.v1.DTOs.BPM.BPMComponentDescriptionDTO

false

none

»»»» additionalProperties

body

any

false

none

»»»» placeholder

body

string¦null

false

none

»»»» parameterName

body

string¦null

false

none

»»»» charLimit

body

integer(int32)

false

none

»»»» userGenerated

body

boolean

false

none

»»»» hasError

body

boolean

false

none

»»»» required

body

boolean

false

none

»»»» enabled

body

boolean

false

none

»»»» visible

body

boolean

false

none

»»»» defaultValue

body

string¦null

false

none

»»» text

body

RESTAPI.v1.DTOs.BPM.BPMComponentTextDTO

false

none

»»»» additionalProperties

body

any

false

none

»»»» placeholder

body

string¦null

false

none

»»»» charLimit

body

integer(int32)

false

none

»»»» content

body

string¦null

false

none

»»»» parameterName

body

string¦null

false

none

»»»» userGenerated

body

boolean

false

none

»»»» hasError

body

boolean

false

none

»»»» required

body

boolean

false

none

»»»» templateList

body

[RESTAPI.v1.DTOs.BPM.CommentTemplateDTO]¦null

false

none

»»»»» value

body

string¦null

false

none

»»»» enabled

body

boolean

false

none

»»»» visible

body

boolean

false

none

»»»» defaultValue

body

string¦null

false

none

»»» numeric

body

RESTAPI.v1.DTOs.BPM.BPMComponentNumericDTO

false

none

»»»» additionalProperties

body

any

false

none

»»»» placeholder

body

string¦null

false

none

»»»» charLimit

body

integer(int32)

false

none

»»»» content

body

string¦null

false

none

»»»» parameterName

body

string¦null

false

none

»»»» userGenerated

body

boolean

false

none

»»»» hasError

body

boolean

false

none

»»»» required

body

boolean

false

none

»»»» enabled

body

boolean

false

none

»»»» visible

body

boolean

false

none

»»»» defaultValue

body

integer(int32)

false

none

»»» sourcePickList

body

RESTAPI.v1.DTOs.BPM.BPMComponentSourcePickListDTO

false

none

»»»» additionalProperties

body

any

false

none

»»»» displayName

body

string¦null

false

none

»»»» displayColumn

body

string¦null

false

none

»»»» displayColumnDBType

body

string

false

none

»»»» idColumn

body

string¦null

false

none

»»»» idColumnDBType

body

string

false

none

»»»» placeholder

body

string¦null

false

none

»»»» sort

body

string¦null

false

none

»»»» sortOrder

body

string

false

none

»»»» parameterName

body

string¦null

false

none

»»»» hasError

body

boolean

false

none

»»»» required

body

boolean

false

none

»»»» userGenerated

body

boolean

false

none

»»»» hideIDColumn

body

boolean¦null

false

none

»»»» enabled

body

boolean

false

none

»»»» visible

body

boolean

false

none

»»»» defaultValue

body

string¦null

false

none

»» componentMappings

body

[RESTAPI.v1.DTOs.BPM.BPMAutoAdjustComponentMappingDTO]¦null

false

none

»»» nodeID

body

integer(int32)

false

none

»»» nodeName

body

string¦null

false

none

»»» tableName

body

string¦null

false

none

»»» columnName

body

string¦null

false

none

»»» dataType

body

string¦null

false

none

»»» isPrimaryKey

body

boolean

false

none

»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

» rules

body

[RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleDTO]¦null

false

none

»» id

body

integer(int32)

false

none

»» ruleName

body

string¦null

false

none

»» outcomeComponentID

body

integer(int32)

false

none

»» workflowID

body

integer(int32)

false

none

»» sortOrder

body

integer(int32)

false

none

»» description

body

string¦null

false

none

»» metadata

body

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleMetadataDTO

false

none

»»» conditionComponentIDs

body

[integer]¦null

false

none

»»» outcomeComponentID

body

integer(int32)

false

none

»» outcome

body

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleOutcomeDTO

false

none

»»» componentID

body

integer(int32)

false

none

»»» defaultValue

body

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleValueDTO

false

none

»»»» text

body

string¦null

false

none

»»»» numeric

body

string¦null

false

none

»»»» picklistValue

body

string¦null

false

none

»»»» sourceBasedId

body

string¦null

false

none

»»»» rangeValue

body

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleRangeValueDTO

false

none

»»»»» min

body

any

false

none

»»»»» max

body

any

false

none

»»» enabled

body

boolean¦null

false

none

»»» visible

body

boolean¦null

false

none

»» conditions

body

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleConditionDTO

false

none

»»» id

body

string¦null

false

none

»»» type

body

string¦null

false

none

»»» componentID

body

integer(int32)

false

none

»»» operation

body

string¦null

false

none

»»» value

body

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleValueDTO

false

none

»»» children

body

array¦null

false

none

»»»» anonymous

body

any

false

none

»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

»» type

pickList

»» type

title

»» type

subject

»» type

description

»» type

text

»» type

numeric

»» type

sourcePickList

»»»»»»» type

Equals

»»»»»»» type

NotEquals

»»»»»»» type

LessThan

»»»»»»» type

LessThanEquals

»»»»»»» type

GreaterThan

»»»»»»» type

GreaterThanEquals

»»»»»»» type

IsNull

»»»»»»» type

IsNotNull

»»»»»»» type

Contains

»»»»»»» type

NotContains

»»»»»»» type

StartWith

»»»»»»» type

EndWith

»»»»»»» type

InRange

»»»»»»» type

InArray

»»»»»»» type

NotInArray

»»»»»»» special

CurrentWebUser

»»»»»»» special

CurrentDate

»»»»»»» special

CurrentRowValue

»»»»»»» special

WorkflowFormID

»»»» displayColumnDBType

String

»»»» displayColumnDBType

LongString

»»»» displayColumnDBType

MaxString

»»»» displayColumnDBType

Date

»»»» displayColumnDBType

DateTime

»»»» displayColumnDBType

Decimal

»»»» displayColumnDBType

Int

»»»» displayColumnDBType

Long

»»»» displayColumnDBType

Float

»»»» displayColumnDBType

BLOB

»»»» displayColumnDBType

Identity

»»»» displayColumnDBType

CLOB

»»»» displayColumnDBType

RowVersion

»»»» displayColumnDBType

UID

»»»» displayColumnDBType

VarCharMax

»»»» displayColumnDBType

Boolean

»»»» idColumnDBType

String

»»»» idColumnDBType

LongString

»»»» idColumnDBType

MaxString

»»»» idColumnDBType

Date

»»»» idColumnDBType

DateTime

»»»» idColumnDBType

Decimal

»»»» idColumnDBType

Int

»»»» idColumnDBType

Long

»»»» idColumnDBType

Float

»»»» idColumnDBType

BLOB

»»»» idColumnDBType

Identity

»»»» idColumnDBType

CLOB

»»»» idColumnDBType

RowVersion

»»»» idColumnDBType

UID

»»»» idColumnDBType

VarCharMax

»»»» idColumnDBType

Boolean

»»»» sortOrder

Ascending

»»»» sortOrder

Descending

»»»» sortOrder

AscendingNullsFirst

»»»» sortOrder

DescendingNullsLast

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.BPM.BPMInquiryFormDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/workflows/{id}/InquiryForm", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflows/{id}/InquiryForm");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "components": [
    {
      "workflowID": 0,
      "componentID": 0,
      "name": "string",
      "type": "pickList",
      "order": 0,
      "categories": [],
      "source": {},
      "config": {},
      "componentMappings": [],
      "rowVersion": {}
    }
  ],
  "rules": [
    {
      "id": 0,
      "ruleName": "string",
      "outcomeComponentID": 0,
      "workflowID": 0,
      "sortOrder": 0,
      "description": "string",
      "metadata": {},
      "outcome": {},
      "conditions": {},
      "rowVersion": {}
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflows/{id}/InquiryForm',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/workflows/{id}/InquiryForm', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/workflows/{id}/InquiryForm',
  params: {
  }, headers: headers

p JSON.parse(result)

create workflow inquiry form including rules

Body parameter

{
  "components": [
    {
      "workflowID": 0,
      "componentID": 0,
      "name": "string",
      "type": "pickList",
      "order": 0,
      "categories": [],
      "source": {},
      "config": {},
      "componentMappings": [],
      "rowVersion": {}
    }
  ],
  "rules": [
    {
      "id": 0,
      "ruleName": "string",
      "outcomeComponentID": 0,
      "workflowID": 0,
      "sortOrder": 0,
      "description": "string",
      "metadata": {},
      "outcome": {},
      "conditions": {},
      "rowVersion": {}
    }
  ]
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

RESTAPI.v1.DTOs.BPM.BPMInquiryFormDTO

false

none

» components

body

[RESTAPI.v1.DTOs.BPM.BPMComponentDTO]¦null

false

none

»» workflowID

body

integer(int32)

false

none

»» componentID

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» type

body

string

false

none

»» order

body

integer(int32)

false

none

»» categories

body

[RESTAPI.v1.DTOs.BPMInquiryCategoryDTO]¦null

false

none

»»» categoryID

body

integer(int32)

false

none

»»» value

body

string¦null

false

none

»» source

body

RESTAPI.v1.DTOs.BPM.BPMComponentSourceDTO

false

none

»»» sourceID

body

integer(int32)¦null

false

none

»»» sourceReference

body

RESTAPI.v1.DTOs.BPM.BPMComponentSourceReferenceDTO

false

none

»»»» tableName

body

string¦null

false

none

»»»» calculationID

body

integer(int32)¦null

false

none

»»»» dataStoreID

body

integer(int32)¦null

false

none

»»»» planBuilderCalculationID

body

string¦null

false

none

»»» sourceFilters

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFiltersDTO

false

none

»»»» filters

body

[RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterDTO]¦null

false

none

»»»»» constraint

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterConstraintDTO

false

none

»»»»»» columnName

body

string¦null

false

none

»»»»»» operator

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterOperatorDTO

false

none

»»»»»»» type

body

string

false

none

»»»»»» value

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterValueDTO

false

none

»»»»»»» text

body

string¦null

false

none

»»»»»»» numeric

body

number(double)¦null

false

none

»»»»»»» date

body

string(date-time)¦null

false

none

»»»»»»» special

body

string¦null

false

none

»»»»»»» valueId

body

integer(int32)¦null

false

none

»»»»»»» rangeValue

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexRangeValueDTO

false

none

»»»»»»»» min

body

any

false

none

»»»»»»»» max

body

any

false

none

»»»»»» caseSensitive

body

boolean¦null

false

none

»»»»» and

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterAndDTO

false

none

»»»»»» filters

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»» or

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterOrDTO

false

none

»»»»»» filters

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»» not

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterNotDTO

false

none

»»»»»» filter

body

any

false

none

»»»»» metadata

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterMetaDataDTO

false

none

»»»»»» additionalProperties

body

any

false

none

»»» columns

body

[RESTAPI.v1.DTOs.BPM.BPMComponentSourceColumnDTO]¦null

false

none

»»»» columnName

body

string¦null

false

none

»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»» rowVersion

body

integer(int64)

false

none

»» config

body

RESTAPI.v1.DTOs.BPM.BPMComponentConfigDTO

false

none

»»» pickList

body

RESTAPI.v1.DTOs.BPM.BPMComponentPickListDTO

false

none

»»»» additionalProperties

body

any

false

none

»»»» placeholder

body

string¦null

false

none

»»»» sort

body

string¦null

false

none

»»»» parameterName

body

string¦null

false

none

»»»» userGenerated

body

boolean

false

none

»»»» hasError

body

boolean

false

none

»»»» required

body

boolean

false

none

»»»» enabled

body

boolean

false

none

»»»» visible

body

boolean

false

none

»»»» defaultValue

body

string¦null

false

none

»»» title

body

RESTAPI.v1.DTOs.BPM.BPMComponentTitleDTO

false

none

»»»» additionalProperties

body

any

false

none

»»»» content

body

string¦null

false

none

»»»» userGenerated

body

boolean

false

none

»»»» hasError

body

boolean

false

none

»»»» required

body

boolean

false

none

»»»» enabled

body

boolean

false

none

»»»» visible

body

boolean

false

none

»»»» defaultValue

body

string¦null

false

none

»»» subject

body

RESTAPI.v1.DTOs.BPM.BPMComponentSubjectDTO

false

none

»»»» additionalProperties

body

any

false

none

»»»» placeholder

body

string¦null

false

none

»»»» parameterName

body

string¦null

false

none

»»»» userGenerated

body

boolean

false

none

»»»» hasError

body

boolean

false

none

»»»» required

body

boolean

false

none

»»»» enabled

body

boolean

false

none

»»»» visible

body

boolean

false

none

»»»» defaultValue

body

string¦null

false

none

»»» description

body

RESTAPI.v1.DTOs.BPM.BPMComponentDescriptionDTO

false

none

»»»» additionalProperties

body

any

false

none

»»»» placeholder

body

string¦null

false

none

»»»» parameterName

body

string¦null

false

none

»»»» charLimit

body

integer(int32)

false

none

»»»» userGenerated

body

boolean

false

none

»»»» hasError

body

boolean

false

none

»»»» required

body

boolean

false

none

»»»» enabled

body

boolean

false

none

»»»» visible

body

boolean

false

none

»»»» defaultValue

body

string¦null

false

none

»»» text

body

RESTAPI.v1.DTOs.BPM.BPMComponentTextDTO

false

none

»»»» additionalProperties

body

any

false

none

»»»» placeholder

body

string¦null

false

none

»»»» charLimit

body

integer(int32)

false

none

»»»» content

body

string¦null

false

none

»»»» parameterName

body

string¦null

false

none

»»»» userGenerated

body

boolean

false

none

»»»» hasError

body

boolean

false

none

»»»» required

body

boolean

false

none

»»»» templateList

body

[RESTAPI.v1.DTOs.BPM.CommentTemplateDTO]¦null

false

none

»»»»» value

body

string¦null

false

none

»»»» enabled

body

boolean

false

none

»»»» visible

body

boolean

false

none

»»»» defaultValue

body

string¦null

false

none

»»» numeric

body

RESTAPI.v1.DTOs.BPM.BPMComponentNumericDTO

false

none

»»»» additionalProperties

body

any

false

none

»»»» placeholder

body

string¦null

false

none

»»»» charLimit

body

integer(int32)

false

none

»»»» content

body

string¦null

false

none

»»»» parameterName

body

string¦null

false

none

»»»» userGenerated

body

boolean

false

none

»»»» hasError

body

boolean

false

none

»»»» required

body

boolean

false

none

»»»» enabled

body

boolean

false

none

»»»» visible

body

boolean

false

none

»»»» defaultValue

body

integer(int32)

false

none

»»» sourcePickList

body

RESTAPI.v1.DTOs.BPM.BPMComponentSourcePickListDTO

false

none

»»»» additionalProperties

body

any

false

none

»»»» displayName

body

string¦null

false

none

»»»» displayColumn

body

string¦null

false

none

»»»» displayColumnDBType

body

string

false

none

»»»» idColumn

body

string¦null

false

none

»»»» idColumnDBType

body

string

false

none

»»»» placeholder

body

string¦null

false

none

»»»» sort

body

string¦null

false

none

»»»» sortOrder

body

string

false

none

»»»» parameterName

body

string¦null

false

none

»»»» hasError

body

boolean

false

none

»»»» required

body

boolean

false

none

»»»» userGenerated

body

boolean

false

none

»»»» hideIDColumn

body

boolean¦null

false

none

»»»» enabled

body

boolean

false

none

»»»» visible

body

boolean

false

none

»»»» defaultValue

body

string¦null

false

none

»» componentMappings

body

[RESTAPI.v1.DTOs.BPM.BPMAutoAdjustComponentMappingDTO]¦null

false

none

»»» nodeID

body

integer(int32)

false

none

»»» nodeName

body

string¦null

false

none

»»» tableName

body

string¦null

false

none

»»» columnName

body

string¦null

false

none

»»» dataType

body

string¦null

false

none

»»» isPrimaryKey

body

boolean

false

none

»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

» rules

body

[RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleDTO]¦null

false

none

»» id

body

integer(int32)

false

none

»» ruleName

body

string¦null

false

none

»» outcomeComponentID

body

integer(int32)

false

none

»» workflowID

body

integer(int32)

false

none

»» sortOrder

body

integer(int32)

false

none

»» description

body

string¦null

false

none

»» metadata

body

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleMetadataDTO

false

none

»»» conditionComponentIDs

body

[integer]¦null

false

none

»»» outcomeComponentID

body

integer(int32)

false

none

»» outcome

body

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleOutcomeDTO

false

none

»»» componentID

body

integer(int32)

false

none

»»» defaultValue

body

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleValueDTO

false

none

»»»» text

body

string¦null

false

none

»»»» numeric

body

string¦null

false

none

»»»» picklistValue

body

string¦null

false

none

»»»» sourceBasedId

body

string¦null

false

none

»»»» rangeValue

body

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleRangeValueDTO

false

none

»»»»» min

body

any

false

none

»»»»» max

body

any

false

none

»»» enabled

body

boolean¦null

false

none

»»» visible

body

boolean¦null

false

none

»» conditions

body

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleConditionDTO

false

none

»»» id

body

string¦null

false

none

»»» type

body

string¦null

false

none

»»» componentID

body

integer(int32)

false

none

»»» operation

body

string¦null

false

none

»»» value

body

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleValueDTO

false

none

»»» children

body

array¦null

false

none

»»»» anonymous

body

any

false

none

»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

»» type

pickList

»» type

title

»» type

subject

»» type

description

»» type

text

»» type

numeric

»» type

sourcePickList

»»»»»»» type

Equals

»»»»»»» type

NotEquals

»»»»»»» type

LessThan

»»»»»»» type

LessThanEquals

»»»»»»» type

GreaterThan

»»»»»»» type

GreaterThanEquals

»»»»»»» type

IsNull

»»»»»»» type

IsNotNull

»»»»»»» type

Contains

»»»»»»» type

NotContains

»»»»»»» type

StartWith

»»»»»»» type

EndWith

»»»»»»» type

InRange

»»»»»»» type

InArray

»»»»»»» type

NotInArray

»»»»»»» special

CurrentWebUser

»»»»»»» special

CurrentDate

»»»»»»» special

CurrentRowValue

»»»»»»» special

WorkflowFormID

»»»» displayColumnDBType

String

»»»» displayColumnDBType

LongString

»»»» displayColumnDBType

MaxString

»»»» displayColumnDBType

Date

»»»» displayColumnDBType

DateTime

»»»» displayColumnDBType

Decimal

»»»» displayColumnDBType

Int

»»»» displayColumnDBType

Long

»»»» displayColumnDBType

Float

»»»» displayColumnDBType

BLOB

»»»» displayColumnDBType

Identity

»»»» displayColumnDBType

CLOB

»»»» displayColumnDBType

RowVersion

»»»» displayColumnDBType

UID

»»»» displayColumnDBType

VarCharMax

»»»» displayColumnDBType

Boolean

»»»» idColumnDBType

String

»»»» idColumnDBType

LongString

»»»» idColumnDBType

MaxString

»»»» idColumnDBType

Date

»»»» idColumnDBType

DateTime

»»»» idColumnDBType

Decimal

»»»» idColumnDBType

Int

»»»» idColumnDBType

Long

»»»» idColumnDBType

Float

»»»» idColumnDBType

BLOB

»»»» idColumnDBType

Identity

»»»» idColumnDBType

CLOB

»»»» idColumnDBType

RowVersion

»»»» idColumnDBType

UID

»»»» idColumnDBType

VarCharMax

»»»» idColumnDBType

Boolean

»»»» sortOrder

Ascending

»»»» sortOrder

Descending

»»»» sortOrder

AscendingNullsFirst

»»»» sortOrder

DescendingNullsLast

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.BPM.BPMInquiryFormDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/workflows/{id}/InquiryForm", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflows/{id}/InquiryForm");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "components": [
    {
      "workflowID": 0,
      "componentID": 0,
      "name": "string",
      "type": "pickList",
      "order": 0,
      "categories": [],
      "source": {},
      "config": {},
      "componentMappings": [],
      "rowVersion": {}
    }
  ],
  "rules": [
    {
      "id": 0,
      "ruleName": "string",
      "outcomeComponentID": 0,
      "workflowID": 0,
      "sortOrder": 0,
      "description": "string",
      "metadata": {},
      "outcome": {},
      "conditions": {},
      "rowVersion": {}
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflows/{id}/InquiryForm',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/workflows/{id}/InquiryForm', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/workflows/{id}/InquiryForm',
  params: {
  }, headers: headers

p JSON.parse(result)

Get inquiry info for admin.

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.BPMAdminInquiryMonthInfoDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workflowmanager/bpmInquiries/getmonthinfo", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/bpmInquiries/getmonthinfo");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflowmanager/bpmInquiries/getmonthinfo',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/workflowmanager/bpmInquiries/getmonthinfo', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/workflowmanager/bpmInquiries/getmonthinfo',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "newInquiries": 0,
  "totalInquiries": 0,
  "averageOpenDays": 0
}
{"newInquiries":0,"totalInquiries":0,"averageOpenDays":0}

BPMControllerV1_UpdateInquiryAdminOwner

Body parameter

{
  "adminSwimLaneID": 0,
  "assignee": "string",
  "adminSwimlaneName": "string"
}

Parameters

Name

In

Type

Required

Description

inquiryID

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.BPMInquiryOwnerDTO

false

none

» adminSwimLaneID

body

integer(int32)

false

none

» assignee

body

string¦null

false

none

» adminSwimlaneName

body

string¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Update the admin owner of an inquiry

Varicent.RESTAPI.v1.DTOs.BPMInquiryOwnerDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/workflowmanager/bpmInquiries/{inquiryID}/owner", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/bpmInquiries/{inquiryID}/owner");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "adminSwimLaneID": 0,
  "assignee": "string",
  "adminSwimlaneName": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflowmanager/bpmInquiries/{inquiryID}/owner',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/workflowmanager/bpmInquiries/{inquiryID}/owner', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/workflowmanager/bpmInquiries/{inquiryID}/owner',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "adminSwimLaneID": 0,
  "assignee": "string",
  "adminSwimlaneName": "string"
}
{"adminSwimLaneID":0,"assignee":"string","adminSwimlaneName":"string"}

Get the limit of instances of each form field type, default is 5 unless specified otherwise by the feature flag “InquiryWorkflowFormFieldInstancesLimit”.

Responses

Status

Meaning

Description

Schema

200

OK

Success

integer

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workflows/InquiryFormComponent/FormFieldLimit", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflows/InquiryFormComponent/FormFieldLimit");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflows/InquiryFormComponent/FormFieldLimit',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/workflows/InquiryFormComponent/FormFieldLimit', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/workflows/InquiryFormComponent/FormFieldLimit',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
0
0

Get rules for the workflow inquiry form

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleDTO]

false

none

none

» id

integer(int32)

false

none

none

» ruleName

string¦null

false

none

none

» outcomeComponentID

integer(int32)

false

none

none

» workflowID

integer(int32)

false

none

none

» sortOrder

integer(int32)

false

none

none

» description

string¦null

false

none

none

» metadata

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleMetadataDTO

false

none

none

»» conditionComponentIDs

[integer]¦null

false

none

none

»» outcomeComponentID

integer(int32)

false

none

none

» outcome

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleOutcomeDTO

false

none

none

»» componentID

integer(int32)

false

none

none

»» defaultValue

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleValueDTO

false

none

none

»»» text

string¦null

false

none

none

»»» numeric

string¦null

false

none

none

»»» picklistValue

string¦null

false

none

none

»»» sourceBasedId

string¦null

false

none

none

»»» rangeValue

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleRangeValueDTO

false

none

none

»»»» min

any

false

none

none

»»»» max

any

false

none

none

»» enabled

boolean¦null

false

none

none

»» visible

boolean¦null

false

none

none

» conditions

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleConditionDTO

false

none

none

»» id

string¦null

false

none

none

»» type

string¦null

false

none

none

»» componentID

integer(int32)

false

none

none

»» operation

string¦null

false

none

none

»» value

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleValueDTO

false

none

none

»» children

array¦null

false

none

none

»»» anonymous

any

false

none

none

» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workflows/{id}/InquiryFormRules", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflows/{id}/InquiryFormRules");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflows/{id}/InquiryFormRules',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/workflows/{id}/InquiryFormRules', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/workflows/{id}/InquiryFormRules',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "ruleName": "string",
    "outcomeComponentID": 0,
    "workflowID": 0,
    "sortOrder": 0,
    "description": "string",
    "metadata": {
      "conditionComponentIDs": [],
      "outcomeComponentID": 0
    },
    "outcome": {
      "componentID": 0,
      "defaultValue": {},
      "enabled": true,
      "visible": true
    },
    "conditions": {
      "id": "string",
      "type": "string",
      "componentID": 0,
      "operation": "string",
      "value": {},
      "children": []
    },
    "rowVersion": {
      "rowVersion": 0
    }
  }
]
[{"id":0,"ruleName":"string","outcomeComponentID":0,"workflowID":0,"sortOrder":0,"description":"string","metadata":{"conditionComponentIDs":[],"outcomeComponentID":0},"outcome":{"componentID":0,"defaultValue":{},"enabled":true,"visible":true},"conditions":{"id":"string","type":"string","componentID":0,"operation":"string","value":{},"children":[]},"rowVersion":{"rowVersion":0}}]

Create rule for the workflow inquiry form

Body parameter

[
  {
    "ruleName": "string",
    "outcomeComponentID": 0,
    "workflowID": 0,
    "sortOrder": 0,
    "description": "string",
    "outcome": {
      "componentID": 0,
      "defaultValue": {},
      "enabled": true,
      "visible": true
    },
    "conditions": {
      "id": "string",
      "type": "string",
      "componentID": 0,
      "operation": "string",
      "value": {},
      "children": []
    }
  }
]

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleDTO_Create

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleDTO]

false

none

none

» id

integer(int32)

false

none

none

» ruleName

string¦null

false

none

none

» outcomeComponentID

integer(int32)

false

none

none

» workflowID

integer(int32)

false

none

none

» sortOrder

integer(int32)

false

none

none

» description

string¦null

false

none

none

» metadata

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleMetadataDTO

false

none

none

»» conditionComponentIDs

[integer]¦null

false

none

none

»» outcomeComponentID

integer(int32)

false

none

none

» outcome

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleOutcomeDTO

false

none

none

»» componentID

integer(int32)

false

none

none

»» defaultValue

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleValueDTO

false

none

none

»»» text

string¦null

false

none

none

»»» numeric

string¦null

false

none

none

»»» picklistValue

string¦null

false

none

none

»»» sourceBasedId

string¦null

false

none

none

»»» rangeValue

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleRangeValueDTO

false

none

none

»»»» min

any

false

none

none

»»»» max

any

false

none

none

»» enabled

boolean¦null

false

none

none

»» visible

boolean¦null

false

none

none

» conditions

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleConditionDTO

false

none

none

»» id

string¦null

false

none

none

»» type

string¦null

false

none

none

»» componentID

integer(int32)

false

none

none

»» operation

string¦null

false

none

none

»» value

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleValueDTO

false

none

none

»» children

array¦null

false

none

none

»»» anonymous

any

false

none

none

» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/workflows/{id}/InquiryFormRules", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflows/{id}/InquiryFormRules");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "ruleName": "string",
    "outcomeComponentID": 0,
    "workflowID": 0,
    "sortOrder": 0,
    "description": "string",
    "outcome": {
      "componentID": 0,
      "defaultValue": {},
      "enabled": true,
      "visible": true
    },
    "conditions": {
      "id": "string",
      "type": "string",
      "componentID": 0,
      "operation": "string",
      "value": {},
      "children": []
    }
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflows/{id}/InquiryFormRules',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/workflows/{id}/InquiryFormRules', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/workflows/{id}/InquiryFormRules',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "ruleName": "string",
    "outcomeComponentID": 0,
    "workflowID": 0,
    "sortOrder": 0,
    "description": "string",
    "metadata": {
      "conditionComponentIDs": [],
      "outcomeComponentID": 0
    },
    "outcome": {
      "componentID": 0,
      "defaultValue": {},
      "enabled": true,
      "visible": true
    },
    "conditions": {
      "id": "string",
      "type": "string",
      "componentID": 0,
      "operation": "string",
      "value": {},
      "children": []
    },
    "rowVersion": {
      "rowVersion": 0
    }
  }
]
[{"id":0,"ruleName":"string","outcomeComponentID":0,"workflowID":0,"sortOrder":0,"description":"string","metadata":{"conditionComponentIDs":[],"outcomeComponentID":0},"outcome":{"componentID":0,"defaultValue":{},"enabled":true,"visible":true},"conditions":{"id":"string","type":"string","componentID":0,"operation":"string","value":{},"children":[]},"rowVersion":{"rowVersion":0}}]

Update the rule for the workflow inquiry form

Body parameter

[
  {
    "id": 0,
    "ruleName": "string",
    "outcomeComponentID": 0,
    "workflowID": 0,
    "sortOrder": 0,
    "description": "string",
    "metadata": {
      "conditionComponentIDs": [],
      "outcomeComponentID": 0
    },
    "outcome": {
      "componentID": 0,
      "defaultValue": {},
      "enabled": true,
      "visible": true
    },
    "conditions": {
      "id": "string",
      "type": "string",
      "componentID": 0,
      "operation": "string",
      "value": {},
      "children": []
    },
    "rowVersion": {
      "rowVersion": 0
    }
  }
]

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleDTO

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleDTO]

false

none

none

» id

integer(int32)

false

none

none

» ruleName

string¦null

false

none

none

» outcomeComponentID

integer(int32)

false

none

none

» workflowID

integer(int32)

false

none

none

» sortOrder

integer(int32)

false

none

none

» description

string¦null

false

none

none

» metadata

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleMetadataDTO

false

none

none

»» conditionComponentIDs

[integer]¦null

false

none

none

»» outcomeComponentID

integer(int32)

false

none

none

» outcome

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleOutcomeDTO

false

none

none

»» componentID

integer(int32)

false

none

none

»» defaultValue

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleValueDTO

false

none

none

»»» text

string¦null

false

none

none

»»» numeric

string¦null

false

none

none

»»» picklistValue

string¦null

false

none

none

»»» sourceBasedId

string¦null

false

none

none

»»» rangeValue

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleRangeValueDTO

false

none

none

»»»» min

any

false

none

none

»»»» max

any

false

none

none

»» enabled

boolean¦null

false

none

none

»» visible

boolean¦null

false

none

none

» conditions

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleConditionDTO

false

none

none

»» id

string¦null

false

none

none

»» type

string¦null

false

none

none

»» componentID

integer(int32)

false

none

none

»» operation

string¦null

false

none

none

»» value

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleValueDTO

false

none

none

»» children

array¦null

false

none

none

»»» anonymous

any

false

none

none

» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/workflows/{id}/InquiryFormRules", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflows/{id}/InquiryFormRules");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "id": 0,
    "ruleName": "string",
    "outcomeComponentID": 0,
    "workflowID": 0,
    "sortOrder": 0,
    "description": "string",
    "metadata": {
      "conditionComponentIDs": [],
      "outcomeComponentID": 0
    },
    "outcome": {
      "componentID": 0,
      "defaultValue": {},
      "enabled": true,
      "visible": true
    },
    "conditions": {
      "id": "string",
      "type": "string",
      "componentID": 0,
      "operation": "string",
      "value": {},
      "children": []
    },
    "rowVersion": {
      "rowVersion": 0
    }
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflows/{id}/InquiryFormRules',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/workflows/{id}/InquiryFormRules', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/workflows/{id}/InquiryFormRules',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "ruleName": "string",
    "outcomeComponentID": 0,
    "workflowID": 0,
    "sortOrder": 0,
    "description": "string",
    "metadata": {
      "conditionComponentIDs": [],
      "outcomeComponentID": 0
    },
    "outcome": {
      "componentID": 0,
      "defaultValue": {},
      "enabled": true,
      "visible": true
    },
    "conditions": {
      "id": "string",
      "type": "string",
      "componentID": 0,
      "operation": "string",
      "value": {},
      "children": []
    },
    "rowVersion": {
      "rowVersion": 0
    }
  }
]
[{"id":0,"ruleName":"string","outcomeComponentID":0,"workflowID":0,"sortOrder":0,"description":"string","metadata":{"conditionComponentIDs":[],"outcomeComponentID":0},"outcome":{"componentID":0,"defaultValue":{},"enabled":true,"visible":true},"conditions":{"id":"string","type":"string","componentID":0,"operation":"string","value":{},"children":[]},"rowVersion":{"rowVersion":0}}]

Get rule by ID

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

ruleID

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workflows/{id}/InquiryFormRules/{ruleid}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflows/{id}/InquiryFormRules/{ruleid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflows/{id}/InquiryFormRules/{ruleid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/workflows/{id}/InquiryFormRules/{ruleid}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/workflows/{id}/InquiryFormRules/{ruleid}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "ruleName": "string",
  "outcomeComponentID": 0,
  "workflowID": 0,
  "sortOrder": 0,
  "description": "string",
  "metadata": {
    "conditionComponentIDs": [
      0
    ],
    "outcomeComponentID": 0
  },
  "outcome": {
    "componentID": 0,
    "defaultValue": {
      "text": "string",
      "numeric": "string",
      "picklistValue": "string",
      "sourceBasedId": "string",
      "rangeValue": {}
    },
    "enabled": true,
    "visible": true
  },
  "conditions": {
    "id": "string",
    "type": "string",
    "componentID": 0,
    "operation": "string",
    "value": {
      "text": "string",
      "numeric": "string",
      "picklistValue": "string",
      "sourceBasedId": "string",
      "rangeValue": {}
    },
    "children": []
  },
  "rowVersion": {
    "rowVersion": 0
  }
}
{"id":0,"ruleName":"string","outcomeComponentID":0,"workflowID":0,"sortOrder":0,"description":"string","metadata":{"conditionComponentIDs":[0],"outcomeComponentID":0},"outcome":{"componentID":0,"defaultValue":{"text":"string","numeric":"string","picklistValue":"string","sourceBasedId":"string","rangeValue":{}},"enabled":true,"visible":true},"conditions":{"id":"string","type":"string","componentID":0,"operation":"string","value":{"text":"string","numeric":"string","picklistValue":"string","sourceBasedId":"string","rangeValue":{}},"children":[]},"rowVersion":{"rowVersion":0}}

DELETE rule for the workflow inquiry form

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

ruleId

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/workflows/{id}/InquiryFormRules/{ruleId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflows/{id}/InquiryFormRules/{ruleId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/workflows/{id}/InquiryFormRules/{ruleId}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/workflows/{id}/InquiryFormRules/{ruleId}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/workflows/{id}/InquiryFormRules/{ruleId}',
  params: {
  }

p JSON.parse(result)

Update the sort order of the rules

Body parameter

[
  {
    "workflowID": 0,
    "ruleID": 0,
    "sortOrder": 0,
    "rowVersion": {
      "rowVersion": 0
    }
  }
]

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleDTO_Reorder

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleDTO]

false

none

none

» id

integer(int32)

false

none

none

» ruleName

string¦null

false

none

none

» outcomeComponentID

integer(int32)

false

none

none

» workflowID

integer(int32)

false

none

none

» sortOrder

integer(int32)

false

none

none

» description

string¦null

false

none

none

» metadata

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleMetadataDTO

false

none

none

»» conditionComponentIDs

[integer]¦null

false

none

none

»» outcomeComponentID

integer(int32)

false

none

none

» outcome

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleOutcomeDTO

false

none

none

»» componentID

integer(int32)

false

none

none

»» defaultValue

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleValueDTO

false

none

none

»»» text

string¦null

false

none

none

»»» numeric

string¦null

false

none

none

»»» picklistValue

string¦null

false

none

none

»»» sourceBasedId

string¦null

false

none

none

»»» rangeValue

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleRangeValueDTO

false

none

none

»»»» min

any

false

none

none

»»»» max

any

false

none

none

»» enabled

boolean¦null

false

none

none

»» visible

boolean¦null

false

none

none

» conditions

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleConditionDTO

false

none

none

»» id

string¦null

false

none

none

»» type

string¦null

false

none

none

»» componentID

integer(int32)

false

none

none

»» operation

string¦null

false

none

none

»» value

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleValueDTO

false

none

none

»» children

array¦null

false

none

none

»»» anonymous

any

false

none

none

» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/workflows/{id}/InquiryFormRulesSortOrder", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflows/{id}/InquiryFormRulesSortOrder");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "workflowID": 0,
    "ruleID": 0,
    "sortOrder": 0,
    "rowVersion": {
      "rowVersion": 0
    }
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflows/{id}/InquiryFormRulesSortOrder',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/workflows/{id}/InquiryFormRulesSortOrder', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/workflows/{id}/InquiryFormRulesSortOrder',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "ruleName": "string",
    "outcomeComponentID": 0,
    "workflowID": 0,
    "sortOrder": 0,
    "description": "string",
    "metadata": {
      "conditionComponentIDs": [],
      "outcomeComponentID": 0
    },
    "outcome": {
      "componentID": 0,
      "defaultValue": {},
      "enabled": true,
      "visible": true
    },
    "conditions": {
      "id": "string",
      "type": "string",
      "componentID": 0,
      "operation": "string",
      "value": {},
      "children": []
    },
    "rowVersion": {
      "rowVersion": 0
    }
  }
]
[{"id":0,"ruleName":"string","outcomeComponentID":0,"workflowID":0,"sortOrder":0,"description":"string","metadata":{"conditionComponentIDs":[],"outcomeComponentID":0},"outcome":{"componentID":0,"defaultValue":{},"enabled":true,"visible":true},"conditions":{"id":"string","type":"string","componentID":0,"operation":"string","value":{},"children":[]},"rowVersion":{"rowVersion":0}}]

Update the component config

Body parameter

[
  {
    "workflowID": 0,
    "componentID": 0,
    "type": "pickList",
    "config": {
      "pickList": {},
      "title": {},
      "subject": {},
      "description": {},
      "text": {},
      "numeric": {},
      "sourcePickList": {}
    },
    "rowVersion": {
      "rowVersion": 0
    }
  }
]

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

RESTAPI.v1.DTOs.BPM.BPMComponentDTO_PatchConfig

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.BPM.BPMComponentDTO]

false

none

none

» workflowID

integer(int32)

false

none

none

» componentID

integer(int32)

false

none

none

» name

string¦null

false

none

none

» type

string

false

none

none

» order

integer(int32)

false

none

none

» categories

[RESTAPI.v1.DTOs.BPMInquiryCategoryDTO]¦null

false

none

none

»» categoryID

integer(int32)

false

none

none

»» value

string¦null

false

none

none

» source

RESTAPI.v1.DTOs.BPM.BPMComponentSourceDTO

false

none

none

»» sourceID

integer(int32)¦null

false

none

none

»» sourceReference

RESTAPI.v1.DTOs.BPM.BPMComponentSourceReferenceDTO

false

none

none

»»» tableName

string¦null

false

none

none

»»» calculationID

integer(int32)¦null

false

none

none

»»» dataStoreID

integer(int32)¦null

false

none

none

»»» planBuilderCalculationID

string¦null

false

none

none

»» sourceFilters

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFiltersDTO

false

none

none

»»» filters

[RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterDTO]¦null

false

none

none

»»»» constraint

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterConstraintDTO

false

none

none

»»»»» columnName

string¦null

false

none

none

»»»»» operator

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterOperatorDTO

false

none

none

»»»»»» type

string

false

none

none

»»»»» value

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterValueDTO

false

none

none

»»»»»» text

string¦null

false

none

none

»»»»»» numeric

number(double)¦null

false

none

none

»»»»»» date

string(date-time)¦null

false

none

none

»»»»»» special

string¦null

false

none

none

»»»»»» valueId

integer(int32)¦null

false

none

none

»»»»»» rangeValue

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexRangeValueDTO

false

none

none

»»»»»»» min

any

false

none

none

»»»»»»» max

any

false

none

none

»»»»» caseSensitive

boolean¦null

false

none

none

»»»» and

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterAndDTO

false

none

none

»»»»» filters

array¦null

false

none

none

»»»»»» anonymous

any

false

none

none

»»»» or

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterOrDTO

false

none

none

»»»»» filters

array¦null

false

none

none

»»»»»» anonymous

any

false

none

none

»»»» not

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterNotDTO

false

none

none

»»»»» filter

any

false

none

none

»»»» metadata

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterMetaDataDTO

false

none

none

»»»»» additionalProperties

any

false

none

none

»» columns

[RESTAPI.v1.DTOs.BPM.BPMComponentSourceColumnDTO]¦null

false

none

none

»»» columnName

string¦null

false

none

none

»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»» rowVersion

integer(int64)

false

none

none

» config

RESTAPI.v1.DTOs.BPM.BPMComponentConfigDTO

false

none

none

»» pickList

RESTAPI.v1.DTOs.BPM.BPMComponentPickListDTO

false

none

none

»»» additionalProperties

any

false

none

none

»»» placeholder

string¦null

false

none

none

»»» sort

string¦null

false

none

none

»»» parameterName

string¦null

false

none

none

»»» userGenerated

boolean

false

none

none

»»» hasError

boolean

false

none

none

»»» required

boolean

false

none

none

»»» enabled

boolean

false

none

none

»»» visible

boolean

false

none

none

»»» defaultValue

string¦null

false

none

none

»» title

RESTAPI.v1.DTOs.BPM.BPMComponentTitleDTO

false

none

none

»»» additionalProperties

any

false

none

none

»»» content

string¦null

false

none

none

»»» userGenerated

boolean

false

none

none

»»» hasError

boolean

false

none

none

»»» required

boolean

false

none

none

»»» enabled

boolean

false

none

none

»»» visible

boolean

false

none

none

»»» defaultValue

string¦null

false

none

none

»» subject

RESTAPI.v1.DTOs.BPM.BPMComponentSubjectDTO

false

none

none

»»» additionalProperties

any

false

none

none

»»» placeholder

string¦null

false

none

none

»»» parameterName

string¦null

false

none

none

»»» userGenerated

boolean

false

none

none

»»» hasError

boolean

false

none

none

»»» required

boolean

false

none

none

»»» enabled

boolean

false

none

none

»»» visible

boolean

false

none

none

»»» defaultValue

string¦null

false

none

none

»» description

RESTAPI.v1.DTOs.BPM.BPMComponentDescriptionDTO

false

none

none

»»» additionalProperties

any

false

none

none

»»» placeholder

string¦null

false

none

none

»»» parameterName

string¦null

false

none

none

»»» charLimit

integer(int32)

false

none

none

»»» userGenerated

boolean

false

none

none

»»» hasError

boolean

false

none

none

»»» required

boolean

false

none

none

»»» enabled

boolean

false

none

none

»»» visible

boolean

false

none

none

»»» defaultValue

string¦null

false

none

none

»» text

RESTAPI.v1.DTOs.BPM.BPMComponentTextDTO

false

none

none

»»» additionalProperties

any

false

none

none

»»» placeholder

string¦null

false

none

none

»»» charLimit

integer(int32)

false

none

none

»»» content

string¦null

false

none

none

»»» parameterName

string¦null

false

none

none

»»» userGenerated

boolean

false

none

none

»»» hasError

boolean

false

none

none

»»» required

boolean

false

none

none

»»» templateList

[RESTAPI.v1.DTOs.BPM.CommentTemplateDTO]¦null

false

none

none

»»»» value

string¦null

false

none

none

»»» enabled

boolean

false

none

none

»»» visible

boolean

false

none

none

»»» defaultValue

string¦null

false

none

none

»» numeric

RESTAPI.v1.DTOs.BPM.BPMComponentNumericDTO

false

none

none

»»» additionalProperties

any

false

none

none

»»» placeholder

string¦null

false

none

none

»»» charLimit

integer(int32)

false

none

none

»»» content

string¦null

false

none

none

»»» parameterName

string¦null

false

none

none

»»» userGenerated

boolean

false

none

none

»»» hasError

boolean

false

none

none

»»» required

boolean

false

none

none

»»» enabled

boolean

false

none

none

»»» visible

boolean

false

none

none

»»» defaultValue

integer(int32)

false

none

none

»» sourcePickList

RESTAPI.v1.DTOs.BPM.BPMComponentSourcePickListDTO

false

none

none

»»» additionalProperties

any

false

none

none

»»» displayName

string¦null

false

none

none

»»» displayColumn

string¦null

false

none

none

»»» displayColumnDBType

string

false

none

none

»»» idColumn

string¦null

false

none

none

»»» idColumnDBType

string

false

none

none

»»» placeholder

string¦null

false

none

none

»»» sort

string¦null

false

none

none

»»» sortOrder

string

false

none

none

»»» parameterName

string¦null

false

none

none

»»» hasError

boolean

false

none

none

»»» required

boolean

false

none

none

»»» userGenerated

boolean

false

none

none

»»» hideIDColumn

boolean¦null

false

none

none

»»» enabled

boolean

false

none

none

»»» visible

boolean

false

none

none

»»» defaultValue

string¦null

false

none

none

» componentMappings

[RESTAPI.v1.DTOs.BPM.BPMAutoAdjustComponentMappingDTO]¦null

false

none

none

»» nodeID

integer(int32)

false

none

none

»» nodeName

string¦null

false

none

none

»» tableName

string¦null

false

none

none

»» columnName

string¦null

false

none

none

»» dataType

string¦null

false

none

none

»» isPrimaryKey

boolean

false

none

none

» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

type

pickList

type

title

type

subject

type

description

type

text

type

numeric

type

sourcePickList

type

Equals

type

NotEquals

type

LessThan

type

LessThanEquals

type

GreaterThan

type

GreaterThanEquals

type

IsNull

type

IsNotNull

type

Contains

type

NotContains

type

StartWith

type

EndWith

type

InRange

type

InArray

type

NotInArray

special

CurrentWebUser

special

CurrentDate

special

CurrentRowValue

special

WorkflowFormID

displayColumnDBType

String

displayColumnDBType

LongString

displayColumnDBType

MaxString

displayColumnDBType

Date

displayColumnDBType

DateTime

displayColumnDBType

Decimal

displayColumnDBType

Int

displayColumnDBType

Long

displayColumnDBType

Float

displayColumnDBType

BLOB

displayColumnDBType

Identity

displayColumnDBType

CLOB

displayColumnDBType

RowVersion

displayColumnDBType

UID

displayColumnDBType

VarCharMax

displayColumnDBType

Boolean

idColumnDBType

String

idColumnDBType

LongString

idColumnDBType

MaxString

idColumnDBType

Date

idColumnDBType

DateTime

idColumnDBType

Decimal

idColumnDBType

Int

idColumnDBType

Long

idColumnDBType

Float

idColumnDBType

BLOB

idColumnDBType

Identity

idColumnDBType

CLOB

idColumnDBType

RowVersion

idColumnDBType

UID

idColumnDBType

VarCharMax

idColumnDBType

Boolean

sortOrder

Ascending

sortOrder

Descending

sortOrder

AscendingNullsFirst

sortOrder

DescendingNullsLast

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/workflows/{id}/InquiryFormComponent/Config", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflows/{id}/InquiryFormComponent/Config");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "workflowID": 0,
    "componentID": 0,
    "type": "pickList",
    "config": {
      "pickList": {},
      "title": {},
      "subject": {},
      "description": {},
      "text": {},
      "numeric": {},
      "sourcePickList": {}
    },
    "rowVersion": {
      "rowVersion": 0
    }
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflows/{id}/InquiryFormComponent/Config',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/workflows/{id}/InquiryFormComponent/Config', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/workflows/{id}/InquiryFormComponent/Config',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "workflowID": 0,
    "componentID": 0,
    "name": "string",
    "type": "pickList",
    "order": 0,
    "categories": [
      {}
    ],
    "source": {
      "sourceID": 0,
      "sourceReference": {},
      "sourceFilters": {},
      "columns": [],
      "rowVersion": {}
    },
    "config": {
      "pickList": {},
      "title": {},
      "subject": {},
      "description": {},
      "text": {},
      "numeric": {},
      "sourcePickList": {}
    },
    "componentMappings": [
      {}
    ],
    "rowVersion": {
      "rowVersion": 0
    }
  }
]
[{"workflowID":0,"componentID":0,"name":"string","type":"pickList","order":0,"categories":[{}],"source":{"sourceID":0,"sourceReference":{},"sourceFilters":{},"columns":[],"rowVersion":{}},"config":{"pickList":{},"title":{},"subject":{},"description":{},"text":{},"numeric":{},"sourcePickList":{}},"componentMappings":[{}],"rowVersion":{"rowVersion":0}}]

Move a plan document from one folder to another

Body parameter

{
  "planDocument": {
    "planDocument": {
      "planDocumentId": 0,
      "name": "string",
      "workflowId": 0,
      "metadata": {},
      "distributionStatus": "Draft",
      "agreementVisited": true,
      "workflowVisited": true,
      "payeeCount": 0,
      "payeeStatusCount": {},
      "reportId": 0,
      "isWorkflowRunning": true,
      "description": "string",
      "workflowState": "NotStarted",
      "errors": {},
      "hasAdminSwimlane": true,
      "adminActionsCount": 0,
      "nodeErrorsCount": 0,
      "showDuplicateCallout": true,
      "pdfGenerationFails": 0,
      "version": {}
    },
    "parentFolderId": 0
  },
  "oldOrder": 0,
  "newOrder": 0,
  "oldParentFolderRowVersion": {
    "rowVersion": 0
  },
  "newParentFolderRowVersion": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

RESTAPI.v1.DTOs.PlanDocuments.UpdatePlanDocumentDTO

false

none

» planDocument

body

RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentChildNodeDTO

false

none

»» planDocument

body

RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentDTO

false

none

»»» planDocumentId

body

integer(int32)¦null

false

none

»»» name

body

string¦null

false

none

»»» workflowId

body

integer(int32)

false

none

»»» metadata

body

RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentMetadataDTO

false

none

»»»» additionalProperties

body

any

false

none

»»» distributionStatus

body

string

false

none

»»» agreementVisited

body

boolean

false

none

»»» workflowVisited

body

boolean

false

none

»»» payeeCount

body

integer(int32)

false

none

»»» payeeStatusCount

body

object¦null

false

none

»»»» additionalProperties

body

integer(int32)¦null

false

none

»»» reportId

body

integer(int32)

false

none

»»» isWorkflowRunning

body

boolean

false

none

»»» description

body

string¦null

false

none

»»» workflowState

body

string

false

none

»»» errors

body

object¦null

false

none

»»»» NoError

body

string

false

none

»»»» CannotBeEmpty

body

string

false

none

»»»» LessThan100Char

body

string

false

none

»»»» NoTrailingSpaces

body

string

false

none

»»»» NameAlreadyExists

body

string

false

none

»»»» PresenterAdaptiveSpecificError

body

string

false

none

»»» hasAdminSwimlane

body

boolean

false

none

»»» adminActionsCount

body

integer(int32)

false

none

»»» nodeErrorsCount

body

integer(int32)

false

none

»»» showDuplicateCallout

body

boolean

false

none

»»» pdfGenerationFails

body

integer(int32)

false

none

»»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»» rowVersion

body

integer(int64)

false

none

»» parentFolderId

body

integer(int32)

false

none

» oldOrder

body

integer(int32)

false

none

» newOrder

body

integer(int32)¦null

false

none

» oldParentFolderRowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

» newParentFolderRowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

»»» distributionStatus

Draft

»»» distributionStatus

Ready

»»» distributionStatus

DistributionInProgress

»»» distributionStatus

Distributed

»»» workflowState

NotStarted

»»» workflowState

InProgress

»»» workflowState

Ended

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/internal/plandocument/{id}/foldernode", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plandocument/{id}/foldernode");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "planDocument": {
    "planDocument": {
      "planDocumentId": 0,
      "name": "string",
      "workflowId": 0,
      "metadata": {},
      "distributionStatus": "Draft",
      "agreementVisited": true,
      "workflowVisited": true,
      "payeeCount": 0,
      "payeeStatusCount": {},
      "reportId": 0,
      "isWorkflowRunning": true,
      "description": "string",
      "workflowState": "NotStarted",
      "errors": {},
      "hasAdminSwimlane": true,
      "adminActionsCount": 0,
      "nodeErrorsCount": 0,
      "showDuplicateCallout": true,
      "pdfGenerationFails": 0,
      "version": {}
    },
    "parentFolderId": 0
  },
  "oldOrder": 0,
  "newOrder": 0,
  "oldParentFolderRowVersion": {
    "rowVersion": 0
  },
  "newParentFolderRowVersion": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/internal/plandocument/{id}/foldernode',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.put('http://localhost:8080/api/internal/plandocument/{id}/foldernode', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/internal/plandocument/{id}/foldernode',
  params: {
  }, headers: headers

p JSON.parse(result)

Move a plan document from any folder to another

Body parameter

[
  {
    "planDocument": {
      "planDocument": {},
      "parentFolderId": 0
    },
    "oldOrder": 0,
    "newOrder": 0,
    "oldParentFolderRowVersion": {
      "rowVersion": 0
    },
    "newParentFolderRowVersion": {
      "rowVersion": 0
    }
  }
]

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.PlanDocuments.UpdatePlanDocumentDTO RESTAPI.v1.DTOs.PlanDocuments.UpdatePlanDocumentDTO

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/internal/plandocument/bulkMove/foldernode", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plandocument/bulkMove/foldernode");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "planDocument": {
      "planDocument": {},
      "parentFolderId": 0
    },
    "oldOrder": 0,
    "newOrder": 0,
    "oldParentFolderRowVersion": {
      "rowVersion": 0
    },
    "newParentFolderRowVersion": {
      "rowVersion": 0
    }
  }
]';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/internal/plandocument/bulkMove/foldernode',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.put('http://localhost:8080/api/internal/plandocument/bulkMove/foldernode', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/internal/plandocument/bulkMove/foldernode',
  params: {
  }, headers: headers

p JSON.parse(result)

UsersControllerV1_GetInquirySwimLaneAdmins

Parameters

Name

In

Type

Required

Description

swimLaneID

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get list of admins in a swimlane

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.AdminUserDTO]

false

none

none

» id

string¦null

false

none

none

» name

string¦null

false

none

none

» email

string¦null

false

none

none

» role

string¦null

false

none

none

» createdAt

string(date-time)

false

none

none

» disabled

boolean

false

none

none

» isVaricentUser

boolean

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workflowmanager/bpmInquiries/swimlanes/{swimLaneId}/admin", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/bpmInquiries/swimlanes/{swimLaneId}/admin");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workflowmanager/bpmInquiries/swimlanes/{swimLaneId}/admin',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/workflowmanager/bpmInquiries/swimlanes/{swimLaneId}/admin', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/workflowmanager/bpmInquiries/swimlanes/{swimLaneId}/admin',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": "string",
    "name": "string",
    "email": "string",
    "role": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "disabled": true,
    "isVaricentUser": true,
    "version": {
      "rowVersion": 0
    }
  }
]
[{"id":"string","name":"string","email":"string","role":"string","createdAt":"2019-08-24T14:15:22Z","disabled":true,"isVaricentUser":true,"version":{"rowVersion":0}}]

Scenario

Get a table or calculation’s data modified by the changeset.

Parameters

Name

In

Type

Required

Description

workspaceId

path

integer(int32)

true

Workspace ID

scenarioId

path

integer(int32)

true

Scenario ID

itemId

path

integer(int32)

true

Scenario Item ID

changeId

path

integer(int32)

true

Scenario Item Change ID

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

filter

query

string

false

####Supported operations

fields

query

string

false

Comma delimited list of fields to display. Used to limit the output results to selected columns.

unique

query

boolean

false

Boolean value to select only unique values. Default value is false.

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

Any column

fields: Comma delimited list of fields to display. Used to limit the output results to selected columns.

Defaults to all available fields.

Examples

fields=PayeeID_

unique: Boolean value to select only unique values. Default value is false. When enabled, must specify exactly one column field.

Responses

Status

Meaning

Description

Schema

200

OK

Scenario Item Changes

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioChangeSetDTO]

false

none

none

» id

integer(int32)

false

none

none

» sequenceNo

integer(int32)

false

none

none

» name

string¦null

false

none

none

» description

string¦null

false

none

none

» changeType

string

false

none

none

» calendarPeriodRange

Varicent.RESTAPI.v1.DTOs.Scenarios.SimpleCalendarPeriodRangeDTO

false

none

none

»» timeId

string¦null

false

none

none

»» startPeriod

string¦null

false

none

none

»» endPeriod

string¦null

false

none

none

» scenarioChange

Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioChangeBaseDTO

false

none

none

»» tableName

string¦null

false

none

none

»» addedRows

[array]¦null

false

none

none

»» editedRows

[array]¦null

false

none

none

»» deletedRows

[array]¦null

false

none

none

»» changeQuery

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

»»» selectItems

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

none

»»»» alias

string¦null

false

none

none

»»»» column

string¦null

false

none

none

»»»» table

string¦null

false

none

none

»»»» customSelect

string¦null

false

none

none

»»»» dataType

string

false

none

none

»»»» type

string

false

none

none

»»»» value

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»» expressionType

string

false

none

none

»»»»» cases

array¦null

false

none

none

»»»»»» anonymous

any

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» column

string¦null

false

none

none

»»»»» op

string¦null

false

none

none

»»»»» arguments

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

none

[DTO version of IExpression]

»»»»»» expressionType

string

false

none

none

»»»»»» cases

array¦null

false

none

none

»»»»»»» anonymous

any

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» column

string¦null

false

none

none

»»»»»» op

string¦null

false

none

none

»»»»»» arguments

array¦null

false

none

none

»»»»»»» anonymous

any

false

none

none

»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»»» constraintType

string

false

none

none

»»»»»»» op

string¦null

false

none

none

»»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»» expressionType

string

false

none

none

»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» table

string¦null

false

none

none

»»»»»»»» column

string¦null

false

none

none

»»»»»»»» op

string¦null

false

none

none

»»»»»»»» arguments

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» condition

any

false

none

none

»»»»»»»» trueValue

any

false

none

none

»»»»»»»» falseValue

any

false

none

none

»»»»»»»» isDate

boolean

false

none

none

»»»»»»»» literalType

string

false

none

none

»»»»»»»» value

any

false

none

none

»»»»»»» caseSensitive

boolean

false

none

none

»»»»»»» constraints

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»»» literalRight

any

false

none

none

»»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»» right

any

false

none

none

»»»»»»» expressionLeft

any

false

none

none

»»»»»»» expressionRight

any

false

none

none

»»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»»» like

string¦null

false

none

none

»»»»»»» escapeWildcards

boolean

false

none

none

»»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»»» rowVersion

integer(int64)

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» queryDefinitionRight

any

false

none

none

»»»»»» trueValue

any

false

none

none

»»»»»» falseValue

any

false

none

none

»»»»»» isDate

boolean

false

none

none

»»»»»» literalType

string

false

none

none

»»»»»» value

any

false

none

none

»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»» trueValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» falseValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» isDate

boolean

false

none

none

»»»»» literalType

string

false

none

none

»»»»» value

any

false

none

none

»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»» namespaceTable

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

none

»»»»» m_namespace

string¦null

false

none

none

»»»»» name

string¦null

false

none

none

»»»» query

any

false

none

none

»»»» alias

string¦null

false

none

none

»»»» sourceType

string

false

none

none

»»» joins

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

none

»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»» joinType

string

false

none

none

»»»» onClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»» constraintType

string

false

none

none

»»»»» op

string¦null

false

none

none

»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»» caseSensitive

boolean

false

none

none

»»»»» constraints

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

none

[DTO version of IConstraint]

»»»»» literalRight

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»» right

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» expressionLeft

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» expressionRight

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» isPreciseDecimal

boolean

false

none

none

»»»»» like

string¦null

false

none

none

»»»»» escapeWildcards

boolean

false

none

none

»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» queryDefinitionRight

any

false

none

none

»»» whereClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»» order

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

none

»»»» table

string¦null

false

none

none

»»»» column

string¦null

false

none

none

»»»» direction

string

false

none

none

»»» group

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

none

»»»» table

string¦null

false

none

none

»»»» column

string¦null

false

none

none

»»» havingClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»» distinct

boolean

false

none

none

»»» unionWith

any

false

none

none

»»» exceptWith

any

false

none

none

»» field

string¦null

false

none

none

»» adjustOp

string

false

none

none

»» adjustOperand

number(double)

false

none

none

»» multiplyPercent

number(double)

false

none

none

»» replaceType

string

false

none

none

»» replaceValue

any

false

none

none

»» changeType

string

false

none

none

Enumerated Values

Property

Value

changeType

Transform

changeType

RowChange

dataType

Int

dataType

Decimal

dataType

DateTime

dataType

None

dataType

String

type

SelectAll

type

SelectItem

type

SelectLiteral

type

SelectCustom

type

SelectExpression

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

sourceType

Table

sourceType

Query

joinType

Inner

joinType

Left

joinType

Right

joinType

Cross

joinType

CrossApply

joinType

OuterApply

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

direction

Ascending

direction

Descending

direction

AscendingNullsFirst

direction

DescendingNullsLast

adjustOp

Add

adjustOp

Multiply

replaceType

Text

replaceType

Decimal

replaceType

Date

changeType

rowChange

changeType

adjustTransform

changeType

replaceTransform

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes/{changeId}/dataset", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes/{changeId}/dataset");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes/{changeId}/dataset',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes/{changeId}/dataset', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes/{changeId}/dataset',
  params: {
  }, headers: headers

p JSON.parse(result)

Get scenario item changes.

Parameters

Name

In

Type

Required

Description

workspaceId

path

integer(int32)

true

Workspace ID

scenarioId

path

integer(int32)

true

Scenario ID

itemId

path

integer(int32)

true

Scenario Item ID

Responses

Status

Meaning

Description

Schema

200

OK

Scenario Item Changes

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioChangeSetDTO]

false

none

none

» id

integer(int32)

false

none

none

» sequenceNo

integer(int32)

false

none

none

» name

string¦null

false

none

none

» description

string¦null

false

none

none

» changeType

string

false

none

none

» calendarPeriodRange

Varicent.RESTAPI.v1.DTOs.Scenarios.SimpleCalendarPeriodRangeDTO

false

none

none

»» timeId

string¦null

false

none

none

»» startPeriod

string¦null

false

none

none

»» endPeriod

string¦null

false

none

none

» scenarioChange

Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioChangeBaseDTO

false

none

none

»» tableName

string¦null

false

none

none

»» addedRows

[array]¦null

false

none

none

»» editedRows

[array]¦null

false

none

none

»» deletedRows

[array]¦null

false

none

none

»» changeQuery

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

»»» selectItems

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

none

»»»» alias

string¦null

false

none

none

»»»» column

string¦null

false

none

none

»»»» table

string¦null

false

none

none

»»»» customSelect

string¦null

false

none

none

»»»» dataType

string

false

none

none

»»»» type

string

false

none

none

»»»» value

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»» expressionType

string

false

none

none

»»»»» cases

array¦null

false

none

none

»»»»»» anonymous

any

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» column

string¦null

false

none

none

»»»»» op

string¦null

false

none

none

»»»»» arguments

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

none

[DTO version of IExpression]

»»»»»» expressionType

string

false

none

none

»»»»»» cases

array¦null

false

none

none

»»»»»»» anonymous

any

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» column

string¦null

false

none

none

»»»»»» op

string¦null

false

none

none

»»»»»» arguments

array¦null

false

none

none

»»»»»»» anonymous

any

false

none

none

»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»»» constraintType

string

false

none

none

»»»»»»» op

string¦null

false

none

none

»»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»» expressionType

string

false

none

none

»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» table

string¦null

false

none

none

»»»»»»»» column

string¦null

false

none

none

»»»»»»»» op

string¦null

false

none

none

»»»»»»»» arguments

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» condition

any

false

none

none

»»»»»»»» trueValue

any

false

none

none

»»»»»»»» falseValue

any

false

none

none

»»»»»»»» isDate

boolean

false

none

none

»»»»»»»» literalType

string

false

none

none

»»»»»»»» value

any

false

none

none

»»»»»»» caseSensitive

boolean

false

none

none

»»»»»»» constraints

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»»» literalRight

any

false

none

none

»»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»» right

any

false

none

none

»»»»»»» expressionLeft

any

false

none

none

»»»»»»» expressionRight

any

false

none

none

»»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»»» like

string¦null

false

none

none

»»»»»»» escapeWildcards

boolean

false

none

none

»»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»»» rowVersion

integer(int64)

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» queryDefinitionRight

any

false

none

none

»»»»»» trueValue

any

false

none

none

»»»»»» falseValue

any

false

none

none

»»»»»» isDate

boolean

false

none

none

»»»»»» literalType

string

false

none

none

»»»»»» value

any

false

none

none

»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»» trueValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» falseValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» isDate

boolean

false

none

none

»»»»» literalType

string

false

none

none

»»»»» value

any

false

none

none

»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»» namespaceTable

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

none

»»»»» m_namespace

string¦null

false

none

none

»»»»» name

string¦null

false

none

none

»»»» query

any

false

none

none

»»»» alias

string¦null

false

none

none

»»»» sourceType

string

false

none

none

»»» joins

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

none

»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»» joinType

string

false

none

none

»»»» onClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»» constraintType

string

false

none

none

»»»»» op

string¦null

false

none

none

»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»» caseSensitive

boolean

false

none

none

»»»»» constraints

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

none

[DTO version of IConstraint]

»»»»» literalRight

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»» right

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» expressionLeft

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» expressionRight

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»» isPreciseDecimal

boolean

false

none

none

»»»»» like

string¦null

false

none

none

»»»»» escapeWildcards

boolean

false

none

none

»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» queryDefinitionRight

any

false

none

none

»»» whereClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»» order

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

none

»»»» table

string¦null

false

none

none

»»»» column

string¦null

false

none

none

»»»» direction

string

false

none

none

»»» group

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

none

»»»» table

string¦null

false

none

none

»»»» column

string¦null

false

none

none

»»» havingClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»» distinct

boolean

false

none

none

»»» unionWith

any

false

none

none

»»» exceptWith

any

false

none

none

»» field

string¦null

false

none

none

»» adjustOp

string

false

none

none

»» adjustOperand

number(double)

false

none

none

»» multiplyPercent

number(double)

false

none

none

»» replaceType

string

false

none

none

»» replaceValue

any

false

none

none

»» changeType

string

false

none

none

Enumerated Values

Property

Value

changeType

Transform

changeType

RowChange

dataType

Int

dataType

Decimal

dataType

DateTime

dataType

None

dataType

String

type

SelectAll

type

SelectItem

type

SelectLiteral

type

SelectCustom

type

SelectExpression

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

sourceType

Table

sourceType

Query

joinType

Inner

joinType

Left

joinType

Right

joinType

Cross

joinType

CrossApply

joinType

OuterApply

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

direction

Ascending

direction

Descending

direction

AscendingNullsFirst

direction

DescendingNullsLast

adjustOp

Add

adjustOp

Multiply

replaceType

Text

replaceType

Decimal

replaceType

Date

changeType

rowChange

changeType

adjustTransform

changeType

replaceTransform

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "sequenceNo": 0,
    "name": "string",
    "description": "string",
    "changeType": "Transform",
    "calendarPeriodRange": {
      "timeId": "string",
      "startPeriod": "string",
      "endPeriod": "string"
    },
    "scenarioChange": {
      "tableName": "string",
      "addedRows": [],
      "editedRows": [],
      "deletedRows": [],
      "changeQuery": {},
      "field": "string",
      "adjustOp": "Add",
      "adjustOperand": 0.1,
      "multiplyPercent": 0.1,
      "replaceType": "Text",
      "replaceValue": null,
      "changeType": "rowChange"
    }
  }
]
[{"id":0,"sequenceNo":0,"name":"string","description":"string","changeType":"Transform","calendarPeriodRange":{"timeId":"string","startPeriod":"string","endPeriod":"string"},"scenarioChange":{"tableName":"string","addedRows":[],"editedRows":[],"deletedRows":[],"changeQuery":{},"field":"string","adjustOp":"Add","adjustOperand":0.1,"multiplyPercent":0.1,"replaceType":"Text","replaceValue":null,"changeType":"rowChange"}}]

Create a new scenario item change.

Body parameter

{
  "id": 0,
  "sequenceNo": 0,
  "name": "string",
  "description": "string",
  "changeType": "Transform",
  "calendarPeriodRange": {
    "timeId": "string",
    "startPeriod": "string",
    "endPeriod": "string"
  },
  "scenarioChange": {
    "tableName": "string",
    "addedRows": [
      []
    ],
    "editedRows": [
      []
    ],
    "deletedRows": [
      []
    ],
    "changeQuery": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "field": "string",
    "adjustOp": "Add",
    "adjustOperand": 0.1,
    "multiplyPercent": 0.1,
    "replaceType": "Text",
    "replaceValue": null,
    "changeType": "rowChange"
  }
}

Parameters

Name

In

Type

Required

Description

workspaceId

path

integer(int32)

true

Workspace ID

scenarioId

path

integer(int32)

true

Scenario ID

itemId

path

integer(int32)

true

Scenario Item ID

body

body

Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioChangeSetDTO

false

none

» id

body

integer(int32)

false

none

» sequenceNo

body

integer(int32)

false

none

» name

body

string¦null

false

none

» description

body

string¦null

false

none

» changeType

body

string

false

none

» calendarPeriodRange

body

Varicent.RESTAPI.v1.DTOs.Scenarios.SimpleCalendarPeriodRangeDTO

false

none

»» timeId

body

string¦null

false

none

»» startPeriod

body

string¦null

false

none

»» endPeriod

body

string¦null

false

none

» scenarioChange

body

Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioChangeBaseDTO

false

none

»» tableName

body

string¦null

false

none

»» addedRows

body

[array]¦null

false

none

»» editedRows

body

[array]¦null

false

none

»» deletedRows

body

[array]¦null

false

none

»» changeQuery

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»» alias

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» table

body

string¦null

false

none

»»»» customSelect

body

string¦null

false

none

»»»» dataType

body

string

false

none

»»»» type

body

string

false

none

»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»» expressionType

body

string

false

none

»»»»»» cases

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» arguments

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»» constraintType

body

string

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» condition

body

any

false

none

»»»»»»»» trueValue

body

any

false

none

»»»»»»»» falseValue

body

any

false

none

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»» constraints

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» literalRight

body

any

false

none

»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» right

body

any

false

none

»»»»»»» expressionLeft

body

any

false

none

»»»»»»» expressionRight

body

any

false

none

»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»» like

body

string¦null

false

none

»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»» trueValue

body

any

false

none

»»»»»» falseValue

body

any

false

none

»»»»»» isDate

body

boolean

false

none

»»»»»» literalType

body

string

false

none

»»»»»» value

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»» m_namespace

body

string¦null

false

none

»»»»» name

body

string¦null

false

none

»»»» query

body

any

false

none

»»»» alias

body

string¦null

false

none

»»»» sourceType

body

string

false

none

»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» joinType

body

string

false

none

»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» constraintType

body

string

false

none

»»»»» op

body

string¦null

false

none

»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» caseSensitive

body

boolean

false

none

»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isPreciseDecimal

body

boolean

false

none

»»»»» like

body

string¦null

false

none

»»»»» escapeWildcards

body

boolean

false

none

»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»» table

body

string¦null

false

none

»»»»» queryDefinitionRight

body

any

false

none

»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» direction

body

string

false

none

»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» distinct

body

boolean

false

none

»»» unionWith

body

any

false

none

»»» exceptWith

body

any

false

none

»» field

body

string¦null

false

none

»» adjustOp

body

string

false

none

»» adjustOperand

body

number(double)

false

none

»» multiplyPercent

body

number(double)

false

none

»» replaceType

body

string

false

none

»» replaceValue

body

any

false

none

»» changeType

body

string

false

none

Enumerated Values

Parameter

Value

» changeType

Transform

» changeType

RowChange

»»»» dataType

Int

»»»» dataType

Decimal

»»»» dataType

DateTime

»»»» dataType

None

»»»» dataType

String

»»»» type

SelectAll

»»»» type

SelectItem

»»»» type

SelectLiteral

»»»» type

SelectCustom

»»»» type

SelectExpression

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» expressionType

caseExpression

»»»»»» expressionType

dataField

»»»»»» expressionType

function

»»»»»» expressionType

ifExpression

»»»»»» expressionType

literal

»»»»»»» constraintType

clause

»»»»»»» constraintType

constraint

»»»»»»» constraintType

expressionConstraint

»»»»»»» constraintType

likeConstraint

»»»»»»» constraintType

rowVersionConstraint

»»»»»»» constraintType

subQueryConstraint

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»» literalType

Integer

»»»»»» literalType

Decimal

»»»»»» literalType

Date

»»»»»» literalType

DateTime

»»»»»» literalType

String

»»»»»» literalType

Float

»»»»»» literalType

Long

»»»»»» literalType

Null

»»»»»» literalType

Parameter

»»»»»» literalType

Guid

»»»»»» literalType

SystemUtcTime

»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» sourceType

Table

»»»» sourceType

Query

»»»» joinType

Inner

»»»» joinType

Left

»»»» joinType

Right

»»»» joinType

Cross

»»»» joinType

CrossApply

»»»» joinType

OuterApply

»»»»» constraintType

clause

»»»»» constraintType

constraint

»»»»» constraintType

expressionConstraint

»»»»» constraintType

likeConstraint

»»»»» constraintType

rowVersionConstraint

»»»»» constraintType

subQueryConstraint

»»»» direction

Ascending

»»»» direction

Descending

»»»» direction

AscendingNullsFirst

»»»» direction

DescendingNullsLast

»» adjustOp

Add

»» adjustOp

Multiply

»» replaceType

Text

»» replaceType

Decimal

»» replaceType

Date

»» changeType

rowChange

»» changeType

adjustTransform

»» changeType

replaceTransform

Responses

Status

Meaning

Description

Schema

201

Created

Created Scenario Item Change

Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioChangeSetDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "sequenceNo": 0,
  "name": "string",
  "description": "string",
  "changeType": "Transform",
  "calendarPeriodRange": {
    "timeId": "string",
    "startPeriod": "string",
    "endPeriod": "string"
  },
  "scenarioChange": {
    "tableName": "string",
    "addedRows": [
      []
    ],
    "editedRows": [
      []
    ],
    "deletedRows": [
      []
    ],
    "changeQuery": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "field": "string",
    "adjustOp": "Add",
    "adjustOperand": 0.1,
    "multiplyPercent": 0.1,
    "replaceType": "Text",
    "replaceValue": null,
    "changeType": "rowChange"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes',
  params: {
  }, headers: headers

p JSON.parse(result)

Reorder scenario item changes.

Body parameter

{
  "id": 0,
  "sequenceNo": 0,
  "name": "string",
  "description": "string",
  "changeType": "Transform",
  "calendarPeriodRange": {
    "timeId": "string",
    "startPeriod": "string",
    "endPeriod": "string"
  },
  "scenarioChange": {
    "tableName": "string",
    "addedRows": [
      []
    ],
    "editedRows": [
      []
    ],
    "deletedRows": [
      []
    ],
    "changeQuery": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "field": "string",
    "adjustOp": "Add",
    "adjustOperand": 0.1,
    "multiplyPercent": 0.1,
    "replaceType": "Text",
    "replaceValue": null,
    "changeType": "rowChange"
  }
}

Parameters

Name

In

Type

Required

Description

workspaceId

path

integer(int32)

true

Workspace ID

scenarioId

path

integer(int32)

true

Scenario ID

itemId

path

integer(int32)

true

Scenario Item ID

changeId

path

integer(int32)

true

Scenario Item Change ID

body

body

Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioChangeSetDTO

false

none

» id

body

integer(int32)

false

none

» sequenceNo

body

integer(int32)

false

none

» name

body

string¦null

false

none

» description

body

string¦null

false

none

» changeType

body

string

false

none

» calendarPeriodRange

body

Varicent.RESTAPI.v1.DTOs.Scenarios.SimpleCalendarPeriodRangeDTO

false

none

»» timeId

body

string¦null

false

none

»» startPeriod

body

string¦null

false

none

»» endPeriod

body

string¦null

false

none

» scenarioChange

body

Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioChangeBaseDTO

false

none

»» tableName

body

string¦null

false

none

»» addedRows

body

[array]¦null

false

none

»» editedRows

body

[array]¦null

false

none

»» deletedRows

body

[array]¦null

false

none

»» changeQuery

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»» alias

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» table

body

string¦null

false

none

»»»» customSelect

body

string¦null

false

none

»»»» dataType

body

string

false

none

»»»» type

body

string

false

none

»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»» expressionType

body

string

false

none

»»»»»» cases

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» arguments

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»» constraintType

body

string

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» condition

body

any

false

none

»»»»»»»» trueValue

body

any

false

none

»»»»»»»» falseValue

body

any

false

none

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»» constraints

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» literalRight

body

any

false

none

»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» right

body

any

false

none

»»»»»»» expressionLeft

body

any

false

none

»»»»»»» expressionRight

body

any

false

none

»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»» like

body

string¦null

false

none

»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»» trueValue

body

any

false

none

»»»»»» falseValue

body

any

false

none

»»»»»» isDate

body

boolean

false

none

»»»»»» literalType

body

string

false

none

»»»»»» value

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»» m_namespace

body

string¦null

false

none

»»»»» name

body

string¦null

false

none

»»»» query

body

any

false

none

»»»» alias

body

string¦null

false

none

»»»» sourceType

body

string

false

none

»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» joinType

body

string

false

none

»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» constraintType

body

string

false

none

»»»»» op

body

string¦null

false

none

»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» caseSensitive

body

boolean

false

none

»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isPreciseDecimal

body

boolean

false

none

»»»»» like

body

string¦null

false

none

»»»»» escapeWildcards

body

boolean

false

none

»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»» table

body

string¦null

false

none

»»»»» queryDefinitionRight

body

any

false

none

»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» direction

body

string

false

none

»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» distinct

body

boolean

false

none

»»» unionWith

body

any

false

none

»»» exceptWith

body

any

false

none

»» field

body

string¦null

false

none

»» adjustOp

body

string

false

none

»» adjustOperand

body

number(double)

false

none

»» multiplyPercent

body

number(double)

false

none

»» replaceType

body

string

false

none

»» replaceValue

body

any

false

none

»» changeType

body

string

false

none

Enumerated Values

Parameter

Value

» changeType

Transform

» changeType

RowChange

»»»» dataType

Int

»»»» dataType

Decimal

»»»» dataType

DateTime

»»»» dataType

None

»»»» dataType

String

»»»» type

SelectAll

»»»» type

SelectItem

»»»» type

SelectLiteral

»»»» type

SelectCustom

»»»» type

SelectExpression

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» expressionType

caseExpression

»»»»»» expressionType

dataField

»»»»»» expressionType

function

»»»»»» expressionType

ifExpression

»»»»»» expressionType

literal

»»»»»»» constraintType

clause

»»»»»»» constraintType

constraint

»»»»»»» constraintType

expressionConstraint

»»»»»»» constraintType

likeConstraint

»»»»»»» constraintType

rowVersionConstraint

»»»»»»» constraintType

subQueryConstraint

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»» literalType

Integer

»»»»»» literalType

Decimal

»»»»»» literalType

Date

»»»»»» literalType

DateTime

»»»»»» literalType

String

»»»»»» literalType

Float

»»»»»» literalType

Long

»»»»»» literalType

Null

»»»»»» literalType

Parameter

»»»»»» literalType

Guid

»»»»»» literalType

SystemUtcTime

»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» sourceType

Table

»»»» sourceType

Query

»»»» joinType

Inner

»»»» joinType

Left

»»»» joinType

Right

»»»» joinType

Cross

»»»» joinType

CrossApply

»»»» joinType

OuterApply

»»»»» constraintType

clause

»»»»» constraintType

constraint

»»»»» constraintType

expressionConstraint

»»»»» constraintType

likeConstraint

»»»»» constraintType

rowVersionConstraint

»»»»» constraintType

subQueryConstraint

»»»» direction

Ascending

»»»» direction

Descending

»»»» direction

AscendingNullsFirst

»»»» direction

DescendingNullsLast

»» adjustOp

Add

»» adjustOp

Multiply

»» replaceType

Text

»» replaceType

Decimal

»» replaceType

Date

»» changeType

rowChange

»» changeType

adjustTransform

»» changeType

replaceTransform

Responses

Status

Meaning

Description

Schema

200

OK

Modified Scenario Item Changes

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes/{changeId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes/{changeId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "sequenceNo": 0,
  "name": "string",
  "description": "string",
  "changeType": "Transform",
  "calendarPeriodRange": {
    "timeId": "string",
    "startPeriod": "string",
    "endPeriod": "string"
  },
  "scenarioChange": {
    "tableName": "string",
    "addedRows": [
      []
    ],
    "editedRows": [
      []
    ],
    "deletedRows": [
      []
    ],
    "changeQuery": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "field": "string",
    "adjustOp": "Add",
    "adjustOperand": 0.1,
    "multiplyPercent": 0.1,
    "replaceType": "Text",
    "replaceValue": null,
    "changeType": "rowChange"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes/{changeId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes/{changeId}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes/{changeId}',
  params: {
  }, headers: headers

p JSON.parse(result)

Delete a scenario item change.

Parameters

Name

In

Type

Required

Description

workspaceId

path

integer(int32)

true

Workspace ID

scenarioId

path

integer(int32)

true

Scenario ID

itemId

path

integer(int32)

true

Scenario Item ID

changeId

path

integer(int32)

true

Scenario Item Change ID

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes/{changeId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes/{changeId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes/{changeId}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes/{changeId}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes/{changeId}',
  params: {
  }

p JSON.parse(result)

Get scenario items

Parameters

Name

In

Type

Required

Description

workspaceId

path

integer(int32)

true

Workspace Id

scenarioId

path

integer(int32)

true

Scenario Id

Responses

Status

Meaning

Description

Schema

200

OK

Get scenario items

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioItemDTO]

false

none

none

» elementId

integer(int32)

false

none

none

» name

string¦null

false

none

none

» type

string

false

none

none

» sourceTableName

string¦null

false

none

none

» changeSets

Varicent.RESTAPI.v1.DTOs.ExpandableResourceDTO

false

none

none

»» href

string¦null

false

none

none

» isPromoted

boolean

false

none

none

» isFrozen

boolean

false

none

none

» order

integer(int32)

false

none

none

Enumerated Values

Property

Value

type

Table

type

Calculation

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "elementId": 0,
    "name": "string",
    "type": "Table",
    "sourceTableName": "string",
    "changeSets": {
      "href": "string"
    },
    "isPromoted": true,
    "isFrozen": true,
    "order": 0
  }
]
[{"elementId":0,"name":"string","type":"Table","sourceTableName":"string","changeSets":{"href":"string"},"isPromoted":true,"isFrozen":true,"order":0}]

Insert scenario item

Body parameter

{
  "elementId": 0,
  "name": "string",
  "type": "Table",
  "sourceTableName": "string",
  "changeSets": {
    "href": "string"
  },
  "isPromoted": true,
  "isFrozen": true,
  "order": 0
}

Parameters

Name

In

Type

Required

Description

workspaceId

path

integer(int32)

true

Workspace Id

scenarioId

path

integer(int32)

true

Scenario Id

body

body

Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioItemDTO

false

Scenario item details

» elementId

body

integer(int32)

false

none

» name

body

string¦null

false

none

» type

body

string

false

none

» sourceTableName

body

string¦null

false

none

» changeSets

body

Varicent.RESTAPI.v1.DTOs.ExpandableResourceDTO

false

none

»» href

body

string¦null

false

none

» isPromoted

body

boolean

false

none

» isFrozen

body

boolean

false

none

» order

body

integer(int32)

false

none

Enumerated Values

Parameter

Value

» type

Table

» type

Calculation

Responses

Status

Meaning

Description

Schema

201

Created

Created scenario item

Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioItemDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "elementId": 0,
  "name": "string",
  "type": "Table",
  "sourceTableName": "string",
  "changeSets": {
    "href": "string"
  },
  "isPromoted": true,
  "isFrozen": true,
  "order": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items',
  params: {
  }, headers: headers

p JSON.parse(result)

Reorder scenario item

Body parameter

{
  "elementId": 0,
  "name": "string",
  "type": "Table",
  "sourceTableName": "string",
  "changeSets": {
    "href": "string"
  },
  "isPromoted": true,
  "isFrozen": true,
  "order": 0
}

Parameters

Name

In

Type

Required

Description

workspaceId

path

integer(int32)

true

Workspace Id

scenarioId

path

integer(int32)

true

Scenario Id

body

body

Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioItemDTO

false

Scenario Item (elementId, order)

» elementId

body

integer(int32)

false

none

» name

body

string¦null

false

none

» type

body

string

false

none

» sourceTableName

body

string¦null

false

none

» changeSets

body

Varicent.RESTAPI.v1.DTOs.ExpandableResourceDTO

false

none

»» href

body

string¦null

false

none

» isPromoted

body

boolean

false

none

» isFrozen

body

boolean

false

none

» order

body

integer(int32)

false

none

Enumerated Values

Parameter

Value

» type

Table

» type

Calculation

Responses

Status

Meaning

Description

Schema

200

OK

Reorder scenario item

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioItemDTO]

false

none

none

» elementId

integer(int32)

false

none

none

» name

string¦null

false

none

none

» type

string

false

none

none

» sourceTableName

string¦null

false

none

none

» changeSets

Varicent.RESTAPI.v1.DTOs.ExpandableResourceDTO

false

none

none

»» href

string¦null

false

none

none

» isPromoted

boolean

false

none

none

» isFrozen

boolean

false

none

none

» order

integer(int32)

false

none

none

Enumerated Values

Property

Value

type

Table

type

Calculation

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "elementId": 0,
  "name": "string",
  "type": "Table",
  "sourceTableName": "string",
  "changeSets": {
    "href": "string"
  },
  "isPromoted": true,
  "isFrozen": true,
  "order": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items',
  params: {
  }, headers: headers

p JSON.parse(result)

Get scenario item by id

Parameters

Name

In

Type

Required

Description

workspaceId

path

integer(int32)

true

Workspace Id

scenarioId

path

integer(int32)

true

Scenario Id

itemId

path

integer(int32)

true

Scenario Item Id

Responses

Status

Meaning

Description

Schema

200

OK

Get scenario item by id

Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioItemDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "elementId": 0,
  "name": "string",
  "type": "Table",
  "sourceTableName": "string",
  "changeSets": {
    "href": "string"
  },
  "isPromoted": true,
  "isFrozen": true,
  "order": 0
}
{"elementId":0,"name":"string","type":"Table","sourceTableName":"string","changeSets":{"href":"string"},"isPromoted":true,"isFrozen":true,"order":0}

Delete scenario item by id

Parameters

Name

In

Type

Required

Description

workspaceId

path

integer(int32)

true

Workspace Id

scenarioId

path

integer(int32)

true

Scenario Id

itemId

path

integer(int32)

true

Scenario Item Id

Responses

Status

Meaning

Description

Schema

204

No Content

Delete scenario item by id

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}',
  params: {
  }

p JSON.parse(result)

Get data for a given table after applying the specified row change

Parameters

Name

In

Type

Required

Description

workspaceId

path

integer(int32)

true

Workspace Id

scenarioId

path

integer(int32)

true

Scenario Id

itemId

path

integer(int32)

true

Scenario Item Id

changeId

path

integer(int32)

true

Row change Id

offset

query

integer(int32)

false

none

limit

query

integer(int32)

false

none

filter

query

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Get data for a given table after applying the specified row change

Varicent.RESTAPI.v1.DTOs.ResultSetDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes/{changeId}/data", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes/{changeId}/data");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes/{changeId}/data',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes/{changeId}/data', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes/{changeId}/data',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "columnDefinitions": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "data": [
    null
  ],
  "columnSourceMap": {
    "property1": "string",
    "property2": "string"
  },
  "isDataSynced": true,
  "hierarchyMetadata": {
    "tableName": "string",
    "idColumnName": "string",
    "parentColumnName": "string"
  }
}
{"columnDefinitions":[{"name":"string","type":"String","isKey":true,"nullable":true,"values":"string","lockedPeriod":{},"referencedCol":"string","picklistFilter":"string","displayName":"string","isELTPeriod":true}],"data":[null],"columnSourceMap":{"property1":"string","property2":"string"},"isDataSynced":true,"hierarchyMetadata":{"tableName":"string","idColumnName":"string","parentColumnName":"string"}}

Returns a list of all possible scenario items that can be

added to a scenario that is part of the specified workspace. Note that it is the caller’s reponsibility to remove from this list any items that are already added to the particular scenario the caller is working with.

Parameters

Name

In

Type

Required

Description

workspaceId

path

integer(int32)

true

ID of the workspace, in the scope of which the candidate items are considered

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Scenarios.CandidateScenarioItemDTO]

false

none

none

» elementID

integer(int32)

false

none

none

» name

string¦null

false

none

none

» type

string

false

none

none

» sourceTableName

string¦null

false

none

none

Enumerated Values

Property

Value

type

Table

type

Calculation

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workspaces/{workspaceId}/candidateItems", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workspaces/{workspaceId}/candidateItems");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workspaces/{workspaceId}/candidateItems',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/workspaces/{workspaceId}/candidateItems', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/workspaces/{workspaceId}/candidateItems',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "elementID": 0,
    "name": "string",
    "type": "Table",
    "sourceTableName": "string"
  }
]
[{"elementID":0,"name":"string","type":"Table","sourceTableName":"string"}]

Get data for a transform item change after applying restriction changes

Body parameter

{
  "selectItems": [
    {
      "alias": "string",
      "column": "string",
      "table": "string",
      "customSelect": "string",
      "dataType": "Int",
      "type": "SelectAll",
      "value": {}
    }
  ],
  "source": {
    "namespaceTable": {
      "m_namespace": "string",
      "name": "string"
    },
    "query": null,
    "alias": "string",
    "sourceType": "Table"
  },
  "joins": [
    {
      "source": {},
      "joinType": "Inner",
      "onClause": {}
    }
  ],
  "whereClause": {
    "constraintType": "clause",
    "op": "string",
    "dataFieldLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "caseSensitive": true,
    "constraints": [
      {}
    ],
    "literalRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "dataFieldRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "right": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "isPreciseDecimal": true,
    "like": "string",
    "escapeWildcards": true,
    "rowVersion": {
      "rowVersion": 0
    },
    "table": "string",
    "queryDefinitionRight": null
  },
  "order": [
    {
      "table": "string",
      "column": "string",
      "direction": "Ascending"
    }
  ],
  "group": [
    {
      "table": "string",
      "column": "string"
    }
  ],
  "havingClause": {
    "constraintType": "clause",
    "op": "string",
    "dataFieldLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "caseSensitive": true,
    "constraints": [
      {}
    ],
    "literalRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "dataFieldRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "right": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "isPreciseDecimal": true,
    "like": "string",
    "escapeWildcards": true,
    "rowVersion": {
      "rowVersion": 0
    },
    "table": "string",
    "queryDefinitionRight": null
  },
  "distinct": true,
  "unionWith": null,
  "exceptWith": null
}

Parameters

Name

In

Type

Required

Description

workspaceId

path

integer(int32)

true

Workspace ID

scenarioId

path

integer(int32)

true

Scenario ID

itemId

path

integer(int32)

true

Scenario Item ID

changeId

path

integer(int32)

true

Row change ID

offset

query

integer(int32)

false

none

limit

query

integer(int32)

false

none

orderBy

query

string

false

none

filter

query

string

false

none

body

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

Query definition with restrictions

» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»» alias

body

string¦null

false

none

»» column

body

string¦null

false

none

»» table

body

string¦null

false

none

»» customSelect

body

string¦null

false

none

»» dataType

body

string

false

none

»» type

body

string

false

none

»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»» expressionType

body

string

false

none

»»» cases

body

array¦null

false

none

»»»» anonymous

body

any

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» op

body

string¦null

false

none

»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»» expressionType

body

string

false

none

»»»» cases

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» op

body

string¦null

false

none

»»»» arguments

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»» constraintType

body

string

false

none

»»»»» op

body

string¦null

false

none

»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»» expressionType

body

string

false

none

»»»»»» cases

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» arguments

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» condition

body

any

false

none

»»»»»» trueValue

body

any

false

none

»»»»»» falseValue

body

any

false

none

»»»»»» isDate

body

boolean

false

none

»»»»»» literalType

body

string

false

none

»»»»»» value

body

any

false

none

»»»»» caseSensitive

body

boolean

false

none

»»»»» constraints

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» literalRight

body

any

false

none

»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» right

body

any

false

none

»»»»» expressionLeft

body

any

false

none

»»»»» expressionRight

body

any

false

none

»»»»» isPreciseDecimal

body

boolean

false

none

»»»»» like

body

string¦null

false

none

»»»»» escapeWildcards

body

boolean

false

none

»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»» rowVersion

body

integer(int64)

false

none

»»»»» table

body

string¦null

false

none

»»»»» queryDefinitionRight

body

any

false

none

»»»» trueValue

body

any

false

none

»»»» falseValue

body

any

false

none

»»»» isDate

body

boolean

false

none

»»»» literalType

body

string

false

none

»»»» value

body

any

false

none

»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»» isDate

body

boolean

false

none

»»» literalType

body

string

false

none

»»» value

body

any

false

none

» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»» m_namespace

body

string¦null

false

none

»»» name

body

string¦null

false

none

»» query

body

any

false

none

»» alias

body

string¦null

false

none

»» sourceType

body

string

false

none

» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»» joinType

body

string

false

none

»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» constraintType

body

string

false

none

»»» op

body

string¦null

false

none

»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»» caseSensitive

body

boolean

false

none

»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»» isPreciseDecimal

body

boolean

false

none

»»» like

body

string¦null

false

none

»»» escapeWildcards

body

boolean

false

none

»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»» table

body

string¦null

false

none

»»» queryDefinitionRight

body

any

false

none

» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»» table

body

string¦null

false

none

»» column

body

string¦null

false

none

»» direction

body

string

false

none

» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»» table

body

string¦null

false

none

»» column

body

string¦null

false

none

» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

» distinct

body

boolean

false

none

» unionWith

body

any

false

none

» exceptWith

body

any

false

none

Enumerated Values

Parameter

Value

»» dataType

Int

»» dataType

Decimal

»» dataType

DateTime

»» dataType

None

»» dataType

String

»» type

SelectAll

»» type

SelectItem

»» type

SelectLiteral

»» type

SelectCustom

»» type

SelectExpression

»»» expressionType

caseExpression

»»» expressionType

dataField

»»» expressionType

function

»»» expressionType

ifExpression

»»» expressionType

literal

»»»» expressionType

caseExpression

»»»» expressionType

dataField

»»»» expressionType

function

»»»» expressionType

ifExpression

»»»» expressionType

literal

»»»»» constraintType

clause

»»»»» constraintType

constraint

»»»»» constraintType

expressionConstraint

»»»»» constraintType

likeConstraint

»»»»» constraintType

rowVersionConstraint

»»»»» constraintType

subQueryConstraint

»»»»»» expressionType

caseExpression

»»»»»» expressionType

dataField

»»»»»» expressionType

function

»»»»»» expressionType

ifExpression

»»»»»» expressionType

literal

»»»»»» literalType

Integer

»»»»»» literalType

Decimal

»»»»»» literalType

Date

»»»»»» literalType

DateTime

»»»»»» literalType

String

»»»»»» literalType

Float

»»»»»» literalType

Long

»»»»»» literalType

Null

»»»»»» literalType

Parameter

»»»»»» literalType

Guid

»»»»»» literalType

SystemUtcTime

»»»»»» literalType

Boolean

»»»» literalType

Integer

»»»» literalType

Decimal

»»»» literalType

Date

»»»» literalType

DateTime

»»»» literalType

String

»»»» literalType

Float

»»»» literalType

Long

»»»» literalType

Null

»»»» literalType

Parameter

»»»» literalType

Guid

»»»» literalType

SystemUtcTime

»»»» literalType

Boolean

»»» literalType

Integer

»»» literalType

Decimal

»»» literalType

Date

»»» literalType

DateTime

»»» literalType

String

»»» literalType

Float

»»» literalType

Long

»»» literalType

Null

»»» literalType

Parameter

»»» literalType

Guid

»»» literalType

SystemUtcTime

»»» literalType

Boolean

»» sourceType

Table

»» sourceType

Query

»» joinType

Inner

»» joinType

Left

»» joinType

Right

»» joinType

Cross

»» joinType

CrossApply

»» joinType

OuterApply

»»» constraintType

clause

»»» constraintType

constraint

»»» constraintType

expressionConstraint

»»» constraintType

likeConstraint

»»» constraintType

rowVersionConstraint

»»» constraintType

subQueryConstraint

»» direction

Ascending

»» direction

Descending

»» direction

AscendingNullsFirst

»» direction

DescendingNullsLast

Responses

Status

Meaning

Description

Schema

200

OK

Get data for a transform item change after applying restriction changes

Varicent.RESTAPI.v1.DTOs.ResultSetDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/workspaces2/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes/{changeId}/previewTransformRestriction", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workspaces2/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes/{changeId}/previewTransformRestriction");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "selectItems": [
    {
      "alias": "string",
      "column": "string",
      "table": "string",
      "customSelect": "string",
      "dataType": "Int",
      "type": "SelectAll",
      "value": {}
    }
  ],
  "source": {
    "namespaceTable": {
      "m_namespace": "string",
      "name": "string"
    },
    "query": null,
    "alias": "string",
    "sourceType": "Table"
  },
  "joins": [
    {
      "source": {},
      "joinType": "Inner",
      "onClause": {}
    }
  ],
  "whereClause": {
    "constraintType": "clause",
    "op": "string",
    "dataFieldLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "caseSensitive": true,
    "constraints": [
      {}
    ],
    "literalRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "dataFieldRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "right": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "isPreciseDecimal": true,
    "like": "string",
    "escapeWildcards": true,
    "rowVersion": {
      "rowVersion": 0
    },
    "table": "string",
    "queryDefinitionRight": null
  },
  "order": [
    {
      "table": "string",
      "column": "string",
      "direction": "Ascending"
    }
  ],
  "group": [
    {
      "table": "string",
      "column": "string"
    }
  ],
  "havingClause": {
    "constraintType": "clause",
    "op": "string",
    "dataFieldLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "caseSensitive": true,
    "constraints": [
      {}
    ],
    "literalRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "dataFieldRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "right": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "isPreciseDecimal": true,
    "like": "string",
    "escapeWildcards": true,
    "rowVersion": {
      "rowVersion": 0
    },
    "table": "string",
    "queryDefinitionRight": null
  },
  "distinct": true,
  "unionWith": null,
  "exceptWith": null
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workspaces2/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes/{changeId}/previewTransformRestriction',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/workspaces2/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes/{changeId}/previewTransformRestriction', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/workspaces2/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes/{changeId}/previewTransformRestriction',
  params: {
  }, headers: headers

p JSON.parse(result)

Gets data for a scenario item with the given itemId after applying all changes up to and including the change set with the given changeId

Parameters

Name

In

Type

Required

Description

workspaceId

path

integer(int32)

true

Workspace ID

scenarioId

path

integer(int32)

true

Scenario ID

itemId

path

integer(int32)

true

Scenario Item ID

changeId

path

integer(int32)

true

none

offset

query

integer(int32)

false

none

limit

query

integer(int32)

false

none

orderBy

query

string

false

none

filter

query

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Returned data for a scenario item with the given itemId after applying all changes up to and including the change set with the given changeId

Varicent.RESTAPI.v1.DTOs.ResultSetDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/workspaces2/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes/{changeId}/previewTransform", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workspaces2/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes/{changeId}/previewTransform");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workspaces2/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes/{changeId}/previewTransform',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/workspaces2/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes/{changeId}/previewTransform', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/workspaces2/{workspaceId}/scenarios/{scenarioId}/items/{itemId}/changes/{changeId}/previewTransform',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "columnDefinitions": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "data": [
    null
  ],
  "columnSourceMap": {
    "property1": "string",
    "property2": "string"
  },
  "isDataSynced": true,
  "hierarchyMetadata": {
    "tableName": "string",
    "idColumnName": "string",
    "parentColumnName": "string"
  }
}
{"columnDefinitions":[{"name":"string","type":"String","isKey":true,"nullable":true,"values":"string","lockedPeriod":{},"referencedCol":"string","picklistFilter":"string","displayName":"string","isELTPeriod":true}],"data":[null],"columnSourceMap":{"property1":"string","property2":"string"},"isDataSynced":true,"hierarchyMetadata":{"tableName":"string","idColumnName":"string","parentColumnName":"string"}}

Promotes scenario with given workspace and scenario IDs.

Parameters

Name

In

Type

Required

Description

workspaceId

path

integer(int32)

true

none

scenarioId

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Scenario promoted successfully.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/workspaces/{workspaceId}/scenarios/{scenarioId}/promote", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/workspaces/{workspaceId}/scenarios/{scenarioId}/promote");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/rpc/workspaces/{workspaceId}/scenarios/{scenarioId}/promote',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/v1/rpc/workspaces/{workspaceId}/scenarios/{scenarioId}/promote')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/v1/rpc/workspaces/{workspaceId}/scenarios/{scenarioId}/promote',
  params: {
  }

p JSON.parse(result)

Creates a new scenario given a scenario definition.

Body parameter

{
  "id": 0,
  "workspaceId": 0,
  "name": "string",
  "description": "string",
  "scenarioItems": {
    "href": "string"
  },
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

workspaceId

path

integer(int32)

true

Workspace ID where the scenario will reside.

body

body

Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioDTO

false

Scenario definition. The “scenarioItems” field should be omitted.

» id

body

integer(int32)

false

none

» workspaceId

body

integer(int32)

false

none

» name

body

string¦null

false

none

» description

body

string¦null

false

none

» scenarioItems

body

Varicent.RESTAPI.v1.DTOs.ExpandableResourceDTO

false

none

»» href

body

string¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioDTO

404

Not Found

Unable to find workspace with specified ID

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "workspaceId": 0,
  "name": "string",
  "description": "string",
  "scenarioItems": {
    "href": "string"
  },
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "workspaceId": 0,
  "name": "string",
  "description": "string",
  "scenarioItems": {
    "href": "string"
  },
  "version": {
    "rowVersion": 0
  }
}
{"id":0,"workspaceId":0,"name":"string","description":"string","scenarioItems":{"href":"string"},"version":{"rowVersion":0}}

Retrieve all the scenarios in a given workspace.

Parameters

Name

In

Type

Required

Description

workspaceId

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

404

Not Found

The workspace ID specified was not found.

None

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioDTO]

false

none

none

» id

integer(int32)

false

none

none

» workspaceId

integer(int32)

false

none

none

» name

string¦null

false

none

none

» description

string¦null

false

none

none

» scenarioItems

Varicent.RESTAPI.v1.DTOs.ExpandableResourceDTO

false

none

none

»» href

string¦null

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "workspaceId": 0,
    "name": "string",
    "description": "string",
    "scenarioItems": {
      "href": "string"
    },
    "version": {
      "rowVersion": 0
    }
  }
]
[{"id":0,"workspaceId":0,"name":"string","description":"string","scenarioItems":{"href":"string"},"version":{"rowVersion":0}}]

Retrieve a single scenario.

Parameters

Name

In

Type

Required

Description

workspaceId

path

integer(int32)

true

ID of the workspace the scenario belongs to

scenarioId

path

integer(int32)

true

ID of the scenario

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioDTO

404

Not Found

The workspace or the scenario ID specified was not found.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "workspaceId": 0,
  "name": "string",
  "description": "string",
  "scenarioItems": {
    "href": "string"
  },
  "version": {
    "rowVersion": 0
  }
}
{"id":0,"workspaceId":0,"name":"string","description":"string","scenarioItems":{"href":"string"},"version":{"rowVersion":0}}

Deletes a scenario.

Parameters

Name

In

Type

Required

Description

workspaceId

path

integer(int32)

true

none

scenarioId

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

204

No Content

Scenario has been deleted successfully

None

404

Not Found

The workspace ID or scenario ID specified was not found.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}',
  params: {
  }

p JSON.parse(result)

Updates an existing scenario.

Body parameter

{
  "id": 0,
  "workspaceId": 0,
  "name": "string",
  "description": "string",
  "scenarioItems": {
    "href": "string"
  },
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

workspaceId

path

integer(int32)

true

Workspace in which the scenario to update is in.

scenarioId

path

integer(int32)

true

Scenario ID to update.

body

body

Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioDTO

false

Updated scenario.

» id

body

integer(int32)

false

none

» workspaceId

body

integer(int32)

false

none

» name

body

string¦null

false

none

» description

body

string¦null

false

none

» scenarioItems

body

Varicent.RESTAPI.v1.DTOs.ExpandableResourceDTO

false

none

»» href

body

string¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioDTO

404

Not Found

The workspace or scenario ID specified was not found.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "workspaceId": 0,
  "name": "string",
  "description": "string",
  "scenarioItems": {
    "href": "string"
  },
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/workspaces/{workspaceId}/scenarios/{scenarioId}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "workspaceId": 0,
  "name": "string",
  "description": "string",
  "scenarioItems": {
    "href": "string"
  },
  "version": {
    "rowVersion": 0
  }
}
{"id":0,"workspaceId":0,"name":"string","description":"string","scenarioItems":{"href":"string"},"version":{"rowVersion":0}}

Get scenario workspaces.

Responses

Status

Meaning

Description

Schema

201

Created

Get a scenario workspace

Inline

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioWorkspaceNameDTO]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» description

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workspaces", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workspaces");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workspaces',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/workspaces', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/workspaces',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "name": "string",
    "description": "string"
  }
]
[{"id":0,"name":"string","description":"string"}]

Create a new scenario workspace.

Body parameter

{
  "id": 0,
  "isBaseCalculated": true,
  "name": "string",
  "description": "string",
  "owner": "string",
  "accessibilityType": "Private",
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "scenarios": {
    "href": "string"
  },
  "scenarioCalcs": [
    {
      "id": 0,
      "elementId": 0,
      "calculationId": 0,
      "payeeGroupId": "string"
    }
  ],
  "calendarPeriodRanges": [
    {
      "timeId": "string",
      "startPeriod": "string",
      "endPeriod": "string"
    }
  ],
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioWorkspaceDTO

false

Scenario workspace definition. The outputCalcIds has to be a non-empty

» id

body

integer(int32)

false

none

» isBaseCalculated

body

boolean

false

none

» name

body

string¦null

false

none

» description

body

string¦null

false

none

» owner

body

string¦null

false

none

» accessibilityType

body

string

false

none

» startDate

body

string(date-time)

false

none

» endDate

body

string(date-time)

false

none

» scenarios

body

Varicent.RESTAPI.v1.DTOs.ExpandableResourceDTO

false

none

»» href

body

string¦null

false

none

» scenarioCalcs

body

[Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioCalculationDTO]¦null

false

none

»» id

body

integer(int32)

false

none

»» elementId

body

integer(int32)

false

none

»» calculationId

body

integer(int32)

false

none

»» payeeGroupId

body

string¦null

false

none

» calendarPeriodRanges

body

[Varicent.RESTAPI.v1.DTOs.Scenarios.SimpleCalendarPeriodRangeDTO]¦null

false

none

»» timeId

body

string¦null

false

none

»» startPeriod

body

string¦null

false

none

»» endPeriod

body

string¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Detailed descriptions

body: Scenario workspace definition. The outputCalcIds has to be a non-empty array of earnings calculations. An earnings calculation is any user-defined calculation that consists of Payee_.PayeeID_ reference column, a Time reference column (eg. a time partition) and a numeric value column

Enumerated Values

Parameter

Value

» accessibilityType

Private

» accessibilityType

Public

Responses

Status

Meaning

Description

Schema

201

Created

Created

Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioWorkspaceDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/workspaces", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workspaces");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "isBaseCalculated": true,
  "name": "string",
  "description": "string",
  "owner": "string",
  "accessibilityType": "Private",
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "scenarios": {
    "href": "string"
  },
  "scenarioCalcs": [
    {
      "id": 0,
      "elementId": 0,
      "calculationId": 0,
      "payeeGroupId": "string"
    }
  ],
  "calendarPeriodRanges": [
    {
      "timeId": "string",
      "startPeriod": "string",
      "endPeriod": "string"
    }
  ],
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workspaces',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/workspaces', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/workspaces',
  params: {
  }, headers: headers

p JSON.parse(result)

Get a scenario workspace given it’s unique Id.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Unique Id

Responses

Status

Meaning

Description

Schema

200

OK

Get a scenario workspace

Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioWorkspaceDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/workspaces/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workspaces/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workspaces/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/workspaces/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/workspaces/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "isBaseCalculated": true,
  "name": "string",
  "description": "string",
  "owner": "string",
  "accessibilityType": "Private",
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "scenarios": {
    "href": "string"
  },
  "scenarioCalcs": [
    {
      "id": 0,
      "elementId": 0,
      "calculationId": 0,
      "payeeGroupId": "string"
    }
  ],
  "calendarPeriodRanges": [
    {
      "timeId": "string",
      "startPeriod": "string",
      "endPeriod": "string"
    }
  ],
  "version": {
    "rowVersion": 0
  }
}
{"id":0,"isBaseCalculated":true,"name":"string","description":"string","owner":"string","accessibilityType":"Private","startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","scenarios":{"href":"string"},"scenarioCalcs":[{"id":0,"elementId":0,"calculationId":0,"payeeGroupId":"string"}],"calendarPeriodRanges":[{"timeId":"string","startPeriod":"string","endPeriod":"string"}],"version":{"rowVersion":0}}

Delete a given scenario workspace.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Unique Id

Responses

Status

Meaning

Description

Schema

204

No Content

Get a scenario workspace

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/workspaces/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workspaces/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/workspaces/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/workspaces/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/workspaces/{id}',
  params: {
  }

p JSON.parse(result)

Updates Scenario Workspace properties for the given Workspace ID.

Body parameter

{
  "name": "string",
  "description": "string",
  "accessType": "Private",
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Scenario Workspace ID

body

body

Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioWorkspacePatchDTO

false

“name” is the updated Workspace name.

» name

body

string¦null

false

none

» description

body

string¦null

false

none

» accessType

body

string¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Detailed descriptions

body: “name” is the updated Workspace name. “description” is the updated Workspace description. “accessType” is the updated Workspace access type. Values can be either “public” or “private”.

Enumerated Values

Parameter

Value

» accessType

Private

» accessType

Public

Responses

Status

Meaning

Description

Schema

200

OK

Updating Scenario Workspace has been successful.

Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioWorkspaceDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/workspaces/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workspaces/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "name": "string",
  "description": "string",
  "accessType": "Private",
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/workspaces/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/workspaces/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/workspaces/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

Returns a report that compares the earnings values from two scenarios.

Two report types are available: “Payee Comparison” compares values for each payee, across all periods or in a specified period; “Period Comparison” compares total values for each period, across all payees, or for a specific payee.

Body parameter

{
  "reportType": "PeriodComparison",
  "baseScenarioID": 0,
  "targetScenarioID": 0,
  "selectedPeriod": "string",
  "selectedScenarioCalc": 0,
  "selectedPayee": "string"
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

ID of the workspace

body

body

Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioReportRequestDTO

false

When specifying scenario IDs, -1 denotes the “(Base)” scenario (as in ICM 9)

» reportType

body

string

false

none

» baseScenarioID

body

integer(int32)

false

none

» targetScenarioID

body

integer(int32)

false

none

» selectedPeriod

body

string¦null

false

none

» selectedScenarioCalc

body

integer(int32)

false

none

» selectedPayee

body

string¦null

false

none

Enumerated Values

Parameter

Value

» reportType

PeriodComparison

» reportType

PayeeComparison

Responses

Status

Meaning

Description

Schema

200

OK

Each item in the response array will also contain either a “payee” field with the PayeeID for Payee Comparison report, or a “period” field with the period name for Period Comparison report

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioReportItemDTO]

false

none

none

» baseEarnings

number(double)

false

none

none

» scenarioEarnings

number(double)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/workspaces/{id}/report", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/workspaces/{id}/report");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "reportType": "PeriodComparison",
  "baseScenarioID": 0,
  "targetScenarioID": 0,
  "selectedPeriod": "string",
  "selectedScenarioCalc": 0,
  "selectedPayee": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/workspaces/{id}/report',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/workspaces/{id}/report', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/workspaces/{id}/report',
  params: {
  }, headers: headers

p JSON.parse(result)

Administration

Get table names for purge history.

Responses

Status

Meaning

Description

Schema

200

OK

Insert data to the given table

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/getpurgehistorytables", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/getpurgehistorytables");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/getpurgehistorytables',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/getpurgehistorytables', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/getpurgehistorytables',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  "string"
]
["string"]

Purge history.

Body parameter

{
  "timeID": "string",
  "period": "string",
  "mode": "CalcOnly",
  "includeDownstream": true,
  "selectedTables": [
    "string"
  ],
  "selectedCalculations": [
    0
  ]
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Administration.PurgePeriodsDTO

false

Table list and end date

» timeID

body

string¦null

false

none

» period

body

string¦null

false

none

» mode

body

string

false

none

» includeDownstream

body

boolean

false

none

» selectedTables

body

[string]¦null

false

none

» selectedCalculations

body

[integer]¦null

false

none

Enumerated Values

Parameter

Value

» mode

CalcOnly

» mode

TableOnly

» mode

CalcAndTable

» mode

SelectedTables

» mode

SelectedCalculations

Responses

Status

Meaning

Description

Schema

202

Accepted

Begin the purge period task

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/purgeperiods", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/purgeperiods");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "timeID": "string",
  "period": "string",
  "mode": "CalcOnly",
  "includeDownstream": true,
  "selectedTables": [
    "string"
  ],
  "selectedCalculations": [
    0
  ]
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/purgeperiods',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/purgeperiods', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/purgeperiods',
  params: {
  }, headers: headers

p JSON.parse(result)

Purge periods preview.

Body parameter

{
  "timeID": "string",
  "period": "string",
  "mode": "CalcOnly",
  "includeDownstream": true,
  "selectedTables": [
    "string"
  ],
  "selectedCalculations": [
    0
  ]
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Administration.PurgePeriodsDTO

false

Table list and end date

» timeID

body

string¦null

false

none

» period

body

string¦null

false

none

» mode

body

string

false

none

» includeDownstream

body

boolean

false

none

» selectedTables

body

[string]¦null

false

none

» selectedCalculations

body

[integer]¦null

false

none

Enumerated Values

Parameter

Value

» mode

CalcOnly

» mode

TableOnly

» mode

CalcAndTable

» mode

SelectedTables

» mode

SelectedCalculations

Responses

Status

Meaning

Description

Schema

202

Accepted

Preview what Tables and Calcs will be purged by this request

RESTAPI.v1.DTOs.Administration.PurgePeriodsDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/purgeperiods/preview", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/purgeperiods/preview");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "timeID": "string",
  "period": "string",
  "mode": "CalcOnly",
  "includeDownstream": true,
  "selectedTables": [
    "string"
  ],
  "selectedCalculations": [
    0
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/purgeperiods/preview',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/purgeperiods/preview', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/purgeperiods/preview',
  params: {
  }, headers: headers

p JSON.parse(result)

Get make effective dated table.

Responses

Status

Meaning

Description

Schema

200

OK

Get available tables

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.TableDefinitionDTO]

false

none

none

» table

Varicent.RESTAPI.v1.DTOs.CustomTableDTO

false

none

none

»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»» rowVersion

integer(int64)

false

none

none

»» name

string¦null

false

none

none

»» tableType

string

false

none

none

»» effectiveDated

boolean

false

none

none

»» workflowObjectID

integer(int32)

false

none

none

»» hierarchyMetadata

RESTAPI.v1.DTOs.Hierarchy.HierarchyMetadataDTO

false

none

none

»»» tableName

string¦null

false

none

none

»»» idColumnName

string¦null

false

none

none

»»» parentColumnName

string¦null

false

none

none

»» lastUpdatedTracking

boolean¦null

false

none

none

» columns

[Varicent.RESTAPI.v1.DTOs.ColumnDefinitionDTO]¦null

false

none

none

»» column

Varicent.RESTAPI.v1.DTOs.CustomColumnDTO

false

none

none

»»» name

string¦null

false

none

none

»»» type

string

false

none

none

»»» referencedTable

string¦null

false

none

none

»»» referencedName

string¦null

false

none

none

»»» source

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

»»»» query

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

»»»»» selectItems

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

none

»»»»»» alias

string¦null

false

none

none

»»»»»» column

string¦null

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» customSelect

string¦null

false

none

none

»»»»»» dataType

string

false

none

none

»»»»»» type

string

false

none

none

»»»»»» value

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»»»» expressionType

string

false

none

none

»»»»»»» cases

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» column

string¦null

false

none

none

»»»»»»» op

string¦null

false

none

none

»»»»»»» arguments

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

none

[DTO version of IExpression]

»»»»»»»» expressionType

string

false

none

none

»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» table

string¦null

false

none

none

»»»»»»»» column

string¦null

false

none

none

»»»»»»»» op

string¦null

false

none

none

»»»»»»»» arguments

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»»»»» constraintType

string

false

none

none

»»»»»»»»» op

string¦null

false

none

none

»»»»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»»»» expressionType

string

false

none

none

»»»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»»» table

string¦null

false

none

none

»»»»»»»»»» column

string¦null

false

none

none

»»»»»»»»»» op

string¦null

false

none

none

»»»»»»»»»» arguments

array¦null

false

none

none

»»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»»» condition

any

false

none

none

»»»»»»»»»» trueValue

any

false

none

none

»»»»»»»»»» falseValue

any

false

none

none

»»»»»»»»»» isDate

boolean

false

none

none

»»»»»»»»»» literalType

string

false

none

none

»»»»»»»»»» value

any

false

none

none

»»»»»»»»» caseSensitive

boolean

false

none

none

»»»»»»»»» constraints

array¦null

false

none

none

»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»» literalRight

any

false

none

none

»»»»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»»» right

any

false

none

none

»»»»»»»»» expressionLeft

any

false

none

none

»»»»»»»»» expressionRight

any

false

none

none

»»»»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»»»»» like

string¦null

false

none

none

»»»»»»»»» escapeWildcards

boolean

false

none

none

»»»»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»»»» table

string¦null

false

none

none

»»»»»»»»» queryDefinitionRight

any

false

none

none

»»»»»»»» trueValue

any

false

none

none

»»»»»»»» falseValue

any

false

none

none

»»»»»»»» isDate

boolean

false

none

none

»»»»»»»» literalType

string

false

none

none

»»»»»»»» value

any

false

none

none

»»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»»» trueValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»» falseValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»» isDate

boolean

false

none

none

»»»»»»» literalType

string

false

none

none

»»»»»»» value

any

false

none

none

»»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»»»» namespaceTable

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

none

»»»»»»» m_namespace

string¦null

false

none

none

»»»»»»» name

string¦null

false

none

none

»»»»»» query

any

false

none

none

»»»»»» alias

string¦null

false

none

none

»»»»»» sourceType

string

false

none

none

»»»»» joins

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

none

»»»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»»»» joinType

string

false

none

none

»»»»»» onClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»»»» constraintType

string

false

none

none

»»»»»»» op

string¦null

false

none

none

»»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»» caseSensitive

boolean

false

none

none

»»»»»»» constraints

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

none

[DTO version of IConstraint]

»»»»»»» literalRight

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»» right

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»» expressionLeft

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»» expressionRight

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»»» like

string¦null

false

none

none

»»»»»»» escapeWildcards

boolean

false

none

none

»»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» queryDefinitionRight

any

false

none

none

»»»»» whereClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»» order

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» column

string¦null

false

none

none

»»»»»» direction

string

false

none

none

»»»»» group

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» column

string¦null

false

none

none

»»»»» havingClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»» distinct

boolean

false

none

none

»»»»» unionWith

any

false

none

none

»»»»» exceptWith

any

false

none

none

»»»» sourceNames

object¦null

false

none

none

»»»»» additionalProperties

string¦null

false

none

none

»»» pickListParams

[Varicent.RESTAPI.v1.DTOs.PickListParamDTO]¦null

false

none

none

»»»» joinAlias

string¦null

false

none

none

»»»» joinColumn

string¦null

false

none

none

»»»» op

string

false

none

none

»»» isKey

boolean

false

none

none

»» isRemovable

boolean

false

none

none

»» isNullable

boolean

false

none

none

»» referencedColumn

string¦null

false

none

none

» time

Varicent.RESTAPI.v1.DTOs.TableTimeDTO

false

none

none

»» timeId

string¦null

false

none

none

»» dateColumn

string¦null

false

none

none

»» lockedOn

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

»» min

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

»» max

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

Enumerated Values

Property

Value

tableType

System

tableType

Dimension

tableType

Structural

tableType

Lookup

tableType

Data

tableType

View

tableType

Custom

tableType

StarSchema

tableType

ExportTable

tableType

CreditingRule

tableType

AssignTable

tableType

PlcmCustomTable

tableType

PlcmStructuralTable

tableType

PlcmTable

tableType

DataSource

tableType

Cached

tableType

MaterializedView

type

Text

type

Date

type

List

type

Numeric

type

Email

type

Url

type

Comment

type

DateTime

dataType

Int

dataType

Decimal

dataType

DateTime

dataType

None

dataType

String

type

SelectAll

type

SelectItem

type

SelectLiteral

type

SelectCustom

type

SelectExpression

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

sourceType

Table

sourceType

Query

joinType

Inner

joinType

Left

joinType

Right

joinType

Cross

joinType

CrossApply

joinType

OuterApply

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

direction

Ascending

direction

Descending

direction

AscendingNullsFirst

direction

DescendingNullsLast

op

LessThan

op

LessThanEquals

op

Equals

op

NotEquals

op

GreaterThan

op

GreaterThanEquals

op

IsNull

op

IsNotNull

op

In

op

NotIn

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/getavailabletables", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/getavailabletables");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/getavailabletables',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/getavailabletables', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/getavailabletables',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "table": {
      "version": {},
      "name": "string",
      "tableType": "System",
      "effectiveDated": true,
      "workflowObjectID": 0,
      "hierarchyMetadata": {},
      "lastUpdatedTracking": true
    },
    "columns": [
      {}
    ],
    "time": {
      "timeId": "string",
      "dateColumn": "string",
      "lockedOn": {},
      "min": {},
      "max": {}
    }
  }
]
[{"table":{"version":{},"name":"string","tableType":"System","effectiveDated":true,"workflowObjectID":0,"hierarchyMetadata":{},"lastUpdatedTracking":true},"columns":[{}],"time":{"timeId":"string","dateColumn":"string","lockedOn":{},"min":{},"max":{}}}]

Make a table effective dated.

Body parameter

[
  {
    "tableName": "string",
    "startCol": "string",
    "endCol": "string",
    "removeMapped": true
  }
]

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Administration.EffectiveDateConvertPropertiesDTO

false

Tables to be made effective dated

Responses

Status

Meaning

Description

Schema

202

Accepted

Make selected table effective dated

Inline

Response Schema

Status Code 202

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/makeeffectivedated", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/makeeffectivedated");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "tableName": "string",
    "startCol": "string",
    "endCol": "string",
    "removeMapped": true
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/makeeffectivedated',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/makeeffectivedated', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/makeeffectivedated',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "property1": "string",
  "property2": "string"
}
{"property1":"string","property2":"string"}

Document

Get all documents.

Parameters

Name

In

Type

Required

Description

orderBy

query

string

false

####Description

Detailed descriptions

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

name, ext, date

Responses

Status

Meaning

Description

Schema

200

OK

Get all documents

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.DocumentDTO]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» date

string(date-time)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/documents", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/documents");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/documents',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/documents', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/documents',
  params: {
  }, headers: headers

p JSON.parse(result)

Add a document.

The file name and file content will be stored in the body of the request. The file content is base 64 string format.

Body parameter

{
  "name": "string",
  "content": "string",
  "portalTreeName": "string",
  "token": "string",
  "generateToken": true,
  "payeeID": "string"
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.PayeeDocumentUploadDTO

false

none

» name

body

string¦null

false

none

» content

body

string¦null

false

none

» portalTreeName

body

string¦null

false

none

» token

body

string¦null

false

none

» generateToken

body

boolean

false

none

» payeeID

body

string¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Add a document

Varicent.RESTAPI.v1.DTOs.PayeeDocumentDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/payee/tsapi/payeeDocuments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payee/tsapi/payeeDocuments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "name": "string",
  "content": "string",
  "portalTreeName": "string",
  "token": "string",
  "generateToken": true,
  "payeeID": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/payee/tsapi/payeeDocuments',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/payee/tsapi/payeeDocuments', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/payee/tsapi/payeeDocuments',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "created": "2019-08-24T14:15:22Z",
  "treeName": "string",
  "payeeID": "string",
  "token": "string"
}
{"id":0,"name":"string","created":"2019-08-24T14:15:22Z","treeName":"string","payeeID":"string","token":"string"}

Download a document by ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Document ID

Responses

Status

Meaning

Description

Schema

200

OK

Download document by id

Varicent.RESTAPI.v1.DTOs.FileContentDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/documents/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/documents/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/documents/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/documents/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/documents/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "filename": "string",
  "data64": "string"
}
{"filename":"string","data64":"string"}

Delete a document by ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Document Id

Responses

Status

Meaning

Description

Schema

200

OK

Delete document by id

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/documents/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/documents/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/documents/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/documents/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/documents/{id}',
  params: {
  }

p JSON.parse(result)

Get all documents with pagination.

Parameters

Name

In

Type

Required

Description

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

orderBy

query

string

false

####Description

filter

query

string

false

####Supported operations

trees

query

string

false

none

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

name, ext, date

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

Any column

Responses

Status

Meaning

Description

Schema

200

OK

Get all documents

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.ResultSetDTO]

false

none

none

» columnDefinitions

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

none

»» name

string¦null

false

none

none

»» type

string

false

none

none

»» isKey

boolean

false

none

none

»» nullable

boolean

false

none

none

»» values

string¦null

false

none

none

»» lockedPeriod

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

none

»»» start

string(date-time)

false

none

none

»»» end

string(date-time)

false

none

none

»» referencedCol

string¦null

false

none

none

»» picklistFilter

string¦null

false

none

none

»» displayName

string¦null

false

none

none

»» isELTPeriod

boolean¦null

false

none

none

» data

[any]¦null

false

none

none

» columnSourceMap

object¦null

false

none

none

»» additionalProperties

string¦null

false

none

none

» isDataSynced

boolean¦null

false

none

none

» hierarchyMetadata

RESTAPI.v1.DTOs.Hierarchy.HierarchyMetadataDTO

false

none

none

»» tableName

string¦null

false

none

none

»» idColumnName

string¦null

false

none

none

»» parentColumnName

string¦null

false

none

none

Enumerated Values

Property

Value

type

String

type

LongString

type

MaxString

type

Date

type

DateTime

type

Decimal

type

Int

type

Long

type

Float

type

BLOB

type

Identity

type

CLOB

type

RowVersion

type

UID

type

VarCharMax

type

Boolean

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/payeeDocuments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payeeDocuments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/payeeDocuments',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/payeeDocuments', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/payeeDocuments',
  params: {
  }, headers: headers

p JSON.parse(result)

Delete a document.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Delete a document

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/payeeDocuments/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payeeDocuments/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/payeeDocuments/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/payeeDocuments/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/payeeDocuments/{id}',
  params: {
  }

p JSON.parse(result)

PortalAccess

Get tree assignments.

Parameters

Name

In

Type

Required

Description

filter

query

string

false

####Supported operations

includeDrafts

query

boolean

false

none

Detailed descriptions

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

Any column

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/portalaccess/assignment", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/portalaccess/assignment");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/portalaccess/assignment',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.get('http://localhost:8080/api/v1/portalaccess/assignment')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.get 'http://localhost:8080/api/v1/portalaccess/assignment',
  params: {
  }

p JSON.parse(result)

Update tree assignments.

Body parameter

{
  "name": "string",
  "accessTreeID": 0,
  "signoffTreeID": 0,
  "inquiryTreeID": 0,
  "parentID": 0,
  "prevID": 0,
  "workflowObjectID": 0,
  "inquiryWorkflowID": 0,
  "objectId": "string",
  "type": "Data"
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.PortalAccess.PortalAccessAssignmentDTO

false

none

» name

body

string¦null

false

none

» accessTreeID

body

integer(int32)¦null

false

none

» signoffTreeID

body

integer(int32)¦null

false

none

» inquiryTreeID

body

integer(int32)¦null

false

none

» parentID

body

integer(int32)¦null

false

none

» prevID

body

integer(int32)¦null

false

none

» workflowObjectID

body

integer(int32)¦null

false

none

» inquiryWorkflowID

body

integer(int32)¦null

false

none

» objectId

body

string¦null

false

none

» type

body

string

false

none

Enumerated Values

Parameter

Value

» type

Data

» type

CompensationPlan

» type

TailoredReport

» type

Document

» type

WebForm

» type

WebReport

» type

WebTab

» type

CompPlanManager

» type

WebTabGroup

» type

ExternalURL

» type

RapidReport

» type

Table

» type

DataStore

» type

DDE

» type

DDEInfographic

» type

PayeeDocument

» type

PresenterAdaptive

» type

DirectLink

» type

AdaptiveForm

» type

StandardReport

» type

SalesPlanningMap

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/portalaccess/assignment", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/portalaccess/assignment");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "name": "string",
  "accessTreeID": 0,
  "signoffTreeID": 0,
  "inquiryTreeID": 0,
  "parentID": 0,
  "prevID": 0,
  "workflowObjectID": 0,
  "inquiryWorkflowID": 0,
  "objectId": "string",
  "type": "Data"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/portalaccess/assignment',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/portalaccess/assignment', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/portalaccess/assignment',
  params: {
  }, headers: headers

p JSON.parse(result)

validate a tree assignment.

Body parameter

{
  "name": "string",
  "accessTreeID": 0,
  "signoffTreeID": 0,
  "inquiryTreeID": 0,
  "parentID": 0,
  "prevID": 0,
  "workflowObjectID": 0,
  "inquiryWorkflowID": 0,
  "objectId": "string",
  "type": "Data"
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.PortalAccess.PortalAccessAssignmentDTO

false

none

» name

body

string¦null

false

none

» accessTreeID

body

integer(int32)¦null

false

none

» signoffTreeID

body

integer(int32)¦null

false

none

» inquiryTreeID

body

integer(int32)¦null

false

none

» parentID

body

integer(int32)¦null

false

none

» prevID

body

integer(int32)¦null

false

none

» workflowObjectID

body

integer(int32)¦null

false

none

» inquiryWorkflowID

body

integer(int32)¦null

false

none

» objectId

body

string¦null

false

none

» type

body

string

false

none

Enumerated Values

Parameter

Value

» type

Data

» type

CompensationPlan

» type

TailoredReport

» type

Document

» type

WebForm

» type

WebReport

» type

WebTab

» type

CompPlanManager

» type

WebTabGroup

» type

ExternalURL

» type

RapidReport

» type

Table

» type

DataStore

» type

DDE

» type

DDEInfographic

» type

PayeeDocument

» type

PresenterAdaptive

» type

DirectLink

» type

AdaptiveForm

» type

StandardReport

» type

SalesPlanningMap

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/portalaccess/assignment/validate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/portalaccess/assignment/validate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "name": "string",
  "accessTreeID": 0,
  "signoffTreeID": 0,
  "inquiryTreeID": 0,
  "parentID": 0,
  "prevID": 0,
  "workflowObjectID": 0,
  "inquiryWorkflowID": 0,
  "objectId": "string",
  "type": "Data"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/portalaccess/assignment/validate',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/portalaccess/assignment/validate', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/portalaccess/assignment/validate',
  params: {
  }, headers: headers

p JSON.parse(result)

Notify a portal access tree.

Body parameter

{
  "name": "string",
  "accessTreeID": 0,
  "signoffTreeID": 0,
  "inquiryTreeID": 0,
  "parentID": 0,
  "prevID": 0,
  "workflowObjectID": 0,
  "inquiryWorkflowID": 0,
  "objectId": "string",
  "type": "Data"
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.PortalAccess.PortalAccessAssignmentDTO

false

none

» name

body

string¦null

false

none

» accessTreeID

body

integer(int32)¦null

false

none

» signoffTreeID

body

integer(int32)¦null

false

none

» inquiryTreeID

body

integer(int32)¦null

false

none

» parentID

body

integer(int32)¦null

false

none

» prevID

body

integer(int32)¦null

false

none

» workflowObjectID

body

integer(int32)¦null

false

none

» inquiryWorkflowID

body

integer(int32)¦null

false

none

» objectId

body

string¦null

false

none

» type

body

string

false

none

Enumerated Values

Parameter

Value

» type

Data

» type

CompensationPlan

» type

TailoredReport

» type

Document

» type

WebForm

» type

WebReport

» type

WebTab

» type

CompPlanManager

» type

WebTabGroup

» type

ExternalURL

» type

RapidReport

» type

Table

» type

DataStore

» type

DDE

» type

DDEInfographic

» type

PayeeDocument

» type

PresenterAdaptive

» type

DirectLink

» type

AdaptiveForm

» type

StandardReport

» type

SalesPlanningMap

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/portalaccess/assignment/notify", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/portalaccess/assignment/notify");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "name": "string",
  "accessTreeID": 0,
  "signoffTreeID": 0,
  "inquiryTreeID": 0,
  "parentID": 0,
  "prevID": 0,
  "workflowObjectID": 0,
  "inquiryWorkflowID": 0,
  "objectId": "string",
  "type": "Data"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/portalaccess/assignment/notify',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/portalaccess/assignment/notify', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/portalaccess/assignment/notify',
  params: {
  }, headers: headers

p JSON.parse(result)

Get all portal access group names.

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupNameDTO]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/portalaccessgroupnames", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/portalaccessgroupnames");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/portalaccessgroupnames',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/portalaccessgroupnames', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/portalaccessgroupnames',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "name": "string"
  }
]
[{"id":0,"name":"string"}]

Get all portal access groups.

Parameters

Name

In

Type

Required

Description

filter

query

string

false

Filter over Payee Name or ID

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupNodeDTO]

false

none

none

» comment

string¦null

false

none

none

» group

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupDTO

false

none

none

»» definition

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupDefinitionDTO

false

none

none

»»» groupId

integer(int32)

false

none

none

»»» groupName

string¦null

false

none

none

»»» source

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

»»»» query

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

»»»»» selectItems

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

none

»»»»»» alias

string¦null

false

none

none

»»»»»» column

string¦null

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» customSelect

string¦null

false

none

none

»»»»»» dataType

string

false

none

none

»»»»»» type

string

false

none

none

»»»»»» value

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»»»» expressionType

string

false

none

none

»»»»»»» cases

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» column

string¦null

false

none

none

»»»»»»» op

string¦null

false

none

none

»»»»»»» arguments

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

none

[DTO version of IExpression]

»»»»»»»» expressionType

string

false

none

none

»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» table

string¦null

false

none

none

»»»»»»»» column

string¦null

false

none

none

»»»»»»»» op

string¦null

false

none

none

»»»»»»»» arguments

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»»»»» constraintType

string

false

none

none

»»»»»»»»» op

string¦null

false

none

none

»»»»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»»»» expressionType

string

false

none

none

»»»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»»» table

string¦null

false

none

none

»»»»»»»»»» column

string¦null

false

none

none

»»»»»»»»»» op

string¦null

false

none

none

»»»»»»»»»» arguments

array¦null

false

none

none

»»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»»» condition

any

false

none

none

»»»»»»»»»» trueValue

any

false

none

none

»»»»»»»»»» falseValue

any

false

none

none

»»»»»»»»»» isDate

boolean

false

none

none

»»»»»»»»»» literalType

string

false

none

none

»»»»»»»»»» value

any

false

none

none

»»»»»»»»» caseSensitive

boolean

false

none

none

»»»»»»»»» constraints

array¦null

false

none

none

»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»» literalRight

any

false

none

none

»»»»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»»» right

any

false

none

none

»»»»»»»»» expressionLeft

any

false

none

none

»»»»»»»»» expressionRight

any

false

none

none

»»»»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»»»»» like

string¦null

false

none

none

»»»»»»»»» escapeWildcards

boolean

false

none

none

»»»»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»»»»» rowVersion

integer(int64)

false

none

none

»»»»»»»»» table

string¦null

false

none

none

»»»»»»»»» queryDefinitionRight

any

false

none

none

»»»»»»»» trueValue

any

false

none

none

»»»»»»»» falseValue

any

false

none

none

»»»»»»»» isDate

boolean

false

none

none

»»»»»»»» literalType

string

false

none

none

»»»»»»»» value

any

false

none

none

»»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»»» trueValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»» falseValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»» isDate

boolean

false

none

none

»»»»»»» literalType

string

false

none

none

»»»»»»» value

any

false

none

none

»»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»»»» namespaceTable

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

none

»»»»»»» m_namespace

string¦null

false

none

none

»»»»»»» name

string¦null

false

none

none

»»»»»» query

any

false

none

none

»»»»»» alias

string¦null

false

none

none

»»»»»» sourceType

string

false

none

none

»»»»» joins

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

none

»»»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»»»» joinType

string

false

none

none

»»»»»» onClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»»»» constraintType

string

false

none

none

»»»»»»» op

string¦null

false

none

none

»»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»» caseSensitive

boolean

false

none

none

»»»»»»» constraints

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

none

[DTO version of IConstraint]

»»»»»»» literalRight

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»» right

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»» expressionLeft

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»» expressionRight

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»»» like

string¦null

false

none

none

»»»»»»» escapeWildcards

boolean

false

none

none

»»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» queryDefinitionRight

any

false

none

none

»»»»» whereClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»» order

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» column

string¦null

false

none

none

»»»»»» direction

string

false

none

none

»»»»» group

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» column

string¦null

false

none

none

»»»»» havingClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»» distinct

boolean

false

none

none

»»»»» unionWith

any

false

none

none

»»»»» exceptWith

any

false

none

none

»»»» sourceNames

object¦null

false

none

none

»»»»» additionalProperties

string¦null

false

none

none

»» isPasswordExpiryEnabled

boolean

false

none

none

» name

string¦null

false

none

none

» passwordExpiryEnabled

boolean¦null

false

none

none

» type

string

false

none

none

» subtreeGroupCount

integer(int32)

false

none

none

» id

integer(int32)

false

none

none

» parent

integer(int32)¦null

false

none

none

» oldParent

integer(int32)¦null

false

none

none

» prev

integer(int32)¦null

false

none

none

» oldPrev

integer(int32)¦null

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

dataType

Int

dataType

Decimal

dataType

DateTime

dataType

None

dataType

String

type

SelectAll

type

SelectItem

type

SelectLiteral

type

SelectCustom

type

SelectExpression

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

sourceType

Table

sourceType

Query

joinType

Inner

joinType

Left

joinType

Right

joinType

Cross

joinType

CrossApply

joinType

OuterApply

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

direction

Ascending

direction

Descending

direction

AscendingNullsFirst

direction

DescendingNullsLast

type

Group

type

Folder

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/portalaccessgroups", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/portalaccessgroups");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/portalaccessgroups',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/portalaccessgroups', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/portalaccessgroups',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "comment": "string",
    "group": {
      "definition": {},
      "isPasswordExpiryEnabled": true
    },
    "name": "string",
    "passwordExpiryEnabled": true,
    "type": "Group",
    "subtreeGroupCount": 0,
    "id": 0,
    "parent": 0,
    "oldParent": 0,
    "prev": 0,
    "oldPrev": 0,
    "version": {
      "rowVersion": 0
    }
  }
]
[{"comment":"string","group":{"definition":{},"isPasswordExpiryEnabled":true},"name":"string","passwordExpiryEnabled":true,"type":"Group","subtreeGroupCount":0,"id":0,"parent":0,"oldParent":0,"prev":0,"oldPrev":0,"version":{"rowVersion":0}}]

Create a portal access group. Explicit payees to add or delete must be unique within their respective lists.

Body parameter

{
  "workflow": {
    "comment": "string",
    "group": {
      "definition": {},
      "isPasswordExpiryEnabled": true
    },
    "name": "string",
    "passwordExpiryEnabled": true,
    "type": "Group",
    "subtreeGroupCount": 0,
    "id": 0,
    "parent": 0,
    "oldParent": 0,
    "prev": 0,
    "oldPrev": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "maintainGroup": true
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.PortalAccess.CreateWorkflowGroupNodeDTO

false

none

» workflow

body

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupNodeDTO

false

none

»» comment

body

string¦null

false

none

»» group

body

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupDTO

false

none

»»» definition

body

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupDefinitionDTO

false

none

»»»» groupId

body

integer(int32)

false

none

»»»» groupName

body

string¦null

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»»»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»»»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»»»»» alias

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» customSelect

body

string¦null

false

none

»»»»»»» dataType

body

string

false

none

»»»»»»» type

body

string

false

none

»»»»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»»»» constraintType

body

string

false

none

»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»» condition

body

any

false

none

»»»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»»»» literalType

body

string

false

none

»»»»»»»»»»» value

body

any

false

none

»»»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»»»» constraints

body

array¦null

false

none

»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»» literalRight

body

any

false

none

»»»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»» right

body

any

false

none

»»»»»»»»»» expressionLeft

body

any

false

none

»»»»»»»»»» expressionRight

body

any

false

none

»»»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»»»» like

body

string¦null

false

none

»»»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»» literalType

body

string

false

none

»»»»»»»»» value

body

any

false

none

»»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»»»»» m_namespace

body

string¦null

false

none

»»»»»»»» name

body

string¦null

false

none

»»»»»»» query

body

any

false

none

»»»»»»» alias

body

string¦null

false

none

»»»»»»» sourceType

body

string

false

none

»»»»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»»» joinType

body

string

false

none

»»»»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»»»» constraintType

body

string

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»» like

body

string¦null

false

none

»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» direction

body

string

false

none

»»»»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»» distinct

body

boolean

false

none

»»»»»» unionWith

body

any

false

none

»»»»»» exceptWith

body

any

false

none

»»»»» sourceNames

body

object¦null

false

none

»»»»»» additionalProperties

body

string¦null

false

none

»»» isPasswordExpiryEnabled

body

boolean

false

none

»» name

body

string¦null

false

none

»» passwordExpiryEnabled

body

boolean¦null

false

none

»» type

body

string

false

none

»» subtreeGroupCount

body

integer(int32)

false

none

»» id

body

integer(int32)

false

none

»» parent

body

integer(int32)¦null

false

none

»» oldParent

body

integer(int32)¦null

false

none

»» prev

body

integer(int32)¦null

false

none

»» oldPrev

body

integer(int32)¦null

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

» maintainGroup

body

boolean

false

none

Enumerated Values

Parameter

Value

»»»»»»» dataType

Int

»»»»»»» dataType

Decimal

»»»»»»» dataType

DateTime

»»»»»»» dataType

None

»»»»»»» dataType

String

»»»»»»» type

SelectAll

»»»»»»» type

SelectItem

»»»»»»» type

SelectLiteral

»»»»»»» type

SelectCustom

»»»»»»» type

SelectExpression

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»»» expressionType

caseExpression

»»»»»»»»» expressionType

dataField

»»»»»»»»» expressionType

function

»»»»»»»»» expressionType

ifExpression

»»»»»»»»» expressionType

literal

»»»»»»»»»» constraintType

clause

»»»»»»»»»» constraintType

constraint

»»»»»»»»»» constraintType

expressionConstraint

»»»»»»»»»» constraintType

likeConstraint

»»»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»»»» constraintType

subQueryConstraint

»»»»»»»»»»» expressionType

caseExpression

»»»»»»»»»»» expressionType

dataField

»»»»»»»»»»» expressionType

function

»»»»»»»»»»» expressionType

ifExpression

»»»»»»»»»»» expressionType

literal

»»»»»»»»»»» literalType

Integer

»»»»»»»»»»» literalType

Decimal

»»»»»»»»»»» literalType

Date

»»»»»»»»»»» literalType

DateTime

»»»»»»»»»»» literalType

String

»»»»»»»»»»» literalType

Float

»»»»»»»»»»» literalType

Long

»»»»»»»»»»» literalType

Null

»»»»»»»»»»» literalType

Parameter

»»»»»»»»»»» literalType

Guid

»»»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»»»» literalType

Boolean

»»»»»»»»» literalType

Integer

»»»»»»»»» literalType

Decimal

»»»»»»»»» literalType

Date

»»»»»»»»» literalType

DateTime

»»»»»»»»» literalType

String

»»»»»»»»» literalType

Float

»»»»»»»»» literalType

Long

»»»»»»»»» literalType

Null

»»»»»»»»» literalType

Parameter

»»»»»»»»» literalType

Guid

»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»» literalType

Boolean

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»»» sourceType

Table

»»»»»»» sourceType

Query

»»»»»»» joinType

Inner

»»»»»»» joinType

Left

»»»»»»» joinType

Right

»»»»»»» joinType

Cross

»»»»»»» joinType

CrossApply

»»»»»»» joinType

OuterApply

»»»»»»»» constraintType

clause

»»»»»»»» constraintType

constraint

»»»»»»»» constraintType

expressionConstraint

»»»»»»»» constraintType

likeConstraint

»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»» constraintType

subQueryConstraint

»»»»»»» direction

Ascending

»»»»»»» direction

Descending

»»»»»»» direction

AscendingNullsFirst

»»»»»»» direction

DescendingNullsLast

»» type

Group

»» type

Folder

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupNodeDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/portalaccessgroups", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/portalaccessgroups");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "workflow": {
    "comment": "string",
    "group": {
      "definition": {},
      "isPasswordExpiryEnabled": true
    },
    "name": "string",
    "passwordExpiryEnabled": true,
    "type": "Group",
    "subtreeGroupCount": 0,
    "id": 0,
    "parent": 0,
    "oldParent": 0,
    "prev": 0,
    "oldPrev": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "maintainGroup": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/portalaccessgroups',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/portalaccessgroups', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/portalaccessgroups',
  params: {
  }, headers: headers

p JSON.parse(result)

Get all portal access folders.

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupNodeDTO]

false

none

none

» comment

string¦null

false

none

none

» group

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupDTO

false

none

none

»» definition

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupDefinitionDTO

false

none

none

»»» groupId

integer(int32)

false

none

none

»»» groupName

string¦null

false

none

none

»»» source

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

»»»» query

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

»»»»» selectItems

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

none

»»»»»» alias

string¦null

false

none

none

»»»»»» column

string¦null

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» customSelect

string¦null

false

none

none

»»»»»» dataType

string

false

none

none

»»»»»» type

string

false

none

none

»»»»»» value

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»»»» expressionType

string

false

none

none

»»»»»»» cases

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» column

string¦null

false

none

none

»»»»»»» op

string¦null

false

none

none

»»»»»»» arguments

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

none

[DTO version of IExpression]

»»»»»»»» expressionType

string

false

none

none

»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» table

string¦null

false

none

none

»»»»»»»» column

string¦null

false

none

none

»»»»»»»» op

string¦null

false

none

none

»»»»»»»» arguments

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»»»»» constraintType

string

false

none

none

»»»»»»»»» op

string¦null

false

none

none

»»»»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»»»» expressionType

string

false

none

none

»»»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»»» table

string¦null

false

none

none

»»»»»»»»»» column

string¦null

false

none

none

»»»»»»»»»» op

string¦null

false

none

none

»»»»»»»»»» arguments

array¦null

false

none

none

»»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»»» condition

any

false

none

none

»»»»»»»»»» trueValue

any

false

none

none

»»»»»»»»»» falseValue

any

false

none

none

»»»»»»»»»» isDate

boolean

false

none

none

»»»»»»»»»» literalType

string

false

none

none

»»»»»»»»»» value

any

false

none

none

»»»»»»»»» caseSensitive

boolean

false

none

none

»»»»»»»»» constraints

array¦null

false

none

none

»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»» literalRight

any

false

none

none

»»»»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»»» right

any

false

none

none

»»»»»»»»» expressionLeft

any

false

none

none

»»»»»»»»» expressionRight

any

false

none

none

»»»»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»»»»» like

string¦null

false

none

none

»»»»»»»»» escapeWildcards

boolean

false

none

none

»»»»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»»»»» rowVersion

integer(int64)

false

none

none

»»»»»»»»» table

string¦null

false

none

none

»»»»»»»»» queryDefinitionRight

any

false

none

none

»»»»»»»» trueValue

any

false

none

none

»»»»»»»» falseValue

any

false

none

none

»»»»»»»» isDate

boolean

false

none

none

»»»»»»»» literalType

string

false

none

none

»»»»»»»» value

any

false

none

none

»»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»»» trueValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»» falseValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»» isDate

boolean

false

none

none

»»»»»»» literalType

string

false

none

none

»»»»»»» value

any

false

none

none

»»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»»»» namespaceTable

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

none

»»»»»»» m_namespace

string¦null

false

none

none

»»»»»»» name

string¦null

false

none

none

»»»»»» query

any

false

none

none

»»»»»» alias

string¦null

false

none

none

»»»»»» sourceType

string

false

none

none

»»»»» joins

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

none

»»»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»»»» joinType

string

false

none

none

»»»»»» onClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»»»» constraintType

string

false

none

none

»»»»»»» op

string¦null

false

none

none

»»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»» caseSensitive

boolean

false

none

none

»»»»»»» constraints

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

none

[DTO version of IConstraint]

»»»»»»» literalRight

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»» right

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»» expressionLeft

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»» expressionRight

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»»» like

string¦null

false

none

none

»»»»»»» escapeWildcards

boolean

false

none

none

»»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» queryDefinitionRight

any

false

none

none

»»»»» whereClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»» order

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» column

string¦null

false

none

none

»»»»»» direction

string

false

none

none

»»»»» group

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» column

string¦null

false

none

none

»»»»» havingClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»» distinct

boolean

false

none

none

»»»»» unionWith

any

false

none

none

»»»»» exceptWith

any

false

none

none

»»»» sourceNames

object¦null

false

none

none

»»»»» additionalProperties

string¦null

false

none

none

»» isPasswordExpiryEnabled

boolean

false

none

none

» name

string¦null

false

none

none

» passwordExpiryEnabled

boolean¦null

false

none

none

» type

string

false

none

none

» subtreeGroupCount

integer(int32)

false

none

none

» id

integer(int32)

false

none

none

» parent

integer(int32)¦null

false

none

none

» oldParent

integer(int32)¦null

false

none

none

» prev

integer(int32)¦null

false

none

none

» oldPrev

integer(int32)¦null

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

dataType

Int

dataType

Decimal

dataType

DateTime

dataType

None

dataType

String

type

SelectAll

type

SelectItem

type

SelectLiteral

type

SelectCustom

type

SelectExpression

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

sourceType

Table

sourceType

Query

joinType

Inner

joinType

Left

joinType

Right

joinType

Cross

joinType

CrossApply

joinType

OuterApply

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

direction

Ascending

direction

Descending

direction

AscendingNullsFirst

direction

DescendingNullsLast

type

Group

type

Folder

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/portalaccessfolders", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/portalaccessfolders");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/portalaccessfolders',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/portalaccessfolders', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/portalaccessfolders',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "comment": "string",
    "group": {
      "definition": {},
      "isPasswordExpiryEnabled": true
    },
    "name": "string",
    "passwordExpiryEnabled": true,
    "type": "Group",
    "subtreeGroupCount": 0,
    "id": 0,
    "parent": 0,
    "oldParent": 0,
    "prev": 0,
    "oldPrev": 0,
    "version": {
      "rowVersion": 0
    }
  }
]
[{"comment":"string","group":{"definition":{},"isPasswordExpiryEnabled":true},"name":"string","passwordExpiryEnabled":true,"type":"Group","subtreeGroupCount":0,"id":0,"parent":0,"oldParent":0,"prev":0,"oldPrev":0,"version":{"rowVersion":0}}]

Create a portal access folder.

Body parameter

{
  "comment": "string",
  "group": {
    "definition": {
      "groupId": 0,
      "groupName": "string",
      "source": {}
    },
    "isPasswordExpiryEnabled": true
  },
  "name": "string",
  "passwordExpiryEnabled": true,
  "type": "Group",
  "subtreeGroupCount": 0,
  "id": 0,
  "parent": 0,
  "oldParent": 0,
  "prev": 0,
  "oldPrev": 0,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupNodeDTO

false

none

» comment

body

string¦null

false

none

» group

body

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupDTO

false

none

»» definition

body

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupDefinitionDTO

false

none

»»» groupId

body

integer(int32)

false

none

»»» groupName

body

string¦null

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»»»» alias

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» customSelect

body

string¦null

false

none

»»»»»» dataType

body

string

false

none

»»»»»» type

body

string

false

none

»»»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»» expressionType

body

string

false

none

»»»»»»» cases

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»»» constraintType

body

string

false

none

»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»» condition

body

any

false

none

»»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»»» literalType

body

string

false

none

»»»»»»»»»» value

body

any

false

none

»»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»»» constraints

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»» literalRight

body

any

false

none

»»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»» right

body

any

false

none

»»»»»»»»» expressionLeft

body

any

false

none

»»»»»»»»» expressionRight

body

any

false

none

»»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»»» like

body

string¦null

false

none

»»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»»»» trueValue

body

any

false

none

»»»»»»»» falseValue

body

any

false

none

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» isDate

body

boolean

false

none

»»»»»»» literalType

body

string

false

none

»»»»»»» value

body

any

false

none

»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»»»» m_namespace

body

string¦null

false

none

»»»»»»» name

body

string¦null

false

none

»»»»»» query

body

any

false

none

»»»»»» alias

body

string¦null

false

none

»»»»»» sourceType

body

string

false

none

»»»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»» joinType

body

string

false

none

»»»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»»» constraintType

body

string

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»» like

body

string¦null

false

none

»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» queryDefinitionRight

body

any

false

none

»»»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» direction

body

string

false

none

»»»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» distinct

body

boolean

false

none

»»»»» unionWith

body

any

false

none

»»»»» exceptWith

body

any

false

none

»»»» sourceNames

body

object¦null

false

none

»»»»» additionalProperties

body

string¦null

false

none

»» isPasswordExpiryEnabled

body

boolean

false

none

» name

body

string¦null

false

none

» passwordExpiryEnabled

body

boolean¦null

false

none

» type

body

string

false

none

» subtreeGroupCount

body

integer(int32)

false

none

» id

body

integer(int32)

false

none

» parent

body

integer(int32)¦null

false

none

» oldParent

body

integer(int32)¦null

false

none

» prev

body

integer(int32)¦null

false

none

» oldPrev

body

integer(int32)¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

»»»»»» dataType

Int

»»»»»» dataType

Decimal

»»»»»» dataType

DateTime

»»»»»» dataType

None

»»»»»» dataType

String

»»»»»» type

SelectAll

»»»»»» type

SelectItem

»»»»»» type

SelectLiteral

»»»»»» type

SelectCustom

»»»»»» type

SelectExpression

»»»»»»» expressionType

caseExpression

»»»»»»» expressionType

dataField

»»»»»»» expressionType

function

»»»»»»» expressionType

ifExpression

»»»»»»» expressionType

literal

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»»» constraintType

clause

»»»»»»»»» constraintType

constraint

»»»»»»»»» constraintType

expressionConstraint

»»»»»»»»» constraintType

likeConstraint

»»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»»» constraintType

subQueryConstraint

»»»»»»»»»» expressionType

caseExpression

»»»»»»»»»» expressionType

dataField

»»»»»»»»»» expressionType

function

»»»»»»»»»» expressionType

ifExpression

»»»»»»»»»» expressionType

literal

»»»»»»»»»» literalType

Integer

»»»»»»»»»» literalType

Decimal

»»»»»»»»»» literalType

Date

»»»»»»»»»» literalType

DateTime

»»»»»»»»»» literalType

String

»»»»»»»»»» literalType

Float

»»»»»»»»»» literalType

Long

»»»»»»»»»» literalType

Null

»»»»»»»»»» literalType

Parameter

»»»»»»»»»» literalType

Guid

»»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»»» literalType

Boolean

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»»» literalType

Integer

»»»»»»» literalType

Decimal

»»»»»»» literalType

Date

»»»»»»» literalType

DateTime

»»»»»»» literalType

String

»»»»»»» literalType

Float

»»»»»»» literalType

Long

»»»»»»» literalType

Null

»»»»»»» literalType

Parameter

»»»»»»» literalType

Guid

»»»»»»» literalType

SystemUtcTime

»»»»»»» literalType

Boolean

»»»»»» sourceType

Table

»»»»»» sourceType

Query

»»»»»» joinType

Inner

»»»»»» joinType

Left

»»»»»» joinType

Right

»»»»»» joinType

Cross

»»»»»» joinType

CrossApply

»»»»»» joinType

OuterApply

»»»»»»» constraintType

clause

»»»»»»» constraintType

constraint

»»»»»»» constraintType

expressionConstraint

»»»»»»» constraintType

likeConstraint

»»»»»»» constraintType

rowVersionConstraint

»»»»»»» constraintType

subQueryConstraint

»»»»»» direction

Ascending

»»»»»» direction

Descending

»»»»»» direction

AscendingNullsFirst

»»»»»» direction

DescendingNullsLast

» type

Group

» type

Folder

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupNodeDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/portalaccessfolders", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/portalaccessfolders");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "comment": "string",
  "group": {
    "definition": {
      "groupId": 0,
      "groupName": "string",
      "source": {}
    },
    "isPasswordExpiryEnabled": true
  },
  "name": "string",
  "passwordExpiryEnabled": true,
  "type": "Group",
  "subtreeGroupCount": 0,
  "id": 0,
  "parent": 0,
  "oldParent": 0,
  "prev": 0,
  "oldPrev": 0,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/portalaccessfolders',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/portalaccessfolders', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/portalaccessfolders',
  params: {
  }, headers: headers

p JSON.parse(result)

Update a portal access group.

Body parameter

{
  "workflow": {
    "comment": "string",
    "group": {
      "definition": {},
      "isPasswordExpiryEnabled": true
    },
    "name": "string",
    "passwordExpiryEnabled": true,
    "type": "Group",
    "subtreeGroupCount": 0,
    "id": 0,
    "parent": 0,
    "oldParent": 0,
    "prev": 0,
    "oldPrev": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "deltaAdds": [
    "string"
  ],
  "deltaDeletes": [
    "string"
  ]
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

RESTAPI.v1.DTOs.PortalAccess.UpdateWorkflowGroupNodeDTO

false

none

» workflow

body

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupNodeDTO

false

none

»» comment

body

string¦null

false

none

»» group

body

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupDTO

false

none

»»» definition

body

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupDefinitionDTO

false

none

»»»» groupId

body

integer(int32)

false

none

»»»» groupName

body

string¦null

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»»»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»»»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»»»»» alias

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» customSelect

body

string¦null

false

none

»»»»»»» dataType

body

string

false

none

»»»»»»» type

body

string

false

none

»»»»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»»»» constraintType

body

string

false

none

»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»»» condition

body

any

false

none

»»»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»»»» literalType

body

string

false

none

»»»»»»»»»»» value

body

any

false

none

»»»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»»»» constraints

body

array¦null

false

none

»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»» literalRight

body

any

false

none

»»»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»» right

body

any

false

none

»»»»»»»»»» expressionLeft

body

any

false

none

»»»»»»»»»» expressionRight

body

any

false

none

»»»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»»»» like

body

string¦null

false

none

»»»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»» literalType

body

string

false

none

»»»»»»»»» value

body

any

false

none

»»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»»»»» m_namespace

body

string¦null

false

none

»»»»»»»» name

body

string¦null

false

none

»»»»»»» query

body

any

false

none

»»»»»»» alias

body

string¦null

false

none

»»»»»»» sourceType

body

string

false

none

»»»»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»»» joinType

body

string

false

none

»»»»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»»»» constraintType

body

string

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»» like

body

string¦null

false

none

»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» direction

body

string

false

none

»»»»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»» distinct

body

boolean

false

none

»»»»»» unionWith

body

any

false

none

»»»»»» exceptWith

body

any

false

none

»»»»» sourceNames

body

object¦null

false

none

»»»»»» additionalProperties

body

string¦null

false

none

»»» isPasswordExpiryEnabled

body

boolean

false

none

»» name

body

string¦null

false

none

»» passwordExpiryEnabled

body

boolean¦null

false

none

»» type

body

string

false

none

»» subtreeGroupCount

body

integer(int32)

false

none

»» id

body

integer(int32)

false

none

»» parent

body

integer(int32)¦null

false

none

»» oldParent

body

integer(int32)¦null

false

none

»» prev

body

integer(int32)¦null

false

none

»» oldPrev

body

integer(int32)¦null

false

none

»» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

» deltaAdds

body

[string]¦null

false

none

» deltaDeletes

body

[string]¦null

false

none

Enumerated Values

Parameter

Value

»»»»»»» dataType

Int

»»»»»»» dataType

Decimal

»»»»»»» dataType

DateTime

»»»»»»» dataType

None

»»»»»»» dataType

String

»»»»»»» type

SelectAll

»»»»»»» type

SelectItem

»»»»»»» type

SelectLiteral

»»»»»»» type

SelectCustom

»»»»»»» type

SelectExpression

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»»» expressionType

caseExpression

»»»»»»»»» expressionType

dataField

»»»»»»»»» expressionType

function

»»»»»»»»» expressionType

ifExpression

»»»»»»»»» expressionType

literal

»»»»»»»»»» constraintType

clause

»»»»»»»»»» constraintType

constraint

»»»»»»»»»» constraintType

expressionConstraint

»»»»»»»»»» constraintType

likeConstraint

»»»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»»»» constraintType

subQueryConstraint

»»»»»»»»»»» expressionType

caseExpression

»»»»»»»»»»» expressionType

dataField

»»»»»»»»»»» expressionType

function

»»»»»»»»»»» expressionType

ifExpression

»»»»»»»»»»» expressionType

literal

»»»»»»»»»»» literalType

Integer

»»»»»»»»»»» literalType

Decimal

»»»»»»»»»»» literalType

Date

»»»»»»»»»»» literalType

DateTime

»»»»»»»»»»» literalType

String

»»»»»»»»»»» literalType

Float

»»»»»»»»»»» literalType

Long

»»»»»»»»»»» literalType

Null

»»»»»»»»»»» literalType

Parameter

»»»»»»»»»»» literalType

Guid

»»»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»»»» literalType

Boolean

»»»»»»»»» literalType

Integer

»»»»»»»»» literalType

Decimal

»»»»»»»»» literalType

Date

»»»»»»»»» literalType

DateTime

»»»»»»»»» literalType

String

»»»»»»»»» literalType

Float

»»»»»»»»» literalType

Long

»»»»»»»»» literalType

Null

»»»»»»»»» literalType

Parameter

»»»»»»»»» literalType

Guid

»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»» literalType

Boolean

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»»» sourceType

Table

»»»»»»» sourceType

Query

»»»»»»» joinType

Inner

»»»»»»» joinType

Left

»»»»»»» joinType

Right

»»»»»»» joinType

Cross

»»»»»»» joinType

CrossApply

»»»»»»» joinType

OuterApply

»»»»»»»» constraintType

clause

»»»»»»»» constraintType

constraint

»»»»»»»» constraintType

expressionConstraint

»»»»»»»» constraintType

likeConstraint

»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»» constraintType

subQueryConstraint

»»»»»»» direction

Ascending

»»»»»»» direction

Descending

»»»»»»» direction

AscendingNullsFirst

»»»»»»» direction

DescendingNullsLast

»» type

Group

»» type

Folder

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupNodeDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/portalaccessgroups/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/portalaccessgroups/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "workflow": {
    "comment": "string",
    "group": {
      "definition": {},
      "isPasswordExpiryEnabled": true
    },
    "name": "string",
    "passwordExpiryEnabled": true,
    "type": "Group",
    "subtreeGroupCount": 0,
    "id": 0,
    "parent": 0,
    "oldParent": 0,
    "prev": 0,
    "oldPrev": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "deltaAdds": [
    "string"
  ],
  "deltaDeletes": [
    "string"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/portalaccessgroups/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/portalaccessgroups/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/portalaccessgroups/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

Delete a portal access group.

Body parameter

{
  "comment": "string",
  "group": {
    "definition": {
      "groupId": 0,
      "groupName": "string",
      "source": {}
    },
    "isPasswordExpiryEnabled": true
  },
  "name": "string",
  "passwordExpiryEnabled": true,
  "type": "Group",
  "subtreeGroupCount": 0,
  "id": 0,
  "parent": 0,
  "oldParent": 0,
  "prev": 0,
  "oldPrev": 0,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupNodeDTO

false

none

» comment

body

string¦null

false

none

» group

body

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupDTO

false

none

»» definition

body

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupDefinitionDTO

false

none

»»» groupId

body

integer(int32)

false

none

»»» groupName

body

string¦null

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»»»» alias

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» customSelect

body

string¦null

false

none

»»»»»» dataType

body

string

false

none

»»»»»» type

body

string

false

none

»»»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»» expressionType

body

string

false

none

»»»»»»» cases

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»»» constraintType

body

string

false

none

»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»» condition

body

any

false

none

»»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»»» literalType

body

string

false

none

»»»»»»»»»» value

body

any

false

none

»»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»»» constraints

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»» literalRight

body

any

false

none

»»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»» right

body

any

false

none

»»»»»»»»» expressionLeft

body

any

false

none

»»»»»»»»» expressionRight

body

any

false

none

»»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»»» like

body

string¦null

false

none

»»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»»»» trueValue

body

any

false

none

»»»»»»»» falseValue

body

any

false

none

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» isDate

body

boolean

false

none

»»»»»»» literalType

body

string

false

none

»»»»»»» value

body

any

false

none

»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»»»» m_namespace

body

string¦null

false

none

»»»»»»» name

body

string¦null

false

none

»»»»»» query

body

any

false

none

»»»»»» alias

body

string¦null

false

none

»»»»»» sourceType

body

string

false

none

»»»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»» joinType

body

string

false

none

»»»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»»» constraintType

body

string

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»» like

body

string¦null

false

none

»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» queryDefinitionRight

body

any

false

none

»»»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» direction

body

string

false

none

»»»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» distinct

body

boolean

false

none

»»»»» unionWith

body

any

false

none

»»»»» exceptWith

body

any

false

none

»»»» sourceNames

body

object¦null

false

none

»»»»» additionalProperties

body

string¦null

false

none

»» isPasswordExpiryEnabled

body

boolean

false

none

» name

body

string¦null

false

none

» passwordExpiryEnabled

body

boolean¦null

false

none

» type

body

string

false

none

» subtreeGroupCount

body

integer(int32)

false

none

» id

body

integer(int32)

false

none

» parent

body

integer(int32)¦null

false

none

» oldParent

body

integer(int32)¦null

false

none

» prev

body

integer(int32)¦null

false

none

» oldPrev

body

integer(int32)¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

»»»»»» dataType

Int

»»»»»» dataType

Decimal

»»»»»» dataType

DateTime

»»»»»» dataType

None

»»»»»» dataType

String

»»»»»» type

SelectAll

»»»»»» type

SelectItem

»»»»»» type

SelectLiteral

»»»»»» type

SelectCustom

»»»»»» type

SelectExpression

»»»»»»» expressionType

caseExpression

»»»»»»» expressionType

dataField

»»»»»»» expressionType

function

»»»»»»» expressionType

ifExpression

»»»»»»» expressionType

literal

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»»» constraintType

clause

»»»»»»»»» constraintType

constraint

»»»»»»»»» constraintType

expressionConstraint

»»»»»»»»» constraintType

likeConstraint

»»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»»» constraintType

subQueryConstraint

»»»»»»»»»» expressionType

caseExpression

»»»»»»»»»» expressionType

dataField

»»»»»»»»»» expressionType

function

»»»»»»»»»» expressionType

ifExpression

»»»»»»»»»» expressionType

literal

»»»»»»»»»» literalType

Integer

»»»»»»»»»» literalType

Decimal

»»»»»»»»»» literalType

Date

»»»»»»»»»» literalType

DateTime

»»»»»»»»»» literalType

String

»»»»»»»»»» literalType

Float

»»»»»»»»»» literalType

Long

»»»»»»»»»» literalType

Null

»»»»»»»»»» literalType

Parameter

»»»»»»»»»» literalType

Guid

»»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»»» literalType

Boolean

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»»» literalType

Integer

»»»»»»» literalType

Decimal

»»»»»»» literalType

Date

»»»»»»» literalType

DateTime

»»»»»»» literalType

String

»»»»»»» literalType

Float

»»»»»»» literalType

Long

»»»»»»» literalType

Null

»»»»»»» literalType

Parameter

»»»»»»» literalType

Guid

»»»»»»» literalType

SystemUtcTime

»»»»»»» literalType

Boolean

»»»»»» sourceType

Table

»»»»»» sourceType

Query

»»»»»» joinType

Inner

»»»»»» joinType

Left

»»»»»» joinType

Right

»»»»»» joinType

Cross

»»»»»» joinType

CrossApply

»»»»»» joinType

OuterApply

»»»»»»» constraintType

clause

»»»»»»» constraintType

constraint

»»»»»»» constraintType

expressionConstraint

»»»»»»» constraintType

likeConstraint

»»»»»»» constraintType

rowVersionConstraint

»»»»»»» constraintType

subQueryConstraint

»»»»»» direction

Ascending

»»»»»» direction

Descending

»»»»»» direction

AscendingNullsFirst

»»»»»» direction

DescendingNullsLast

» type

Group

» type

Folder

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/portalaccessgroups/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/portalaccessgroups/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "comment": "string",
  "group": {
    "definition": {
      "groupId": 0,
      "groupName": "string",
      "source": {}
    },
    "isPasswordExpiryEnabled": true
  },
  "name": "string",
  "passwordExpiryEnabled": true,
  "type": "Group",
  "subtreeGroupCount": 0,
  "id": 0,
  "parent": 0,
  "oldParent": 0,
  "prev": 0,
  "oldPrev": 0,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/portalaccessgroups/{id}',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.delete('http://localhost:8080/api/v1/portalaccessgroups/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.delete 'http://localhost:8080/api/v1/portalaccessgroups/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

Update a portal access folder.

Body parameter

{
  "comment": "string",
  "group": {
    "definition": {
      "groupId": 0,
      "groupName": "string",
      "source": {}
    },
    "isPasswordExpiryEnabled": true
  },
  "name": "string",
  "passwordExpiryEnabled": true,
  "type": "Group",
  "subtreeGroupCount": 0,
  "id": 0,
  "parent": 0,
  "oldParent": 0,
  "prev": 0,
  "oldPrev": 0,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupNodeDTO

false

none

» comment

body

string¦null

false

none

» group

body

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupDTO

false

none

»» definition

body

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupDefinitionDTO

false

none

»»» groupId

body

integer(int32)

false

none

»»» groupName

body

string¦null

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»»»» alias

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» customSelect

body

string¦null

false

none

»»»»»» dataType

body

string

false

none

»»»»»» type

body

string

false

none

»»»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»» expressionType

body

string

false

none

»»»»»»» cases

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»»» constraintType

body

string

false

none

»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»» condition

body

any

false

none

»»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»»» literalType

body

string

false

none

»»»»»»»»»» value

body

any

false

none

»»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»»» constraints

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»» literalRight

body

any

false

none

»»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»» right

body

any

false

none

»»»»»»»»» expressionLeft

body

any

false

none

»»»»»»»»» expressionRight

body

any

false

none

»»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»»» like

body

string¦null

false

none

»»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»»»» trueValue

body

any

false

none

»»»»»»»» falseValue

body

any

false

none

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» isDate

body

boolean

false

none

»»»»»»» literalType

body

string

false

none

»»»»»»» value

body

any

false

none

»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»»»» m_namespace

body

string¦null

false

none

»»»»»»» name

body

string¦null

false

none

»»»»»» query

body

any

false

none

»»»»»» alias

body

string¦null

false

none

»»»»»» sourceType

body

string

false

none

»»»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»» joinType

body

string

false

none

»»»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»»» constraintType

body

string

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»» like

body

string¦null

false

none

»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» queryDefinitionRight

body

any

false

none

»»»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» direction

body

string

false

none

»»»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» distinct

body

boolean

false

none

»»»»» unionWith

body

any

false

none

»»»»» exceptWith

body

any

false

none

»»»» sourceNames

body

object¦null

false

none

»»»»» additionalProperties

body

string¦null

false

none

»» isPasswordExpiryEnabled

body

boolean

false

none

» name

body

string¦null

false

none

» passwordExpiryEnabled

body

boolean¦null

false

none

» type

body

string

false

none

» subtreeGroupCount

body

integer(int32)

false

none

» id

body

integer(int32)

false

none

» parent

body

integer(int32)¦null

false

none

» oldParent

body

integer(int32)¦null

false

none

» prev

body

integer(int32)¦null

false

none

» oldPrev

body

integer(int32)¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

»»»»»» dataType

Int

»»»»»» dataType

Decimal

»»»»»» dataType

DateTime

»»»»»» dataType

None

»»»»»» dataType

String

»»»»»» type

SelectAll

»»»»»» type

SelectItem

»»»»»» type

SelectLiteral

»»»»»» type

SelectCustom

»»»»»» type

SelectExpression

»»»»»»» expressionType

caseExpression

»»»»»»» expressionType

dataField

»»»»»»» expressionType

function

»»»»»»» expressionType

ifExpression

»»»»»»» expressionType

literal

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»»» constraintType

clause

»»»»»»»»» constraintType

constraint

»»»»»»»»» constraintType

expressionConstraint

»»»»»»»»» constraintType

likeConstraint

»»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»»» constraintType

subQueryConstraint

»»»»»»»»»» expressionType

caseExpression

»»»»»»»»»» expressionType

dataField

»»»»»»»»»» expressionType

function

»»»»»»»»»» expressionType

ifExpression

»»»»»»»»»» expressionType

literal

»»»»»»»»»» literalType

Integer

»»»»»»»»»» literalType

Decimal

»»»»»»»»»» literalType

Date

»»»»»»»»»» literalType

DateTime

»»»»»»»»»» literalType

String

»»»»»»»»»» literalType

Float

»»»»»»»»»» literalType

Long

»»»»»»»»»» literalType

Null

»»»»»»»»»» literalType

Parameter

»»»»»»»»»» literalType

Guid

»»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»»» literalType

Boolean

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»»» literalType

Integer

»»»»»»» literalType

Decimal

»»»»»»» literalType

Date

»»»»»»» literalType

DateTime

»»»»»»» literalType

String

»»»»»»» literalType

Float

»»»»»»» literalType

Long

»»»»»»» literalType

Null

»»»»»»» literalType

Parameter

»»»»»»» literalType

Guid

»»»»»»» literalType

SystemUtcTime

»»»»»»» literalType

Boolean

»»»»»» sourceType

Table

»»»»»» sourceType

Query

»»»»»» joinType

Inner

»»»»»» joinType

Left

»»»»»» joinType

Right

»»»»»» joinType

Cross

»»»»»» joinType

CrossApply

»»»»»» joinType

OuterApply

»»»»»»» constraintType

clause

»»»»»»» constraintType

constraint

»»»»»»» constraintType

expressionConstraint

»»»»»»» constraintType

likeConstraint

»»»»»»» constraintType

rowVersionConstraint

»»»»»»» constraintType

subQueryConstraint

»»»»»» direction

Ascending

»»»»»» direction

Descending

»»»»»» direction

AscendingNullsFirst

»»»»»» direction

DescendingNullsLast

» type

Group

» type

Folder

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupNodeDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/portalaccessfolders/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/portalaccessfolders/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "comment": "string",
  "group": {
    "definition": {
      "groupId": 0,
      "groupName": "string",
      "source": {}
    },
    "isPasswordExpiryEnabled": true
  },
  "name": "string",
  "passwordExpiryEnabled": true,
  "type": "Group",
  "subtreeGroupCount": 0,
  "id": 0,
  "parent": 0,
  "oldParent": 0,
  "prev": 0,
  "oldPrev": 0,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/portalaccessfolders/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/portalaccessfolders/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/portalaccessfolders/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

Delete a portal access folder.

Body parameter

{
  "comment": "string",
  "group": {
    "definition": {
      "groupId": 0,
      "groupName": "string",
      "source": {}
    },
    "isPasswordExpiryEnabled": true
  },
  "name": "string",
  "passwordExpiryEnabled": true,
  "type": "Group",
  "subtreeGroupCount": 0,
  "id": 0,
  "parent": 0,
  "oldParent": 0,
  "prev": 0,
  "oldPrev": 0,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupNodeDTO

false

none

» comment

body

string¦null

false

none

» group

body

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupDTO

false

none

»» definition

body

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupDefinitionDTO

false

none

»»» groupId

body

integer(int32)

false

none

»»» groupName

body

string¦null

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»»»» alias

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» customSelect

body

string¦null

false

none

»»»»»» dataType

body

string

false

none

»»»»»» type

body

string

false

none

»»»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»» expressionType

body

string

false

none

»»»»»»» cases

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»»» constraintType

body

string

false

none

»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»»» condition

body

any

false

none

»»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»»» literalType

body

string

false

none

»»»»»»»»»» value

body

any

false

none

»»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»»» constraints

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»» literalRight

body

any

false

none

»»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»» right

body

any

false

none

»»»»»»»»» expressionLeft

body

any

false

none

»»»»»»»»» expressionRight

body

any

false

none

»»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»»» like

body

string¦null

false

none

»»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»»»» trueValue

body

any

false

none

»»»»»»»» falseValue

body

any

false

none

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» isDate

body

boolean

false

none

»»»»»»» literalType

body

string

false

none

»»»»»»» value

body

any

false

none

»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»»»» m_namespace

body

string¦null

false

none

»»»»»»» name

body

string¦null

false

none

»»»»»» query

body

any

false

none

»»»»»» alias

body

string¦null

false

none

»»»»»» sourceType

body

string

false

none

»»»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»»» joinType

body

string

false

none

»»»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»»» constraintType

body

string

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»» like

body

string¦null

false

none

»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» queryDefinitionRight

body

any

false

none

»»»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» direction

body

string

false

none

»»»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» distinct

body

boolean

false

none

»»»»» unionWith

body

any

false

none

»»»»» exceptWith

body

any

false

none

»»»» sourceNames

body

object¦null

false

none

»»»»» additionalProperties

body

string¦null

false

none

»» isPasswordExpiryEnabled

body

boolean

false

none

» name

body

string¦null

false

none

» passwordExpiryEnabled

body

boolean¦null

false

none

» type

body

string

false

none

» subtreeGroupCount

body

integer(int32)

false

none

» id

body

integer(int32)

false

none

» parent

body

integer(int32)¦null

false

none

» oldParent

body

integer(int32)¦null

false

none

» prev

body

integer(int32)¦null

false

none

» oldPrev

body

integer(int32)¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

»»»»»» dataType

Int

»»»»»» dataType

Decimal

»»»»»» dataType

DateTime

»»»»»» dataType

None

»»»»»» dataType

String

»»»»»» type

SelectAll

»»»»»» type

SelectItem

»»»»»» type

SelectLiteral

»»»»»» type

SelectCustom

»»»»»» type

SelectExpression

»»»»»»» expressionType

caseExpression

»»»»»»» expressionType

dataField

»»»»»»» expressionType

function

»»»»»»» expressionType

ifExpression

»»»»»»» expressionType

literal

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»»» constraintType

clause

»»»»»»»»» constraintType

constraint

»»»»»»»»» constraintType

expressionConstraint

»»»»»»»»» constraintType

likeConstraint

»»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»»» constraintType

subQueryConstraint

»»»»»»»»»» expressionType

caseExpression

»»»»»»»»»» expressionType

dataField

»»»»»»»»»» expressionType

function

»»»»»»»»»» expressionType

ifExpression

»»»»»»»»»» expressionType

literal

»»»»»»»»»» literalType

Integer

»»»»»»»»»» literalType

Decimal

»»»»»»»»»» literalType

Date

»»»»»»»»»» literalType

DateTime

»»»»»»»»»» literalType

String

»»»»»»»»»» literalType

Float

»»»»»»»»»» literalType

Long

»»»»»»»»»» literalType

Null

»»»»»»»»»» literalType

Parameter

»»»»»»»»»» literalType

Guid

»»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»»» literalType

Boolean

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»»» literalType

Integer

»»»»»»» literalType

Decimal

»»»»»»» literalType

Date

»»»»»»» literalType

DateTime

»»»»»»» literalType

String

»»»»»»» literalType

Float

»»»»»»» literalType

Long

»»»»»»» literalType

Null

»»»»»»» literalType

Parameter

»»»»»»» literalType

Guid

»»»»»»» literalType

SystemUtcTime

»»»»»»» literalType

Boolean

»»»»»» sourceType

Table

»»»»»» sourceType

Query

»»»»»» joinType

Inner

»»»»»» joinType

Left

»»»»»» joinType

Right

»»»»»» joinType

Cross

»»»»»» joinType

CrossApply

»»»»»» joinType

OuterApply

»»»»»»» constraintType

clause

»»»»»»» constraintType

constraint

»»»»»»» constraintType

expressionConstraint

»»»»»»» constraintType

likeConstraint

»»»»»»» constraintType

rowVersionConstraint

»»»»»»» constraintType

subQueryConstraint

»»»»»» direction

Ascending

»»»»»» direction

Descending

»»»»»» direction

AscendingNullsFirst

»»»»»» direction

DescendingNullsLast

» type

Group

» type

Folder

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/portalaccessfolders/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/portalaccessfolders/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "comment": "string",
  "group": {
    "definition": {
      "groupId": 0,
      "groupName": "string",
      "source": {}
    },
    "isPasswordExpiryEnabled": true
  },
  "name": "string",
  "passwordExpiryEnabled": true,
  "type": "Group",
  "subtreeGroupCount": 0,
  "id": 0,
  "parent": 0,
  "oldParent": 0,
  "prev": 0,
  "oldPrev": 0,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/portalaccessfolders/{id}',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.delete('http://localhost:8080/api/v1/portalaccessfolders/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.delete 'http://localhost:8080/api/v1/portalaccessfolders/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

Fetches the Payee table with specific rows selected.

Body parameter

{
  "query": {
    "selectItems": [
      {}
    ],
    "source": {
      "namespaceTable": {},
      "query": null,
      "alias": "string",
      "sourceType": "Table"
    },
    "joins": [
      {}
    ],
    "whereClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "order": [
      {}
    ],
    "group": [
      {}
    ],
    "havingClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "distinct": true,
    "unionWith": null,
    "exceptWith": null
  },
  "sourceNames": {
    "property1": "string",
    "property2": "string"
  }
}

Parameters

Name

In

Type

Required

Description

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

fields

query

string

false

Comma delimited list of fields to display. Used to limit the output results to selected columns.

unique

query

boolean

false

Boolean value to select only unique values. Default value is false.

filter

query

string

false

####Supported operations

body

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

The definition of the query used to generate the isSelected column.

» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»» alias

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» table

body

string¦null

false

none

»»» customSelect

body

string¦null

false

none

»»» dataType

body

string

false

none

»»» type

body

string

false

none

»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» expressionType

body

string

false

none

»»»» cases

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» op

body

string¦null

false

none

»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»» constraintType

body

string

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» expressionType

body

string

false

none

»»»»»»» cases

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» arguments

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» condition

body

any

false

none

»»»»»»» trueValue

body

any

false

none

»»»»»»» falseValue

body

any

false

none

»»»»»»» isDate

body

boolean

false

none

»»»»»»» literalType

body

string

false

none

»»»»»»» value

body

any

false

none

»»»»»» caseSensitive

body

boolean

false

none

»»»»»» constraints

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» literalRight

body

any

false

none

»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»» right

body

any

false

none

»»»»»» expressionLeft

body

any

false

none

»»»»»» expressionRight

body

any

false

none

»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»» like

body

string¦null

false

none

»»»»»» escapeWildcards

body

boolean

false

none

»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» queryDefinitionRight

body

any

false

none

»»»»» trueValue

body

any

false

none

»»»»» falseValue

body

any

false

none

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» isDate

body

boolean

false

none

»»»» literalType

body

string

false

none

»»»» value

body

any

false

none

»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»» m_namespace

body

string¦null

false

none

»»»» name

body

string¦null

false

none

»»» query

body

any

false

none

»»» alias

body

string¦null

false

none

»»» sourceType

body

string

false

none

»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»» joinType

body

string

false

none

»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»» constraintType

body

string

false

none

»»»» op

body

string¦null

false

none

»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» caseSensitive

body

boolean

false

none

»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» isPreciseDecimal

body

boolean

false

none

»»»» like

body

string¦null

false

none

»»»» escapeWildcards

body

boolean

false

none

»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»» table

body

string¦null

false

none

»»»» queryDefinitionRight

body

any

false

none

»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» direction

body

string

false

none

»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» distinct

body

boolean

false

none

»» unionWith

body

any

false

none

»» exceptWith

body

any

false

none

» sourceNames

body

object¦null

false

none

»» additionalProperties

body

string¦null

false

none

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

fields: Comma delimited list of fields to display. Used to limit the output results to selected columns.

Defaults to all available fields.

Examples

fields=PayeeID_

unique: Boolean value to select only unique values. Default value is false. When enabled, must specify exactly one column field.

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

Any column

Enumerated Values

Parameter

Value

»»» dataType

Int

»»» dataType

Decimal

»»» dataType

DateTime

»»» dataType

None

»»» dataType

String

»»» type

SelectAll

»»» type

SelectItem

»»» type

SelectLiteral

»»» type

SelectCustom

»»» type

SelectExpression

»»»» expressionType

caseExpression

»»»» expressionType

dataField

»»»» expressionType

function

»»»» expressionType

ifExpression

»»»» expressionType

literal

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» constraintType

clause

»»»»»» constraintType

constraint

»»»»»» constraintType

expressionConstraint

»»»»»» constraintType

likeConstraint

»»»»»» constraintType

rowVersionConstraint

»»»»»» constraintType

subQueryConstraint

»»»»»»» expressionType

caseExpression

»»»»»»» expressionType

dataField

»»»»»»» expressionType

function

»»»»»»» expressionType

ifExpression

»»»»»»» expressionType

literal

»»»»»»» literalType

Integer

»»»»»»» literalType

Decimal

»»»»»»» literalType

Date

»»»»»»» literalType

DateTime

»»»»»»» literalType

String

»»»»»»» literalType

Float

»»»»»»» literalType

Long

»»»»»»» literalType

Null

»»»»»»» literalType

Parameter

»»»»»»» literalType

Guid

»»»»»»» literalType

SystemUtcTime

»»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» literalType

Integer

»»»» literalType

Decimal

»»»» literalType

Date

»»»» literalType

DateTime

»»»» literalType

String

»»»» literalType

Float

»»»» literalType

Long

»»»» literalType

Null

»»»» literalType

Parameter

»»»» literalType

Guid

»»»» literalType

SystemUtcTime

»»»» literalType

Boolean

»»» sourceType

Table

»»» sourceType

Query

»»» joinType

Inner

»»» joinType

Left

»»» joinType

Right

»»» joinType

Cross

»»» joinType

CrossApply

»»» joinType

OuterApply

»»»» constraintType

clause

»»»» constraintType

constraint

»»»» constraintType

expressionConstraint

»»»» constraintType

likeConstraint

»»»» constraintType

rowVersionConstraint

»»»» constraintType

subQueryConstraint

»»» direction

Ascending

»»» direction

Descending

»»» direction

AscendingNullsFirst

»»» direction

DescendingNullsLast

Responses

Status

Meaning

Description

Schema

200

OK

Get data, ordered by key column, for given table (limit, offset, filter supported)

Varicent.RESTAPI.v1.DTOs.ResultSetDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/portalaccessgroups/checkedpayees", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/portalaccessgroups/checkedpayees");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "query": {
    "selectItems": [
      {}
    ],
    "source": {
      "namespaceTable": {},
      "query": null,
      "alias": "string",
      "sourceType": "Table"
    },
    "joins": [
      {}
    ],
    "whereClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "order": [
      {}
    ],
    "group": [
      {}
    ],
    "havingClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "distinct": true,
    "unionWith": null,
    "exceptWith": null
  },
  "sourceNames": {
    "property1": "string",
    "property2": "string"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/portalaccessgroups/checkedpayees',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/portalaccessgroups/checkedpayees', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/portalaccessgroups/checkedpayees',
  params: {
  }, headers: headers

p JSON.parse(result)

Get payees for a specific group.

Parameters

Name

In

Type

Required

Description

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

filter

query

string

false

####Supported operations

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

groupid

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.PayeeDetailsDTO]

false

none

none

» title

string¦null

false

none

none

» email

string¦null

false

none

none

» phone

string¦null

false

none

none

» reportsTo

string¦null

false

none

none

» name

string¦null

false

none

none

» id

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/payees", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payees");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/payees',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/payees', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/payees',
  params: {
  }, headers: headers

p JSON.parse(result)

Get web users.

Parameters

Name

In

Type

Required

Description

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

filter

query

string

false

####Supported operations

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

groupid, id, name, email, iswebenabled

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.WebUserDTO]

false

none

none

» isWebEnabled

boolean

false

none

none

» isLocked

boolean¦null

false

none

none

» changePasswordOnNextLogin

boolean¦null

false

none

none

» password

string¦null

false

none

none

» title

string¦null

false

none

none

» email

string¦null

false

none

none

» phone

string¦null

false

none

none

» reportsTo

string¦null

false

none

none

» name

string¦null

false

none

none

» id

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/webusers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webusers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webusers',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/webusers', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/webusers',
  params: {
  }, headers: headers

p JSON.parse(result)

Disable a web user with a specific payee ID (delete the row from the users table).

Body parameter

[
  "string"
]

Parameters

Name

In

Type

Required

Description

body

body

array[string]

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/webusers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webusers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  "string"
]';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/webusers',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.delete('http://localhost:8080/api/v1/webusers', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.delete 'http://localhost:8080/api/v1/webusers',
  params: {
  }, headers: headers

p JSON.parse(result)

Enable a web user with a specific payee ID (add a row to the users table).

Body parameter

[
  {
    "isWebEnabled": true,
    "isLocked": true,
    "changePasswordOnNextLogin": true,
    "password": "string",
    "title": "string",
    "email": "string",
    "phone": "string",
    "reportsTo": "string",
    "name": "string",
    "id": "string"
  }
]

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.WebUserDTO

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

400

Bad Request

The given payee ID does not exist. The user cannot be added as a web user.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/webusers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webusers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "isWebEnabled": true,
    "isLocked": true,
    "changePasswordOnNextLogin": true,
    "password": "string",
    "title": "string",
    "email": "string",
    "phone": "string",
    "reportsTo": "string",
    "name": "string",
    "id": "string"
  }
]';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/webusers',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/webusers', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/webusers',
  params: {
  }, headers: headers

p JSON.parse(result)

Update a web user’s password change settings or unlock web user, or both.

(Lock user, in effect, change ‘isLocked’ from false/null to true is not supported.)

Body parameter

[
  {
    "isWebEnabled": true,
    "isLocked": true,
    "changePasswordOnNextLogin": true,
    "password": "string",
    "title": "string",
    "email": "string",
    "phone": "string",
    "reportsTo": "string",
    "name": "string",
    "id": "string"
  }
]

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.WebUserDTO

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/webusers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webusers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "isWebEnabled": true,
    "isLocked": true,
    "changePasswordOnNextLogin": true,
    "password": "string",
    "title": "string",
    "email": "string",
    "phone": "string",
    "reportsTo": "string",
    "name": "string",
    "id": "string"
  }
]';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/webusers',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/webusers', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/webusers',
  params: {
  }, headers: headers

p JSON.parse(result)

System Call

Get a single web user. Note we do not put the PayeeID in the route because it could be sensitive information.

Body parameter

"string"

Parameters

Name

In

Type

Required

Description

body

body

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.FullWebUserDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/webuser", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webuser");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = 'string';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webuser',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/webuser', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/webuser',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "created": "2019-08-24T14:15:22Z",
  "lastLogin": "2019-08-24T14:15:22Z",
  "failedLogOnAttempts": 0,
  "lastPasswordExpirePrompt": "2019-08-24T14:15:22Z",
  "lastPasswordExpireEmail": "2019-08-24T14:15:22Z",
  "rowVersion": 0,
  "isWebEnabled": true,
  "isLocked": true,
  "changePasswordOnNextLogin": true,
  "password": "string",
  "title": "string",
  "email": "string",
  "phone": "string",
  "reportsTo": "string",
  "name": "string",
  "id": "string"
}
{"created":"2019-08-24T14:15:22Z","lastLogin":"2019-08-24T14:15:22Z","failedLogOnAttempts":0,"lastPasswordExpirePrompt":"2019-08-24T14:15:22Z","lastPasswordExpireEmail":"2019-08-24T14:15:22Z","rowVersion":0,"isWebEnabled":true,"isLocked":true,"changePasswordOnNextLogin":true,"password":"string","title":"string","email":"string","phone":"string","reportsTo":"string","name":"string","id":"string"}

System Call

Updates specific sections of a single web user. Note we do not put the PayeeID in the route because it could be sensitive information.

Body parameter

{
  "payeeId": "string",
  "lastLogin": "2019-08-24T14:15:22Z",
  "failedLogOnAttempts": 0,
  "isLocked": true,
  "changePasswordOnNextLogin": true,
  "rowVersion": 0
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.FullWebUserPatchDTO

false

none

» payeeId

body

string¦null

false

none

» lastLogin

body

string(date-time)¦null

false

none

» failedLogOnAttempts

body

integer(int32)¦null

false

none

» isLocked

body

boolean¦null

false

none

» changePasswordOnNextLogin

body

boolean¦null

false

none

» rowVersion

body

integer(int64)¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/webuser", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webuser");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "payeeId": "string",
  "lastLogin": "2019-08-24T14:15:22Z",
  "failedLogOnAttempts": 0,
  "isLocked": true,
  "changePasswordOnNextLogin": true,
  "rowVersion": 0
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/webuser',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/webuser', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/webuser',
  params: {
  }, headers: headers

p JSON.parse(result)

PortalAccessControllerV1_GetPayeeProfileDetails

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.PayeeTitleDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/payeeprofiledetails", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payeeprofiledetails");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/payeeprofiledetails',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/payeeprofiledetails', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/payeeprofiledetails',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "name": "string",
  "title": "string"
}
{"name":"string","title":"string"}

System Call

Get a web user’s password info. Note we do not put the PayeeID in the route because it could be sensitive information.

Body parameter

"string"

Parameters

Name

In

Type

Required

Description

body

body

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.PasswordInformationDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/webuser/passwordinfo", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webuser/passwordinfo");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = 'string';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webuser/passwordinfo',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/webuser/passwordinfo', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/webuser/passwordinfo',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "password": "string",
  "salt": "string",
  "encryption": "Version1"
}
{"password":"string","salt":"string","encryption":"Version1"}

Get web users for a specific group.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

offset

query

integer(int32)

false

Offset number of records.

limit

query

integer(int32)

false

Number of records to retrieve.

filter

query

string

false

####Supported operations

fields

query

string

false

none

unique

query

boolean

false

none

Detailed descriptions

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

limit: Number of records to retrieve.

Default: 50

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

id

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.WebUserDTO]

false

none

none

» isWebEnabled

boolean

false

none

none

» isLocked

boolean¦null

false

none

none

» changePasswordOnNextLogin

boolean¦null

false

none

none

» password

string¦null

false

none

none

» title

string¦null

false

none

none

» email

string¦null

false

none

none

» phone

string¦null

false

none

none

» reportsTo

string¦null

false

none

none

» name

string¦null

false

none

none

» id

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/portalaccessgroups/{id}/webusers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/portalaccessgroups/{id}/webusers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/portalaccessgroups/{id}/webusers',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/portalaccessgroups/{id}/webusers', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/portalaccessgroups/{id}/webusers',
  params: {
  }, headers: headers

p JSON.parse(result)

Disables all web users that belong to the portal access group with the given portal access group ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Portal Access Group ID

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/portalaccessgroups/{id}/webusers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/portalaccessgroups/{id}/webusers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/portalaccessgroups/{id}/webusers',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/portalaccessgroups/{id}/webusers')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/portalaccessgroups/{id}/webusers',
  params: {
  }

p JSON.parse(result)

Enables all web users belonging to the portal access group with the given portal access group ID.

Body parameter

{
  "property1": "string",
  "property2": "string"
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Portal Access Group ID

body

body

object

false

none

» additionalProperties

body

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/portalaccessgroups/{id}/webusers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/portalaccessgroups/{id}/webusers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "property1": "string",
  "property2": "string"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/portalaccessgroups/{id}/webusers',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/portalaccessgroups/{id}/webusers', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/portalaccessgroups/{id}/webusers',
  params: {
  }, headers: headers

p JSON.parse(result)

Update locked status or password change settings for all web users that belong to

the portal access group with the given portal access group ID.

Body parameter

{
  "isWebEnabled": true,
  "isLocked": true,
  "changePasswordOnNextLogin": true,
  "password": "string",
  "title": "string",
  "email": "string",
  "phone": "string",
  "reportsTo": "string",
  "name": "string",
  "id": "string"
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

Portal Access Group ID

body

body

Varicent.RESTAPI.v1.DTOs.WebUserDTO

false

none

» isWebEnabled

body

boolean

false

none

» isLocked

body

boolean¦null

false

none

» changePasswordOnNextLogin

body

boolean¦null

false

none

» password

body

string¦null

false

none

» title

body

string¦null

false

none

» email

body

string¦null

false

none

» phone

body

string¦null

false

none

» reportsTo

body

string¦null

false

none

» name

body

string¦null

false

none

» id

body

string¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/portalaccessgroups/{id}/webusers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/portalaccessgroups/{id}/webusers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "isWebEnabled": true,
  "isLocked": true,
  "changePasswordOnNextLogin": true,
  "password": "string",
  "title": "string",
  "email": "string",
  "phone": "string",
  "reportsTo": "string",
  "name": "string",
  "id": "string"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/portalaccessgroups/{id}/webusers',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/portalaccessgroups/{id}/webusers', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/portalaccessgroups/{id}/webusers',
  params: {
  }, headers: headers

p JSON.parse(result)

Get all web users from all group.

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.WebUserWithGroupDTO]

false

none

none

» groupName

string¦null

false

none

none

» parentName

string¦null

false

none

none

» isWebEnabled

boolean

false

none

none

» isLocked

boolean¦null

false

none

none

» changePasswordOnNextLogin

boolean¦null

false

none

none

» password

string¦null

false

none

none

» title

string¦null

false

none

none

» email

string¦null

false

none

none

» phone

string¦null

false

none

none

» reportsTo

string¦null

false

none

none

» name

string¦null

false

none

none

» id

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/portalaccessgroups/getallwebusers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/portalaccessgroups/getallwebusers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/portalaccessgroups/getallwebusers',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/portalaccessgroups/getallwebusers', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/portalaccessgroups/getallwebusers',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "groupName": "string",
    "parentName": "string",
    "isWebEnabled": true,
    "isLocked": true,
    "changePasswordOnNextLogin": true,
    "password": "string",
    "title": "string",
    "email": "string",
    "phone": "string",
    "reportsTo": "string",
    "name": "string",
    "id": "string"
  }
]
[{"groupName":"string","parentName":"string","isWebEnabled":true,"isLocked":true,"changePasswordOnNextLogin":true,"password":"string","title":"string","email":"string","phone":"string","reportsTo":"string","name":"string","id":"string"}]

PortalAccessControllerV1_GenerateWebPassCode

Body parameter

{
  "payeeID": "string"
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Payee.PayeeIDDTO

false

none

» payeeID

body

string¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/generatewebpasscode", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/generatewebpasscode");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "payeeID": "string"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/generatewebpasscode',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/generatewebpasscode', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/generatewebpasscode',
  params: {
  }, headers: headers

p JSON.parse(result)

PortalAccessControllerV1_GenerateWebPassCodeByEmail

Body parameter

{
  "passCode": "string",
  "payeeID": "string",
  "newPassword": "string",
  "email": "string"
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Payee.ResetWebPasswordDTO

false

none

» passCode

body

string¦null

false

none

» payeeID

body

string¦null

false

none

» newPassword

body

string¦null

false

none

» email

body

string¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/generatewebpasscodebyemail", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/generatewebpasscodebyemail");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "passCode": "string",
  "payeeID": "string",
  "newPassword": "string",
  "email": "string"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/generatewebpasscodebyemail',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/generatewebpasscodebyemail', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/generatewebpasscodebyemail',
  params: {
  }, headers: headers

p JSON.parse(result)

PortalAccessControllerV1_VerifyChangeWebPassword

Body parameter

{
  "passCode": "string",
  "payeeID": "string",
  "newPassword": "string",
  "email": "string"
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Payee.ResetWebPasswordDTO

false

none

» passCode

body

string¦null

false

none

» payeeID

body

string¦null

false

none

» newPassword

body

string¦null

false

none

» email

body

string¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

400

Bad Request

Invalid passcode/password.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/verifychangewebpassword", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/verifychangewebpassword");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "passCode": "string",
  "payeeID": "string",
  "newPassword": "string",
  "email": "string"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/verifychangewebpassword',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/verifychangewebpassword', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/verifychangewebpassword',
  params: {
  }, headers: headers

p JSON.parse(result)

PortalAccessControllerV1_VerifyChangeWebPasswordByEmail

Body parameter

{
  "passCode": "string",
  "payeeID": "string",
  "newPassword": "string",
  "email": "string"
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Payee.ResetWebPasswordDTO

false

none

» passCode

body

string¦null

false

none

» payeeID

body

string¦null

false

none

» newPassword

body

string¦null

false

none

» email

body

string¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

400

Bad Request

Invalid passcode/password.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/verifychangewebpasswordbyemail", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/verifychangewebpasswordbyemail");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "passCode": "string",
  "payeeID": "string",
  "newPassword": "string",
  "email": "string"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/verifychangewebpasswordbyemail',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/verifychangewebpasswordbyemail', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/verifychangewebpasswordbyemail',
  params: {
  }, headers: headers

p JSON.parse(result)

Get the signoff tree for the given portal access object ID.

Coloring tree nodes should be done in the UI with pending nodes and approved nodes.

Parameters

Name

In

Type

Required

Description

portalAccessObjectId

path

integer(int32)

true

Portal Access object ID

Responses

Status

Meaning

Description

Schema

200

OK

Get Signoff Tree by Portal Access object Id

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.PortalAccess.PortalAccessSignoffTreeDTO]

false

none

none

» signoff

RESTAPI.v1.DTOs.PortalAccess.PortalAccessSignoffDTO

false

none

none

»» signoffId

integer(int32)

false

none

none

»» signoffName

string¦null

false

none

none

»» treeId

integer(int32)¦null

false

none

none

»» startDate

string(date-time)

false

none

none

»» endRevision

integer(int32)

false

none

none

»» objectName

string¦null

false

none

none

»» nodeId

integer(int32)¦null

false

none

none

»» signoffDate

string(date-time)¦null

false

none

none

»» from

[string]¦null

false

none

none

»» objectId

string¦null

false

none

none

»» type

string

false

none

none

» tree

Varicent.RESTAPI.v1.DTOs.Workflow.WorkflowTreeDTO

false

none

none

»» id

integer(int32)

false

none

none

»» name

string¦null

false

none

none

»» edges

[Varicent.RESTAPI.v1.DTOs.Workflow.WorkflowTreeEdgeDTO]¦null

false

none

none

»»» start

integer(int32)

false

none

none

»»» end

integer(int32)

false

none

none

»» nodes

[Varicent.RESTAPI.v1.DTOs.Workflow.WorkflowTreeNodeDTO]¦null

false

none

none

»»» nodeId

integer(int32)

false

none

none

»»» groupId

integer(int32)

false

none

none

»»» name

string¦null

false

none

none

»»» signOffType

string

false

none

none

»»» canAdjust

boolean

false

none

none

»» descendantList

object¦null

false

none

none

»»» additionalProperties

[integer]

false

none

none

»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»» rowVersion

integer(int64)

false

none

none

» pendingNodes

[integer]¦null

false

none

none

» approvedNodes

[integer]¦null

false

none

none

Enumerated Values

Property

Value

type

Data

type

CompensationPlan

type

TailoredReport

type

Document

type

WebForm

type

WebReport

type

WebTab

type

CompPlanManager

type

WebTabGroup

type

ExternalURL

type

RapidReport

type

Table

type

DataStore

type

DDE

type

DDEInfographic

type

PayeeDocument

type

PresenterAdaptive

type

DirectLink

type

AdaptiveForm

type

StandardReport

type

SalesPlanningMap

signOffType

AnySignOff

signOffType

AllSignOff

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/portalAccessSignoffs/{portalAccessObjectId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/portalAccessSignoffs/{portalAccessObjectId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/portalAccessSignoffs/{portalAccessObjectId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/portalAccessSignoffs/{portalAccessObjectId}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/portalAccessSignoffs/{portalAccessObjectId}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "signoff": {
      "signoffId": 0,
      "signoffName": "string",
      "treeId": 0,
      "startDate": "2019-08-24T14:15:22Z",
      "endRevision": 0,
      "objectName": "string",
      "nodeId": 0,
      "signoffDate": "2019-08-24T14:15:22Z",
      "from": [],
      "objectId": "string",
      "type": "Data"
    },
    "tree": {
      "id": 0,
      "name": "string",
      "edges": [],
      "nodes": [],
      "descendantList": {},
      "version": {}
    },
    "pendingNodes": [
      0
    ],
    "approvedNodes": [
      0
    ]
  }
]
[{"signoff":{"signoffId":0,"signoffName":"string","treeId":0,"startDate":"2019-08-24T14:15:22Z","endRevision":0,"objectName":"string","nodeId":0,"signoffDate":"2019-08-24T14:15:22Z","from":[],"objectId":"string","type":"Data"},"tree":{"id":0,"name":"string","edges":[],"nodes":[],"descendantList":{},"version":{}},"pendingNodes":[0],"approvedNodes":[0]}]

Start signoff.

Body parameter

{
  "property1": "string",
  "property2": "string"
}

Parameters

Name

In

Type

Required

Description

signoffId

path

integer(int32)

true

Signoff ID

body

body

object

false

Dictionary with key named ‘signoffName’ and corresponding value for new signoff name.

» additionalProperties

body

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.PortalAccess.PortalAccessSignoffDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/portalAccessSignoffs/{signoffId}/start", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/portalAccessSignoffs/{signoffId}/start");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "property1": "string",
  "property2": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/portalAccessSignoffs/{signoffId}/start',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/portalAccessSignoffs/{signoffId}/start', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/portalAccessSignoffs/{signoffId}/start',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "signoffId": 0,
  "signoffName": "string",
  "treeId": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "endRevision": 0,
  "objectName": "string",
  "nodeId": 0,
  "signoffDate": "2019-08-24T14:15:22Z",
  "from": [
    "string"
  ],
  "objectId": "string",
  "type": "Data"
}
{"signoffId":0,"signoffName":"string","treeId":0,"startDate":"2019-08-24T14:15:22Z","endRevision":0,"objectName":"string","nodeId":0,"signoffDate":"2019-08-24T14:15:22Z","from":["string"],"objectId":"string","type":"Data"}

Cancel signoff.

Parameters

Name

In

Type

Required

Description

signoffId

path

integer(int32)

true

Signoff ID

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.PortalAccess.PortalAccessSignoffDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/portalAccessSignoffs/{signoffId}/cancel", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/portalAccessSignoffs/{signoffId}/cancel");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/portalAccessSignoffs/{signoffId}/cancel',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/portalAccessSignoffs/{signoffId}/cancel', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/portalAccessSignoffs/{signoffId}/cancel',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "signoffId": 0,
  "signoffName": "string",
  "treeId": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "endRevision": 0,
  "objectName": "string",
  "nodeId": 0,
  "signoffDate": "2019-08-24T14:15:22Z",
  "from": [
    "string"
  ],
  "objectId": "string",
  "type": "Data"
}
{"signoffId":0,"signoffName":"string","treeId":0,"startDate":"2019-08-24T14:15:22Z","endRevision":0,"objectName":"string","nodeId":0,"signoffDate":"2019-08-24T14:15:22Z","from":["string"],"objectId":"string","type":"Data"}

View signoff tree node members.

Parameters

Name

In

Type

Required

Description

signoffId

path

integer(int32)

true

Signoff ID

treeNodeId

path

integer(int32)

true

Tree node ID

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.PortalAccess.PortalAccessSignoffDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/portalAccessSignoffs/{signoffId}/treeNodes/{treeNodeId}/members", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/portalAccessSignoffs/{signoffId}/treeNodes/{treeNodeId}/members");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/portalAccessSignoffs/{signoffId}/treeNodes/{treeNodeId}/members',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/portalAccessSignoffs/{signoffId}/treeNodes/{treeNodeId}/members', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/portalAccessSignoffs/{signoffId}/treeNodes/{treeNodeId}/members',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "signoffId": 0,
  "signoffName": "string",
  "treeId": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "endRevision": 0,
  "objectName": "string",
  "nodeId": 0,
  "signoffDate": "2019-08-24T14:15:22Z",
  "from": [
    "string"
  ],
  "objectId": "string",
  "type": "Data"
}
{"signoffId":0,"signoffName":"string","treeId":0,"startDate":"2019-08-24T14:15:22Z","endRevision":0,"objectName":"string","nodeId":0,"signoffDate":"2019-08-24T14:15:22Z","from":["string"],"objectId":"string","type":"Data"}

Force the approval of all members in the signoff tree node for the given signoff ID and tree node ID.

Body parameter

{
  "property1": 0,
  "property2": 0
}

Parameters

Name

In

Type

Required

Description

signoffId

path

integer(int32)

true

Signoff ID

member

path

string

true

none

body

body

object

false

Dictionary with key named ‘treeNodeId’ and corresponding value for tree node ID.

» additionalProperties

body

integer(int32)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

string

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/portalAccessSignoffs/{signoffId}/approveMembers/{member}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/portalAccessSignoffs/{signoffId}/approveMembers/{member}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "property1": 0,
  "property2": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/portalAccessSignoffs/{signoffId}/approveMembers/{member}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/portalAccessSignoffs/{signoffId}/approveMembers/{member}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/portalAccessSignoffs/{signoffId}/approveMembers/{member}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
"2019-08-24T14:15:22Z"
"2019-08-24T14:15:22Z"

Send emails.

Body parameter

{
  "groupIDs": [
    0
  ],
  "email": {
    "subject": "string",
    "message": "string"
  },
  "isSignoff": true,
  "sendAnyway": true,
  "pendingChecked": true,
  "objectId": "string",
  "type": "Data"
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.PortalAccess.PortalAccessEmailGroupDTO

false

Email details

» groupIDs

body

[integer]¦null

false

none

» email

body

RESTAPI.v1.DTOs.PortalAccess.PortalAccessEmailDTO

false

none

»» subject

body

string¦null

false

none

»» message

body

string¦null

false

none

» isSignoff

body

boolean

false

none

» sendAnyway

body

boolean

false

none

» pendingChecked

body

boolean

false

none

» objectId

body

string¦null

false

none

» type

body

string

false

none

Enumerated Values

Parameter

Value

» type

Data

» type

CompensationPlan

» type

TailoredReport

» type

Document

» type

WebForm

» type

WebReport

» type

WebTab

» type

CompPlanManager

» type

WebTabGroup

» type

ExternalURL

» type

RapidReport

» type

Table

» type

DataStore

» type

DDE

» type

DDEInfographic

» type

PayeeDocument

» type

PresenterAdaptive

» type

DirectLink

» type

AdaptiveForm

» type

StandardReport

» type

SalesPlanningMap

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/portalaccessEmail", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/portalaccessEmail");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "groupIDs": [
    0
  ],
  "email": {
    "subject": "string",
    "message": "string"
  },
  "isSignoff": true,
  "sendAnyway": true,
  "pendingChecked": true,
  "objectId": "string",
  "type": "Data"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/portalaccessEmail',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/portalaccessEmail', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/portalaccessEmail',
  params: {
  }, headers: headers

p JSON.parse(result)

Get all trees.

Parameters

Name

In

Type

Required

Description

filter

query

string

false

none

orderBy

query

string

false

####Description

Detailed descriptions

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

treeid

Responses

Status

Meaning

Description

Schema

200

OK

Get all trees

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Workflow.WorkflowTreeDTO]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» edges

[Varicent.RESTAPI.v1.DTOs.Workflow.WorkflowTreeEdgeDTO]¦null

false

none

none

»» start

integer(int32)

false

none

none

»» end

integer(int32)

false

none

none

» nodes

[Varicent.RESTAPI.v1.DTOs.Workflow.WorkflowTreeNodeDTO]¦null

false

none

none

»» nodeId

integer(int32)

false

none

none

»» groupId

integer(int32)

false

none

none

»» name

string¦null

false

none

none

»» signOffType

string

false

none

none

»» canAdjust

boolean

false

none

none

» descendantList

object¦null

false

none

none

»» additionalProperties

[integer]

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

Enumerated Values

Property

Value

signOffType

AnySignOff

signOffType

AllSignOff

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/portalaccesstrees", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/portalaccesstrees");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/portalaccesstrees',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/portalaccesstrees', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/portalaccesstrees',
  params: {
  }, headers: headers

p JSON.parse(result)

Create a new tree.

Body parameter

{
  "id": 0,
  "name": "string",
  "edges": [
    {
      "start": 0,
      "end": 0
    }
  ],
  "nodes": [
    {
      "nodeId": 0,
      "groupId": 0,
      "name": "string",
      "signOffType": "AnySignOff",
      "canAdjust": true
    }
  ],
  "descendantList": {
    "property1": [
      0
    ],
    "property2": [
      0
    ]
  },
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Workflow.WorkflowTreeDTO

false

none

» id

body

integer(int32)

false

none

» name

body

string¦null

false

none

» edges

body

[Varicent.RESTAPI.v1.DTOs.Workflow.WorkflowTreeEdgeDTO]¦null

false

none

»» start

body

integer(int32)

false

none

»» end

body

integer(int32)

false

none

» nodes

body

[Varicent.RESTAPI.v1.DTOs.Workflow.WorkflowTreeNodeDTO]¦null

false

none

»» nodeId

body

integer(int32)

false

none

»» groupId

body

integer(int32)

false

none

»» name

body

string¦null

false

none

»» signOffType

body

string

false

none

»» canAdjust

body

boolean

false

none

» descendantList

body

object¦null

false

none

»» additionalProperties

body

[integer]

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Enumerated Values

Parameter

Value

»» signOffType

AnySignOff

»» signOffType

AllSignOff

Responses

Status

Meaning

Description

Schema

200

OK

Create a new tree

Varicent.RESTAPI.v1.DTOs.Workflow.WorkflowTreeDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/portalaccesstrees", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/portalaccesstrees");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "name": "string",
  "edges": [
    {
      "start": 0,
      "end": 0
    }
  ],
  "nodes": [
    {
      "nodeId": 0,
      "groupId": 0,
      "name": "string",
      "signOffType": "AnySignOff",
      "canAdjust": true
    }
  ],
  "descendantList": {
    "property1": [
      0
    ],
    "property2": [
      0
    ]
  },
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/portalaccesstrees',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/portalaccesstrees', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/portalaccesstrees',
  params: {
  }, headers: headers

p JSON.parse(result)

Get one tree.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get all trees

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Workflow.WorkflowTreeDTO]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» edges

[Varicent.RESTAPI.v1.DTOs.Workflow.WorkflowTreeEdgeDTO]¦null

false

none

none

»» start

integer(int32)

false

none

none

»» end

integer(int32)

false

none

none

» nodes

[Varicent.RESTAPI.v1.DTOs.Workflow.WorkflowTreeNodeDTO]¦null

false

none

none

»» nodeId

integer(int32)

false

none

none

»» groupId

integer(int32)

false

none

none

»» name

string¦null

false

none

none

»» signOffType

string

false

none

none

»» canAdjust

boolean

false

none

none

» descendantList

object¦null

false

none

none

»» additionalProperties

[integer]

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

Enumerated Values

Property

Value

signOffType

AnySignOff

signOffType

AllSignOff

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/portalaccesstrees/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/portalaccesstrees/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/portalaccesstrees/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/portalaccesstrees/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/portalaccesstrees/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "name": "string",
    "edges": [
      {}
    ],
    "nodes": [
      {}
    ],
    "descendantList": {
      "property1": [],
      "property2": []
    },
    "version": {
      "rowVersion": 0
    }
  }
]
[{"id":0,"name":"string","edges":[{}],"nodes":[{}],"descendantList":{"property1":[],"property2":[]},"version":{"rowVersion":0}}]

Delete a tree.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Delete a tree

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/portalaccesstrees/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/portalaccesstrees/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/portalaccesstrees/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/portalaccesstrees/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/portalaccesstrees/{id}',
  params: {
  }

p JSON.parse(result)

Update a tree.

Body parameter

{
  "treeName": "string",
  "parentColumn": {
    "path": {
      "path": []
    },
    "column": "string",
    "alias": "string"
  },
  "groupDefinitionColumn": {
    "path": {
      "path": []
    },
    "column": "string",
    "alias": "string"
  },
  "maintainGroups": true,
  "source": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  }
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.PortalAccess.TreeBuilderDTO

false

none

» treeName

body

string¦null

false

none

» parentColumn

body

Varicent.RESTAPI.v1.DTOs.DataItemDTO

false

none

»» path

body

RESTAPI.v1.DTOs.DataPathDTO

false

none

»»» path

body

[string]¦null

false

none

»» column

body

string¦null

false

none

»» alias

body

string¦null

false

none

» groupDefinitionColumn

body

Varicent.RESTAPI.v1.DTOs.DataItemDTO

false

none

» maintainGroups

body

boolean

false

none

» source

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»» alias

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» table

body

string¦null

false

none

»»»» customSelect

body

string¦null

false

none

»»»» dataType

body

string

false

none

»»»» type

body

string

false

none

»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»» expressionType

body

string

false

none

»»»»»» cases

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» arguments

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»» constraintType

body

string

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» expressionType

body

string

false

none

»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» column

body

string¦null

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» condition

body

any

false

none

»»»»»»»» trueValue

body

any

false

none

»»»»»»»» falseValue

body

any

false

none

»»»»»»»» isDate

body

boolean

false

none

»»»»»»»» literalType

body

string

false

none

»»»»»»»» value

body

any

false

none

»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»» constraints

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» literalRight

body

any

false

none

»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» right

body

any

false

none

»»»»»»» expressionLeft

body

any

false

none

»»»»»»» expressionRight

body

any

false

none

»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»» like

body

string¦null

false

none

»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»» trueValue

body

any

false

none

»»»»»» falseValue

body

any

false

none

»»»»»» isDate

body

boolean

false

none

»»»»»» literalType

body

string

false

none

»»»»»» value

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»» m_namespace

body

string¦null

false

none

»»»»» name

body

string¦null

false

none

»»»» query

body

any

false

none

»»»» alias

body

string¦null

false

none

»»»» sourceType

body

string

false

none

»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»» joinType

body

string

false

none

»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»» constraintType

body

string

false

none

»»»»» op

body

string¦null

false

none

»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» caseSensitive

body

boolean

false

none

»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»» isPreciseDecimal

body

boolean

false

none

»»»»» like

body

string¦null

false

none

»»»»» escapeWildcards

body

boolean

false

none

»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»» table

body

string¦null

false

none

»»»»» queryDefinitionRight

body

any

false

none

»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» direction

body

string

false

none

»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»» distinct

body

boolean

false

none

»»» unionWith

body

any

false

none

»»» exceptWith

body

any

false

none

»» sourceNames

body

object¦null

false

none

»»» additionalProperties

body

string¦null

false

none

Enumerated Values

Parameter

Value

»»»» dataType

Int

»»»» dataType

Decimal

»»»» dataType

DateTime

»»»» dataType

None

»»»» dataType

String

»»»» type

SelectAll

»»»» type

SelectItem

»»»» type

SelectLiteral

»»»» type

SelectCustom

»»»» type

SelectExpression

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» expressionType

caseExpression

»»»»»» expressionType

dataField

»»»»»» expressionType

function

»»»»»» expressionType

ifExpression

»»»»»» expressionType

literal

»»»»»»» constraintType

clause

»»»»»»» constraintType

constraint

»»»»»»» constraintType

expressionConstraint

»»»»»»» constraintType

likeConstraint

»»»»»»» constraintType

rowVersionConstraint

»»»»»»» constraintType

subQueryConstraint

»»»»»»»» expressionType

caseExpression

»»»»»»»» expressionType

dataField

»»»»»»»» expressionType

function

»»»»»»»» expressionType

ifExpression

»»»»»»»» expressionType

literal

»»»»»»»» literalType

Integer

»»»»»»»» literalType

Decimal

»»»»»»»» literalType

Date

»»»»»»»» literalType

DateTime

»»»»»»»» literalType

String

»»»»»»»» literalType

Float

»»»»»»»» literalType

Long

»»»»»»»» literalType

Null

»»»»»»»» literalType

Parameter

»»»»»»»» literalType

Guid

»»»»»»»» literalType

SystemUtcTime

»»»»»»»» literalType

Boolean

»»»»»» literalType

Integer

»»»»»» literalType

Decimal

»»»»»» literalType

Date

»»»»»» literalType

DateTime

»»»»»» literalType

String

»»»»»» literalType

Float

»»»»»» literalType

Long

»»»»»» literalType

Null

»»»»»» literalType

Parameter

»»»»»» literalType

Guid

»»»»»» literalType

SystemUtcTime

»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» sourceType

Table

»»»» sourceType

Query

»»»» joinType

Inner

»»»» joinType

Left

»»»» joinType

Right

»»»» joinType

Cross

»»»» joinType

CrossApply

»»»» joinType

OuterApply

»»»»» constraintType

clause

»»»»» constraintType

constraint

»»»»» constraintType

expressionConstraint

»»»»» constraintType

likeConstraint

»»»»» constraintType

rowVersionConstraint

»»»»» constraintType

subQueryConstraint

»»»» direction

Ascending

»»»» direction

Descending

»»»» direction

AscendingNullsFirst

»»»» direction

DescendingNullsLast

Responses

Status

Meaning

Description

Schema

200

OK

Run tree builder asynchronously

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/treebuilder", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/treebuilder");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "treeName": "string",
  "parentColumn": {
    "path": {
      "path": []
    },
    "column": "string",
    "alias": "string"
  },
  "groupDefinitionColumn": {
    "path": {
      "path": []
    },
    "column": "string",
    "alias": "string"
  },
  "maintainGroups": true,
  "source": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/treebuilder',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/treebuilder', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/treebuilder',
  params: {
  }, headers: headers

p JSON.parse(result)

Get web tabs.

Parameters

Name

In

Type

Required

Description

filter

query

string

false

####Supported operations

orderBy

query

string

false

####Description

Detailed descriptions

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

workflowobjectid

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

name

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.PortalAccess.WebTabDTO]

false

none

none

» name

string¦null

false

none

none

» tabType

string

false

none

none

» externalURL

string¦null

false

none

none

» objectId

string¦null

false

none

none

» objectName

string¦null

false

none

none

» objectType

string¦null

false

none

none

» workflowObjectId

integer(int32)

false

none

none

» nameEnum

string¦null

false

none

none

» mobileEnabled

boolean¦null

false

none

none

» mobileWebAccess

string¦null

false

none

none

» slackEnabled

boolean¦null

false

none

none

» headerEnabled

boolean¦null

false

none

none

» footerEnabled

boolean¦null

false

none

none

» id

integer(int32)

false

none

none

» parent

integer(int32)¦null

false

none

none

» oldParent

integer(int32)¦null

false

none

none

» prev

integer(int32)¦null

false

none

none

» oldPrev

integer(int32)¦null

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

Enumerated Values

Property

Value

tabType

WebModule

tabType

TabGroup

tabType

CompensationPlan

tabType

TailoredReport

tabType

WebForm

tabType

PresenterReport

tabType

None

tabType

ExternalURL

tabType

CompPlanManager

tabType

RapidReport

tabType

DDE

tabType

DDEInfographic

tabType

PresenterAdaptive

tabType

DirectLink

tabType

AdaptiveForm

tabType

StandardReport

tabType

SalesPlanningMap

nameEnum

PayeeLedger

nameEnum

Inquiries

nameEnum

DataEdit

nameEnum

WebForms

nameEnum

Reporting

nameEnum

CompPlanManager

mobileWebAccess

WebOnly

mobileWebAccess

MobileAndWeb

mobileWebAccess

MobileOnly

mobileWebAccess

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/webtabs", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webtabs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webtabs',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/webtabs', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/webtabs',
  params: {
  }, headers: headers

p JSON.parse(result)

Create a new WebTab.

Body parameter

{
  "name": "string",
  "tabType": "WebModule",
  "externalURL": "string",
  "objectId": "string",
  "objectName": "string",
  "objectType": "string",
  "workflowObjectId": 0,
  "nameEnum": "PayeeLedger",
  "mobileEnabled": true,
  "mobileWebAccess": "WebOnly",
  "slackEnabled": true,
  "headerEnabled": true,
  "footerEnabled": true,
  "id": 0,
  "parent": 0,
  "oldParent": 0,
  "prev": 0,
  "oldPrev": 0,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.PortalAccess.WebTabDTO

false

WebTab to be created

» name

body

string¦null

false

none

» tabType

body

string

false

none

» externalURL

body

string¦null

false

none

» objectId

body

string¦null

false

none

» objectName

body

string¦null

false

none

» objectType

body

string¦null

false

none

» workflowObjectId

body

integer(int32)

false

none

» nameEnum

body

string¦null

false

none

» mobileEnabled

body

boolean¦null

false

none

» mobileWebAccess

body

string¦null

false

none

» slackEnabled

body

boolean¦null

false

none

» headerEnabled

body

boolean¦null

false

none

» footerEnabled

body

boolean¦null

false

none

» id

body

integer(int32)

false

none

» parent

body

integer(int32)¦null

false

none

» oldParent

body

integer(int32)¦null

false

none

» prev

body

integer(int32)¦null

false

none

» oldPrev

body

integer(int32)¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Enumerated Values

Parameter

Value

» tabType

WebModule

» tabType

TabGroup

» tabType

CompensationPlan

» tabType

TailoredReport

» tabType

WebForm

» tabType

PresenterReport

» tabType

None

» tabType

ExternalURL

» tabType

CompPlanManager

» tabType

RapidReport

» tabType

DDE

» tabType

DDEInfographic

» tabType

PresenterAdaptive

» tabType

DirectLink

» tabType

AdaptiveForm

» tabType

StandardReport

» tabType

SalesPlanningMap

» nameEnum

PayeeLedger

» nameEnum

Inquiries

» nameEnum

DataEdit

» nameEnum

WebForms

» nameEnum

Reporting

» nameEnum

CompPlanManager

» mobileWebAccess

WebOnly

» mobileWebAccess

MobileAndWeb

» mobileWebAccess

MobileOnly

» mobileWebAccess

None

Responses

Status

Meaning

Description

Schema

200

OK

Create new WebTab

RESTAPI.v1.DTOs.PortalAccess.WebTabDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/webtabs", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webtabs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "name": "string",
  "tabType": "WebModule",
  "externalURL": "string",
  "objectId": "string",
  "objectName": "string",
  "objectType": "string",
  "workflowObjectId": 0,
  "nameEnum": "PayeeLedger",
  "mobileEnabled": true,
  "mobileWebAccess": "WebOnly",
  "slackEnabled": true,
  "headerEnabled": true,
  "footerEnabled": true,
  "id": 0,
  "parent": 0,
  "oldParent": 0,
  "prev": 0,
  "oldPrev": 0,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webtabs',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/webtabs', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/webtabs',
  params: {
  }, headers: headers

p JSON.parse(result)

Delete a WebTab and update the next Webtab in the tree.

Body parameter

[
  {
    "name": "string",
    "tabType": "WebModule",
    "externalURL": "string",
    "objectId": "string",
    "objectName": "string",
    "objectType": "string",
    "workflowObjectId": 0,
    "nameEnum": "PayeeLedger",
    "mobileEnabled": true,
    "mobileWebAccess": "WebOnly",
    "slackEnabled": true,
    "headerEnabled": true,
    "footerEnabled": true,
    "id": 0,
    "parent": 0,
    "oldParent": 0,
    "prev": 0,
    "oldPrev": 0,
    "version": {
      "rowVersion": 0
    }
  }
]

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.PortalAccess.WebTabDTO

false

A list of WebTabs. It only allows one WebTab if there is no WebTab after it.

Detailed descriptions

body: A list of WebTabs. It only allows one WebTab if there is no WebTab after it. Or two WebTabs which are one that is to be deleted and the next one in the tree.

Responses

Status

Meaning

Description

Schema

200

OK

Delete Web Tab and update next web tab

RESTAPI.v1.DTOs.PortalAccess.WebTabDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/webtabs", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webtabs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "name": "string",
    "tabType": "WebModule",
    "externalURL": "string",
    "objectId": "string",
    "objectName": "string",
    "objectType": "string",
    "workflowObjectId": 0,
    "nameEnum": "PayeeLedger",
    "mobileEnabled": true,
    "mobileWebAccess": "WebOnly",
    "slackEnabled": true,
    "headerEnabled": true,
    "footerEnabled": true,
    "id": 0,
    "parent": 0,
    "oldParent": 0,
    "prev": 0,
    "oldPrev": 0,
    "version": {
      "rowVersion": 0
    }
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webtabs',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/webtabs', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/webtabs',
  params: {
  }, headers: headers

p JSON.parse(result)

Get an individual WebTab item by ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

ID of the WebTab

Responses

Status

Meaning

Description

Schema

200

OK

Get individual WebTab item by ID

RESTAPI.v1.DTOs.PortalAccess.WebTabDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/webtabs/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webtabs/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webtabs/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/webtabs/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/webtabs/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "name": "string",
  "tabType": "WebModule",
  "externalURL": "string",
  "objectId": "string",
  "objectName": "string",
  "objectType": "string",
  "workflowObjectId": 0,
  "nameEnum": "PayeeLedger",
  "mobileEnabled": true,
  "mobileWebAccess": "WebOnly",
  "slackEnabled": true,
  "headerEnabled": true,
  "footerEnabled": true,
  "id": 0,
  "parent": 0,
  "oldParent": 0,
  "prev": 0,
  "oldPrev": 0,
  "version": {
    "rowVersion": 0
  }
}
{"name":"string","tabType":"WebModule","externalURL":"string","objectId":"string","objectName":"string","objectType":"string","workflowObjectId":0,"nameEnum":"PayeeLedger","mobileEnabled":true,"mobileWebAccess":"WebOnly","slackEnabled":true,"headerEnabled":true,"footerEnabled":true,"id":0,"parent":0,"oldParent":0,"prev":0,"oldPrev":0,"version":{"rowVersion":0}}

Update an individual WebTab item.

Body parameter

{
  "name": "string",
  "tabType": "WebModule",
  "externalURL": "string",
  "objectId": "string",
  "objectName": "string",
  "objectType": "string",
  "workflowObjectId": 0,
  "nameEnum": "PayeeLedger",
  "mobileEnabled": true,
  "mobileWebAccess": "WebOnly",
  "slackEnabled": true,
  "headerEnabled": true,
  "footerEnabled": true,
  "id": 0,
  "parent": 0,
  "oldParent": 0,
  "prev": 0,
  "oldPrev": 0,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

ID of the WebTab.

body

body

RESTAPI.v1.DTOs.PortalAccess.WebTabDTO

false

Updated WebTabDTO.

» name

body

string¦null

false

none

» tabType

body

string

false

none

» externalURL

body

string¦null

false

none

» objectId

body

string¦null

false

none

» objectName

body

string¦null

false

none

» objectType

body

string¦null

false

none

» workflowObjectId

body

integer(int32)

false

none

» nameEnum

body

string¦null

false

none

» mobileEnabled

body

boolean¦null

false

none

» mobileWebAccess

body

string¦null

false

none

» slackEnabled

body

boolean¦null

false

none

» headerEnabled

body

boolean¦null

false

none

» footerEnabled

body

boolean¦null

false

none

» id

body

integer(int32)

false

none

» parent

body

integer(int32)¦null

false

none

» oldParent

body

integer(int32)¦null

false

none

» prev

body

integer(int32)¦null

false

none

» oldPrev

body

integer(int32)¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Enumerated Values

Parameter

Value

» tabType

WebModule

» tabType

TabGroup

» tabType

CompensationPlan

» tabType

TailoredReport

» tabType

WebForm

» tabType

PresenterReport

» tabType

None

» tabType

ExternalURL

» tabType

CompPlanManager

» tabType

RapidReport

» tabType

DDE

» tabType

DDEInfographic

» tabType

PresenterAdaptive

» tabType

DirectLink

» tabType

AdaptiveForm

» tabType

StandardReport

» tabType

SalesPlanningMap

» nameEnum

PayeeLedger

» nameEnum

Inquiries

» nameEnum

DataEdit

» nameEnum

WebForms

» nameEnum

Reporting

» nameEnum

CompPlanManager

» mobileWebAccess

WebOnly

» mobileWebAccess

MobileAndWeb

» mobileWebAccess

MobileOnly

» mobileWebAccess

None

Responses

Status

Meaning

Description

Schema

200

OK

Update individual WebTab item.

RESTAPI.v1.DTOs.PortalAccess.WebTabDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/webtabs/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/webtabs/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "name": "string",
  "tabType": "WebModule",
  "externalURL": "string",
  "objectId": "string",
  "objectName": "string",
  "objectType": "string",
  "workflowObjectId": 0,
  "nameEnum": "PayeeLedger",
  "mobileEnabled": true,
  "mobileWebAccess": "WebOnly",
  "slackEnabled": true,
  "headerEnabled": true,
  "footerEnabled": true,
  "id": 0,
  "parent": 0,
  "oldParent": 0,
  "prev": 0,
  "oldPrev": 0,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/webtabs/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/webtabs/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/webtabs/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

Inquiry

Reopen a closed inquiry. This endpoint is used by admin.

Parameters

Name

In

Type

Required

Description

inquiryID

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/workflowmanager/bpmInquiries/reopenInquiry/{inquiryID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/bpmInquiries/reopenInquiry/{inquiryID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/workflowmanager/bpmInquiries/reopenInquiry/{inquiryID}',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/v1/workflowmanager/bpmInquiries/reopenInquiry/{inquiryID}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/v1/workflowmanager/bpmInquiries/reopenInquiry/{inquiryID}',
  params: {
  }

p JSON.parse(result)

Reopen a closed inquiry. This endpoint is used by payee.

Parameters

Name

In

Type

Required

Description

inquiryID

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/payee/workflowmanager/bpmInquiries/reopenInquiry/{inquiryID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payee/workflowmanager/bpmInquiries/reopenInquiry/{inquiryID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/payee/workflowmanager/bpmInquiries/reopenInquiry/{inquiryID}',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/v1/payee/workflowmanager/bpmInquiries/reopenInquiry/{inquiryID}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/v1/payee/workflowmanager/bpmInquiries/reopenInquiry/{inquiryID}',
  params: {
  }

p JSON.parse(result)

Add a comment to the given inquiry.

Body parameter

{
  "author": "string",
  "created": "2019-08-24T14:15:22Z",
  "text": "string"
}

Parameters

Name

In

Type

Required

Description

inquiryID

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.PortalAccess.DisputeCommentDTO

false

Only the text field needs to be specified

» author

body

string¦null

false

none

» created

body

string(date-time)

false

none

» text

body

string¦null

false

none

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None

404

Not Found

Provided ID was not correct

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/inquiries/{inquiryID}/comments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/inquiries/{inquiryID}/comments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "author": "string",
  "created": "2019-08-24T14:15:22Z",
  "text": "string"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/inquiries/{inquiryID}/comments',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/inquiries/{inquiryID}/comments', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/inquiries/{inquiryID}/comments',
  params: {
  }, headers: headers

p JSON.parse(result)

Upload attachments to an inquiry.

Body parameter

[
  {
    "bytes": "string",
    "path": "string"
  }
]

Parameters

Name

In

Type

Required

Description

inquiryID

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.PortalAccess.AttachmentItemDTO

false

“bytes” shold be the base64-encoded content of the file. “path” has to contain at least the filename. Only the filename component of the path is stored

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/workflowmanager/bpmInquiries/{inquiryID}/attachments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/bpmInquiries/{inquiryID}/attachments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "bytes": "string",
    "path": "string"
  }
]';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/workflowmanager/bpmInquiries/{inquiryID}/attachments',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/workflowmanager/bpmInquiries/{inquiryID}/attachments', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/workflowmanager/bpmInquiries/{inquiryID}/attachments',
  params: {
  }, headers: headers

p JSON.parse(result)

Download an attachment for an inquiry.

Parameters

Name

In

Type

Required

Description

inquiryID

path

integer(int32)

true

none

fileName

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.FileContentDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/inquiries/{inquiryID}/attachments/{fileName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/inquiries/{inquiryID}/attachments/{fileName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/inquiries/{inquiryID}/attachments/{fileName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/inquiries/{inquiryID}/attachments/{fileName}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/inquiries/{inquiryID}/attachments/{fileName}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "filename": "string",
  "data64": "string"
}
{"filename":"string","data64":"string"}

Delete an attachment for an inquiry.

Parameters

Name

In

Type

Required

Description

inquiryID

path

integer(int32)

true

none

fileName

path

string

true

none

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/workflowmanager/bpmInquiries/{inquiryID}/attachments/{fileName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/workflowmanager/bpmInquiries/{inquiryID}/attachments/{fileName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/workflowmanager/bpmInquiries/{inquiryID}/attachments/{fileName}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/workflowmanager/bpmInquiries/{inquiryID}/attachments/{fileName}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/workflowmanager/bpmInquiries/{inquiryID}/attachments/{fileName}',
  params: {
  }

p JSON.parse(result)

Retrieves an inquiry by ID.

Parameters

Name

In

Type

Required

Description

inquiryID

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.PortalAccess.DisputeDefinitionDTO

404

Not Found

Provided ID was not correct

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/inquiries/{inquiryID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/inquiries/{inquiryID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/inquiries/{inquiryID}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/inquiries/{inquiryID}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/inquiries/{inquiryID}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "disputeId": 0,
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z",
  "creatorId": "string",
  "creatorName": "string",
  "status": "Open",
  "category": 0,
  "groupName": "string",
  "groupId": 0,
  "version": {
    "rowVersion": 0
  }
}
{"disputeId":0,"created":"2019-08-24T14:15:22Z","updated":"2019-08-24T14:15:22Z","creatorId":"string","creatorName":"string","status":"Open","category":0,"groupName":"string","groupId":0,"version":{"rowVersion":0}}

Modifies the status or category of an inquiry, or both.

Body parameter

{
  "disputeId": 0,
  "status": "Open",
  "category": 0,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

inquiryID

path

integer(int32)

true

ID of the inquiry

body

body

Varicent.RESTAPI.v1.DTOs.PortalAccess.DisputePatchDTO

false

none

» disputeId

body

integer(int32)

false

none

» status

body

string

false

none

» category

body

integer(int32)

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Enumerated Values

Parameter

Value

» status

Open

» status

Invalid

» status

Fixed

» status

Closed

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.PortalAccess.DisputeDefinitionDTO

404

Not Found

Provided ID was not correct

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/inquiries/{inquiryID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/inquiries/{inquiryID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "disputeId": 0,
  "status": "Open",
  "category": 0,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/inquiries/{inquiryID}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/v1/inquiries/{inquiryID}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/v1/inquiries/{inquiryID}',
  params: {
  }, headers: headers

p JSON.parse(result)

Retrieves all comments for the given inquiry.

Parameters

Name

In

Type

Required

Description

inquiryID

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

404

Not Found

Provided ID was not correct

None

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.PortalAccess.DisputeCommentDTO]

false

none

none

» author

string¦null

false

none

none

» created

string(date-time)

false

none

none

» text

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/inquiries/{inquiryID}/comments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/inquiries/{inquiryID}/comments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/inquiries/{inquiryID}/comments',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/inquiries/{inquiryID}/comments', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/inquiries/{inquiryID}/comments',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "author": "string",
    "created": "2019-08-24T14:15:22Z",
    "text": "string"
  }
]
[{"author":"string","created":"2019-08-24T14:15:22Z","text":"string"}]

Get inquiries assigned to admins for any object or a portal access group for a particular object,

or inquiries created by a portal access group for a particular object

Parameters

Name

In

Type

Required

Description

filter

query

string

false

For inquiries assigned to admins, specify “assignedGroup=”.

Detailed descriptions

filter: For inquiries assigned to admins, specify “assignedGroup=”. For inquiries assigned to a group for an object, specify “assignedGroup=GROUPID;objectID=OBJECTID”, where OBJECTID is the WorkflowObjectID of the object. For inquiries created by a group for an object, specify “creatorGroup=GROUPID;objectID=OBJECTID”. For inquiries to get all created for an object, specify “objectID=OBJECTID;created=true” For inquiries to get all assigned for an object, specify “objectID=OBJECTID;created=false” No other filters are supported.

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.PortalAccess.DisputeDefinitionDTO]

false

none

none

» disputeId

integer(int32)

false

none

none

» created

string(date-time)

false

none

none

» updated

string(date-time)

false

none

none

» creatorId

string¦null

false

none

none

» creatorName

string¦null

false

none

none

» status

string

false

none

none

» category

integer(int32)

false

none

none

» groupName

string¦null

false

none

none

» groupId

integer(int32)

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

Enumerated Values

Property

Value

status

Open

status

Invalid

status

Fixed

status

Closed

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/inquiries", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/inquiries");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/inquiries',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/inquiries', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/inquiries',
  params: {
  }, headers: headers

p JSON.parse(result)

Enables inquiries.

Body parameter

{
  "workflowTreeID": 0,
  "objectType": "Data",
  "objectID": "string"
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.PortalAccess.EnableDisableInquiriesDTO

false

none

» workflowTreeID

body

integer(int32)

false

none

» objectType

body

string

false

none

» objectID

body

string¦null

false

none

Enumerated Values

Parameter

Value

» objectType

Data

» objectType

CompensationPlan

» objectType

TailoredReport

» objectType

Document

» objectType

WebForm

» objectType

WebReport

» objectType

WebTab

» objectType

CompPlanManager

» objectType

WebTabGroup

» objectType

ExternalURL

» objectType

RapidReport

» objectType

Table

» objectType

DataStore

» objectType

DDE

» objectType

DDEInfographic

» objectType

PayeeDocument

» objectType

PresenterAdaptive

» objectType

DirectLink

» objectType

AdaptiveForm

» objectType

StandardReport

» objectType

SalesPlanningMap

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/enableinquiries", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/enableinquiries");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "workflowTreeID": 0,
  "objectType": "Data",
  "objectID": "string"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/enableinquiries',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/enableinquiries', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/enableinquiries',
  params: {
  }, headers: headers

p JSON.parse(result)

Update ResubmitToReturner state.

Body parameter

{
  "objectType": "Data",
  "objectID": "string",
  "state": true
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.PortalAccess.UpdateResubmitToReturnerDTO

false

none

» objectType

body

string

false

none

» objectID

body

string¦null

false

none

» state

body

boolean

false

none

Enumerated Values

Parameter

Value

» objectType

Data

» objectType

CompensationPlan

» objectType

TailoredReport

» objectType

Document

» objectType

WebForm

» objectType

WebReport

» objectType

WebTab

» objectType

CompPlanManager

» objectType

WebTabGroup

» objectType

ExternalURL

» objectType

RapidReport

» objectType

Table

» objectType

DataStore

» objectType

DDE

» objectType

DDEInfographic

» objectType

PayeeDocument

» objectType

PresenterAdaptive

» objectType

DirectLink

» objectType

AdaptiveForm

» objectType

StandardReport

» objectType

SalesPlanningMap

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/updateresubmit", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/updateresubmit");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "objectType": "Data",
  "objectID": "string",
  "state": true
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/updateresubmit',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/updateresubmit', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/updateresubmit',
  params: {
  }, headers: headers

p JSON.parse(result)

Disables inquiries

Body parameter

{
  "workflowTreeID": 0,
  "objectType": "Data",
  "objectID": "string"
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.PortalAccess.EnableDisableInquiriesDTO

false

none

» workflowTreeID

body

integer(int32)

false

none

» objectType

body

string

false

none

» objectID

body

string¦null

false

none

Enumerated Values

Parameter

Value

» objectType

Data

» objectType

CompensationPlan

» objectType

TailoredReport

» objectType

Document

» objectType

WebForm

» objectType

WebReport

» objectType

WebTab

» objectType

CompPlanManager

» objectType

WebTabGroup

» objectType

ExternalURL

» objectType

RapidReport

» objectType

Table

» objectType

DataStore

» objectType

DDE

» objectType

DDEInfographic

» objectType

PayeeDocument

» objectType

PresenterAdaptive

» objectType

DirectLink

» objectType

AdaptiveForm

» objectType

StandardReport

» objectType

SalesPlanningMap

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/disableinquiries", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/disableinquiries");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "workflowTreeID": 0,
  "objectType": "Data",
  "objectID": "string"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/disableinquiries',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/disableinquiries', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/disableinquiries',
  params: {
  }, headers: headers

p JSON.parse(result)

Returns a boolean indicating whether or not inquiries are enabled for a particular tree and object.

Parameters

Name

In

Type

Required

Description

workflowTreeID

query

integer(int32)

false

none

objectType

query

string

false

none

objectID

query

string

false

none

Enumerated Values

Parameter

Value

objectType

Data

objectType

CompensationPlan

objectType

TailoredReport

objectType

Document

objectType

WebForm

objectType

WebReport

objectType

WebTab

objectType

CompPlanManager

objectType

WebTabGroup

objectType

ExternalURL

objectType

RapidReport

objectType

Table

objectType

DataStore

objectType

DDE

objectType

DDEInfographic

objectType

PayeeDocument

objectType

PresenterAdaptive

objectType

DirectLink

objectType

AdaptiveForm

objectType

StandardReport

objectType

SalesPlanningMap

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

boolean

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/inquiriesenabledstatus", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/inquiriesenabledstatus");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/inquiriesenabledstatus',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/inquiriesenabledstatus', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/inquiriesenabledstatus',
  params: {
  }, headers: headers

p JSON.parse(result)

Returns a boolean indicating whether or not ResubmitToReturner are enabled for a particular workflow object.

Parameters

Name

In

Type

Required

Description

workflowTreeID

query

integer(int32)

false

none

objectType

query

string

false

none

objectID

query

string

false

none

Enumerated Values

Parameter

Value

objectType

Data

objectType

CompensationPlan

objectType

TailoredReport

objectType

Document

objectType

WebForm

objectType

WebReport

objectType

WebTab

objectType

CompPlanManager

objectType

WebTabGroup

objectType

ExternalURL

objectType

RapidReport

objectType

Table

objectType

DataStore

objectType

DDE

objectType

DDEInfographic

objectType

PayeeDocument

objectType

PresenterAdaptive

objectType

DirectLink

objectType

AdaptiveForm

objectType

StandardReport

objectType

SalesPlanningMap

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

boolean

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/inquiriesresubmittoreturnerstatus", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/inquiriesresubmittoreturnerstatus");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/inquiriesresubmittoreturnerstatus',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/inquiriesresubmittoreturnerstatus', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/inquiriesresubmittoreturnerstatus',
  params: {
  }, headers: headers

p JSON.parse(result)

Upload an attachment to an inquiry.

Body parameter

{
  "bytes": "string",
  "path": "string"
}

Parameters

Name

In

Type

Required

Description

inquiryID

path

integer(int32)

true

none

body

body

Varicent.RESTAPI.v1.DTOs.PortalAccess.AttachmentItemDTO

false

“bytes” shold be the base64-encoded content of the file. “path” has to contain at least the filename. Only the filename component of the path is stored

» bytes

body

string¦null

false

none

» path

body

string¦null

false

none

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/inquiries/{inquiryID}/attachments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/inquiries/{inquiryID}/attachments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "bytes": "string",
  "path": "string"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/inquiries/{inquiryID}/attachments',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/inquiries/{inquiryID}/attachments', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/inquiries/{inquiryID}/attachments',
  params: {
  }, headers: headers

p JSON.parse(result)

Get a list of attachments for an inquiry.

Parameters

Name

In

Type

Required

Description

inquiryID

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

List of file names for an inquiry’s attachments.

Inline

404

Not Found

Inquiry cannot be found.

None

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/inquiries/{inquiryID}/attachments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/inquiries/{inquiryID}/attachments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/inquiries/{inquiryID}/attachments',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/inquiries/{inquiryID}/attachments', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/inquiries/{inquiryID}/attachments',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  "string"
]
["string"]

Creates a new inquiry category.

Body parameter

{
  "id": 0,
  "name": "string",
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.PortalAccess.DisputeCategoryDTO

false

none

» id

body

integer(int32)

false

none

» name

body

string¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.PortalAccess.DisputeCategoryDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/inquirycategories", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/inquirycategories");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "name": "string",
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/inquirycategories',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/inquirycategories', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/inquirycategories',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "version": {
    "rowVersion": 0
  }
}
{"id":0,"name":"string","version":{"rowVersion":0}}

Lists all the inquiry categories available.

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.PortalAccess.DisputeCategoryDTO]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/inquirycategories", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/inquirycategories");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/inquirycategories',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/inquirycategories', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/inquirycategories',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "name": "string",
    "version": {
      "rowVersion": 0
    }
  }
]
[{"id":0,"name":"string","version":{"rowVersion":0}}]

Delete a specific inquiry category.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

The ID of the inquiry category to delete.

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

404

Not Found

Inquiry with the specified ID was not found

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/inquirycategories/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/inquirycategories/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/inquirycategories/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/inquirycategories/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/inquirycategories/{id}',
  params: {
  }

p JSON.parse(result)

Update the name of a specified inquiry category.

Body parameter

{
  "id": 0,
  "name": "string",
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

The ID of the category to be updated.

body

body

Varicent.RESTAPI.v1.DTOs.PortalAccess.DisputeCategoryDTO

false

none

» id

body

integer(int32)

false

none

» name

body

string¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

404

Not Found

Inquiry with the specified ID was not found

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/inquirycategories/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/inquirycategories/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "name": "string",
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/inquirycategories/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/inquirycategories/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/inquirycategories/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

Migration

Get the dependencies of the objects passed in a parameter.

Body parameter

{
  "blockIds": [
    0
  ],
  "importNames": [
    "string"
  ],
  "workflowTreeIds": [
    0
  ],
  "webTabIds": [
    0
  ],
  "webFormFilterIds": [
    0
  ],
  "selectedCalendars": [
    "string"
  ],
  "processMaps": [
    0
  ],
  "bpmWorkflows": [
    0
  ],
  "roleIds": [
    0
  ],
  "hierarchyIds": [
    0
  ],
  "presenterFlexReportIds": [
    0
  ],
  "adaptiveFormIds": [
    0
  ],
  "reportDataModelIds": [
    0
  ],
  "planDocumentIds": [
    0
  ],
  "hiddenBpmWorkflowIDs": [
    0
  ],
  "hiddenPresenterFlexReportIDs": [
    0
  ],
  "planBuilderFolderIds": [
    "string"
  ],
  "tableNames": [
    "string"
  ],
  "dataStoreIds": [
    0
  ],
  "requirementIds": [
    "string"
  ],
  "requirementDocumentIds": [
    "string"
  ],
  "reusableLogicToolIds": [
    "string"
  ]
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Migration.MigratableItemsDTO

false

none

» blockIds

body

[integer]¦null

false

none

» importNames

body

[string]¦null

false

none

» workflowTreeIds

body

[integer]¦null

false

none

» webTabIds

body

[integer]¦null

false

none

» webFormFilterIds

body

[integer]¦null

false

none

» selectedCalendars

body

[string]¦null

false

none

» processMaps

body

[integer]¦null

false

none

» bpmWorkflows

body

[integer]¦null

false

none

» roleIds

body

[integer]¦null

false

none

» hierarchyIds

body

[integer]¦null

false

none

» presenterFlexReportIds

body

[integer]¦null

false

none

» adaptiveFormIds

body

[integer]¦null

false

none

» reportDataModelIds

body

[integer]¦null

false

none

» planDocumentIds

body

[integer]¦null

false

none

» hiddenBpmWorkflowIDs

body

[integer]¦null

false

none

» hiddenPresenterFlexReportIDs

body

[integer]¦null

false

none

» planBuilderFolderIds

body

[string]¦null

false

none

» tableNames

body

[string]¦null

false

none

» dataStoreIds

body

[integer]¦null

false

none

» requirementIds

body

[string]¦null

false

none

» requirementDocumentIds

body

[string]¦null

false

none

» reusableLogicToolIds

body

[string]¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Migration Dependency Info

Varicent.RESTAPI.v1.DTOs.Migration.MigratableItemsDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/migration/dependencies", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/migration/dependencies");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "blockIds": [
    0
  ],
  "importNames": [
    "string"
  ],
  "workflowTreeIds": [
    0
  ],
  "webTabIds": [
    0
  ],
  "webFormFilterIds": [
    0
  ],
  "selectedCalendars": [
    "string"
  ],
  "processMaps": [
    0
  ],
  "bpmWorkflows": [
    0
  ],
  "roleIds": [
    0
  ],
  "hierarchyIds": [
    0
  ],
  "presenterFlexReportIds": [
    0
  ],
  "adaptiveFormIds": [
    0
  ],
  "reportDataModelIds": [
    0
  ],
  "planDocumentIds": [
    0
  ],
  "hiddenBpmWorkflowIDs": [
    0
  ],
  "hiddenPresenterFlexReportIDs": [
    0
  ],
  "planBuilderFolderIds": [
    "string"
  ],
  "tableNames": [
    "string"
  ],
  "dataStoreIds": [
    0
  ],
  "requirementIds": [
    "string"
  ],
  "requirementDocumentIds": [
    "string"
  ],
  "reusableLogicToolIds": [
    "string"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/migration/dependencies',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/migration/dependencies', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/migration/dependencies',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "blockIds": [
    0
  ],
  "importNames": [
    "string"
  ],
  "workflowTreeIds": [
    0
  ],
  "webTabIds": [
    0
  ],
  "webFormFilterIds": [
    0
  ],
  "selectedCalendars": [
    "string"
  ],
  "processMaps": [
    0
  ],
  "bpmWorkflows": [
    0
  ],
  "roleIds": [
    0
  ],
  "hierarchyIds": [
    0
  ],
  "presenterFlexReportIds": [
    0
  ],
  "adaptiveFormIds": [
    0
  ],
  "reportDataModelIds": [
    0
  ],
  "planDocumentIds": [
    0
  ],
  "hiddenBpmWorkflowIDs": [
    0
  ],
  "hiddenPresenterFlexReportIDs": [
    0
  ],
  "planBuilderFolderIds": [
    "string"
  ],
  "tableNames": [
    "string"
  ],
  "dataStoreIds": [
    0
  ],
  "requirementIds": [
    "string"
  ],
  "requirementDocumentIds": [
    "string"
  ],
  "reusableLogicToolIds": [
    "string"
  ]
}
{"blockIds":[0],"importNames":["string"],"workflowTreeIds":[0],"webTabIds":[0],"webFormFilterIds":[0],"selectedCalendars":["string"],"processMaps":[0],"bpmWorkflows":[0],"roleIds":[0],"hierarchyIds":[0],"presenterFlexReportIds":[0],"adaptiveFormIds":[0],"reportDataModelIds":[0],"planDocumentIds":[0],"hiddenBpmWorkflowIDs":[0],"hiddenPresenterFlexReportIDs":[0],"planBuilderFolderIds":["string"],"tableNames":["string"],"dataStoreIds":[0],"requirementIds":["string"],"requirementDocumentIds":["string"],"reusableLogicToolIds":["string"]}

Get the list of source tables and calendars that need to be mapped before migrating.

Body parameter

{
  "model": "string",
  "items": {
    "blockIds": [
      0
    ],
    "importNames": [
      "string"
    ],
    "workflowTreeIds": [
      0
    ],
    "webTabIds": [
      0
    ],
    "webFormFilterIds": [
      0
    ],
    "selectedCalendars": [
      "string"
    ],
    "processMaps": [
      0
    ],
    "bpmWorkflows": [
      0
    ],
    "roleIds": [
      0
    ],
    "hierarchyIds": [
      0
    ],
    "presenterFlexReportIds": [
      0
    ],
    "adaptiveFormIds": [
      0
    ],
    "reportDataModelIds": [
      0
    ],
    "planDocumentIds": [
      0
    ],
    "hiddenBpmWorkflowIDs": [
      0
    ],
    "hiddenPresenterFlexReportIDs": [
      0
    ],
    "planBuilderFolderIds": [
      "string"
    ],
    "tableNames": [
      "string"
    ],
    "dataStoreIds": [
      0
    ],
    "requirementIds": [
      "string"
    ],
    "requirementDocumentIds": [
      "string"
    ],
    "reusableLogicToolIds": [
      "string"
    ]
  }
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Migration.MigrationRequiredMappingsQueryDTO

false

none

» model

body

string¦null

false

none

» items

body

Varicent.RESTAPI.v1.DTOs.Migration.MigratableItemsDTO

false

none

»» blockIds

body

[integer]¦null

false

none

»» importNames

body

[string]¦null

false

none

»» workflowTreeIds

body

[integer]¦null

false

none

»» webTabIds

body

[integer]¦null

false

none

»» webFormFilterIds

body

[integer]¦null

false

none

»» selectedCalendars

body

[string]¦null

false

none

»» processMaps

body

[integer]¦null

false

none

»» bpmWorkflows

body

[integer]¦null

false

none

»» roleIds

body

[integer]¦null

false

none

»» hierarchyIds

body

[integer]¦null

false

none

»» presenterFlexReportIds

body

[integer]¦null

false

none

»» adaptiveFormIds

body

[integer]¦null

false

none

»» reportDataModelIds

body

[integer]¦null

false

none

»» planDocumentIds

body

[integer]¦null

false

none

»» hiddenBpmWorkflowIDs

body

[integer]¦null

false

none

»» hiddenPresenterFlexReportIDs

body

[integer]¦null

false

none

»» planBuilderFolderIds

body

[string]¦null

false

none

»» tableNames

body

[string]¦null

false

none

»» dataStoreIds

body

[integer]¦null

false

none

»» requirementIds

body

[string]¦null

false

none

»» requirementDocumentIds

body

[string]¦null

false

none

»» reusableLogicToolIds

body

[string]¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

required source table mappings

Varicent.RESTAPI.v1.DTOs.Migration.MappingInfoDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/migration/requiredmappings", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/migration/requiredmappings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "model": "string",
  "items": {
    "blockIds": [
      0
    ],
    "importNames": [
      "string"
    ],
    "workflowTreeIds": [
      0
    ],
    "webTabIds": [
      0
    ],
    "webFormFilterIds": [
      0
    ],
    "selectedCalendars": [
      "string"
    ],
    "processMaps": [
      0
    ],
    "bpmWorkflows": [
      0
    ],
    "roleIds": [
      0
    ],
    "hierarchyIds": [
      0
    ],
    "presenterFlexReportIds": [
      0
    ],
    "adaptiveFormIds": [
      0
    ],
    "reportDataModelIds": [
      0
    ],
    "planDocumentIds": [
      0
    ],
    "hiddenBpmWorkflowIDs": [
      0
    ],
    "hiddenPresenterFlexReportIDs": [
      0
    ],
    "planBuilderFolderIds": [
      "string"
    ],
    "tableNames": [
      "string"
    ],
    "dataStoreIds": [
      0
    ],
    "requirementIds": [
      "string"
    ],
    "requirementDocumentIds": [
      "string"
    ],
    "reusableLogicToolIds": [
      "string"
    ]
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/migration/requiredmappings',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/migration/requiredmappings', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/migration/requiredmappings',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "sourceTables": [
    {
      "destination": "string",
      "source": "string",
      "candidates": []
    }
  ],
  "calendars": [
    {
      "definition": {},
      "tree": {},
      "locked": "string",
      "version": {}
    }
  ]
}
{"sourceTables":[{"destination":"string","source":"string","candidates":[]}],"calendars":[{"definition":{},"tree":{},"locked":"string","version":{}}]}

Get the migration comparison data between the source and the current model.

Body parameter

{
  "calendarMappingInfo": [
    {
      "sourceTimeId": "string",
      "destinationTimeId": "string",
      "levelIdMappings": {}
    }
  ],
  "sourceTableMappingInfo": [
    {
      "destination": "string",
      "source": "string",
      "candidates": []
    }
  ],
  "overwrite": true,
  "model": "string",
  "items": {
    "blockIds": [
      0
    ],
    "importNames": [
      "string"
    ],
    "workflowTreeIds": [
      0
    ],
    "webTabIds": [
      0
    ],
    "webFormFilterIds": [
      0
    ],
    "selectedCalendars": [
      "string"
    ],
    "processMaps": [
      0
    ],
    "bpmWorkflows": [
      0
    ],
    "roleIds": [
      0
    ],
    "hierarchyIds": [
      0
    ],
    "presenterFlexReportIds": [
      0
    ],
    "adaptiveFormIds": [
      0
    ],
    "reportDataModelIds": [
      0
    ],
    "planDocumentIds": [
      0
    ],
    "hiddenBpmWorkflowIDs": [
      0
    ],
    "hiddenPresenterFlexReportIDs": [
      0
    ],
    "planBuilderFolderIds": [
      "string"
    ],
    "tableNames": [
      "string"
    ],
    "dataStoreIds": [
      0
    ],
    "requirementIds": [
      "string"
    ],
    "requirementDocumentIds": [
      "string"
    ],
    "reusableLogicToolIds": [
      "string"
    ]
  }
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Migration.MigrationComparisonDataQueryDTO

false

none

» calendarMappingInfo

body

[Varicent.RESTAPI.v1.DTOs.Migration.CalendarMappingDTO]¦null

false

none

»» sourceTimeId

body

string¦null

false

none

»» destinationTimeId

body

string¦null

false

none

»» levelIdMappings

body

object¦null

false

none

»»» additionalProperties

body

string¦null

false

none

» sourceTableMappingInfo

body

[Varicent.RESTAPI.v1.DTOs.Migration.SourceTableMappingInfoDTO]¦null

false

none

»» destination

body

string¦null

false

none

»» source

body

string¦null

false

none

»» candidates

body

[string]¦null

false

none

» overwrite

body

boolean

false

none

» model

body

string¦null

false

none

» items

body

Varicent.RESTAPI.v1.DTOs.Migration.MigratableItemsDTO

false

none

»» blockIds

body

[integer]¦null

false

none

»» importNames

body

[string]¦null

false

none

»» workflowTreeIds

body

[integer]¦null

false

none

»» webTabIds

body

[integer]¦null

false

none

»» webFormFilterIds

body

[integer]¦null

false

none

»» selectedCalendars

body

[string]¦null

false

none

»» processMaps

body

[integer]¦null

false

none

»» bpmWorkflows

body

[integer]¦null

false

none

»» roleIds

body

[integer]¦null

false

none

»» hierarchyIds

body

[integer]¦null

false

none

»» presenterFlexReportIds

body

[integer]¦null

false

none

»» adaptiveFormIds

body

[integer]¦null

false

none

»» reportDataModelIds

body

[integer]¦null

false

none

»» planDocumentIds

body

[integer]¦null

false

none

»» hiddenBpmWorkflowIDs

body

[integer]¦null

false

none

»» hiddenPresenterFlexReportIDs

body

[integer]¦null

false

none

»» planBuilderFolderIds

body

[string]¦null

false

none

»» tableNames

body

[string]¦null

false

none

»» dataStoreIds

body

[integer]¦null

false

none

»» requirementIds

body

[string]¦null

false

none

»» requirementDocumentIds

body

[string]¦null

false

none

»» reusableLogicToolIds

body

[string]¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Migration comparison data

Varicent.RESTAPI.v1.DTOs.Migration.MigrationComparisonDataDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/migration/comparisondata", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/migration/comparisondata");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "calendarMappingInfo": [
    {
      "sourceTimeId": "string",
      "destinationTimeId": "string",
      "levelIdMappings": {}
    }
  ],
  "sourceTableMappingInfo": [
    {
      "destination": "string",
      "source": "string",
      "candidates": []
    }
  ],
  "overwrite": true,
  "model": "string",
  "items": {
    "blockIds": [
      0
    ],
    "importNames": [
      "string"
    ],
    "workflowTreeIds": [
      0
    ],
    "webTabIds": [
      0
    ],
    "webFormFilterIds": [
      0
    ],
    "selectedCalendars": [
      "string"
    ],
    "processMaps": [
      0
    ],
    "bpmWorkflows": [
      0
    ],
    "roleIds": [
      0
    ],
    "hierarchyIds": [
      0
    ],
    "presenterFlexReportIds": [
      0
    ],
    "adaptiveFormIds": [
      0
    ],
    "reportDataModelIds": [
      0
    ],
    "planDocumentIds": [
      0
    ],
    "hiddenBpmWorkflowIDs": [
      0
    ],
    "hiddenPresenterFlexReportIDs": [
      0
    ],
    "planBuilderFolderIds": [
      "string"
    ],
    "tableNames": [
      "string"
    ],
    "dataStoreIds": [
      0
    ],
    "requirementIds": [
      "string"
    ],
    "requirementDocumentIds": [
      "string"
    ],
    "reusableLogicToolIds": [
      "string"
    ]
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/migration/comparisondata',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/migration/comparisondata', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/migration/comparisondata',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "duplicateItemNameLocal": true,
  "duplicateItemNameSource": true,
  "localSchedulerFolders": [
    {
      "id": 0,
      "name": "string",
      "scheduleItemType": "Folder",
      "order": 0,
      "lastRun": "2019-08-24T14:15:22Z",
      "lastRunStatus": "Success",
      "activation": "Enabled",
      "nextRun": "2019-08-24T14:15:22Z",
      "parent": 0,
      "scheduledTime": {},
      "parentItem": null,
      "childScheduleItems": [],
      "settings": {},
      "version": {},
      "previousName": "string",
      "runInParallel": true,
      "externalItemID": "string",
      "ptzId": "string"
    }
  ],
  "migrationItemsMap": {
    "WebReports": [
      {}
    ],
    "WebForms": [
      {}
    ],
    "WebFormFilters": [
      {}
    ],
    "Tables": [
      {}
    ],
    "TaskGroups": [
      {}
    ],
    "Views": [
      {}
    ],
    "Imports": [
      {}
    ],
    "Accounts": [
      {}
    ],
    "Calendars": [
      {}
    ],
    "Calculations": [
      {}
    ],
    "PayeeIDs": [
      {}
    ],
    "Plans": [
      {}
    ],
    "TailoredReports": [
      {}
    ],
    "WorkflowGroups": [
      {}
    ],
    "WorkflowTrees": [
      {}
    ],
    "ComposerBlocks": [
      {}
    ],
    "ComposerPorts": [
      {}
    ],
    "WebTabs": [
      {}
    ],
    "Roles": [
      {}
    ],
    "Users": [
      {}
    ],
    "ProcessMap": [
      {}
    ],
    "DataStores": [
      {}
    ],
    "BPMWorkflows": [
      {}
    ],
    "BPMSwimLanes": [
      {}
    ],
    "BPMNodes": [
      {}
    ],
    "BPMComponents": [
      {}
    ],
    "InputForms": [
      {}
    ],
    "Pulse": [
      {}
    ],
    "Hierarchies": [
      {}
    ],
    "PresenterFlexReports": [
      {}
    ],
    "AdaptiveForms": [
      {}
    ],
    "ExtendedTableColumns": [
      {}
    ],
    "ReportDataModels": [
      {}
    ],
    "PlanDocuments": [
      {}
    ],
    "PlanBuilderFolders": [
      {}
    ],
    "PlanBuilderTableReferences": [
      {}
    ],
    "PlanBuilderCalculationItems": [
      {}
    ],
    "Requirements": [
      {}
    ],
    "RequirementDocuments": [
      {}
    ],
    "ReusableLogicTools": [
      {}
    ]
  },
  "payeeGroupsRequired": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "revisions": {
    "source": 0,
    "destination": 0
  }
}
{"duplicateItemNameLocal":true,"duplicateItemNameSource":true,"localSchedulerFolders":[{"id":0,"name":"string","scheduleItemType":"Folder","order":0,"lastRun":"2019-08-24T14:15:22Z","lastRunStatus":"Success","activation":"Enabled","nextRun":"2019-08-24T14:15:22Z","parent":0,"scheduledTime":{},"parentItem":null,"childScheduleItems":[],"settings":{},"version":{},"previousName":"string","runInParallel":true,"externalItemID":"string","ptzId":"string"}],"migrationItemsMap":{"WebReports":[{}],"WebForms":[{}],"WebFormFilters":[{}],"Tables":[{}],"TaskGroups":[{}],"Views":[{}],"Imports":[{}],"Accounts":[{}],"Calendars":[{}],"Calculations":[{}],"PayeeIDs":[{}],"Plans":[{}],"TailoredReports":[{}],"WorkflowGroups":[{}],"WorkflowTrees":[{}],"ComposerBlocks":[{}],"ComposerPorts":[{}],"WebTabs":[{}],"Roles":[{}],"Users":[{}],"ProcessMap":[{}],"DataStores":[{}],"BPMWorkflows":[{}],"BPMSwimLanes":[{}],"BPMNodes":[{}],"BPMComponents":[{}],"InputForms":[{}],"Pulse":[{}],"Hierarchies":[{}],"PresenterFlexReports":[{}],"AdaptiveForms":[{}],"ExtendedTableColumns":[{}],"ReportDataModels":[{}],"PlanDocuments":[{}],"PlanBuilderFolders":[{}],"PlanBuilderTableReferences":[{}],"PlanBuilderCalculationItems":[{}],"Requirements":[{}],"RequirementDocuments":[{}],"ReusableLogicTools":[{}]},"payeeGroupsRequired":[{"key":"string","value":"string"}],"revisions":{"source":0,"destination":0}}

Check source tables and calendars that need to be mapped;

If any source table or calendar is needed, return a Conflict with mapping information If no source table or calendar, get the migration comparison data between the source and the current model.

Body parameter

{
  "calendarMappingInfo": [
    {
      "sourceTimeId": "string",
      "destinationTimeId": "string",
      "levelIdMappings": {}
    }
  ],
  "sourceTableMappingInfo": [
    {
      "destination": "string",
      "source": "string",
      "candidates": []
    }
  ],
  "overwrite": true,
  "model": "string",
  "items": {
    "blockIds": [
      0
    ],
    "importNames": [
      "string"
    ],
    "workflowTreeIds": [
      0
    ],
    "webTabIds": [
      0
    ],
    "webFormFilterIds": [
      0
    ],
    "selectedCalendars": [
      "string"
    ],
    "processMaps": [
      0
    ],
    "bpmWorkflows": [
      0
    ],
    "roleIds": [
      0
    ],
    "hierarchyIds": [
      0
    ],
    "presenterFlexReportIds": [
      0
    ],
    "adaptiveFormIds": [
      0
    ],
    "reportDataModelIds": [
      0
    ],
    "planDocumentIds": [
      0
    ],
    "hiddenBpmWorkflowIDs": [
      0
    ],
    "hiddenPresenterFlexReportIDs": [
      0
    ],
    "planBuilderFolderIds": [
      "string"
    ],
    "tableNames": [
      "string"
    ],
    "dataStoreIds": [
      0
    ],
    "requirementIds": [
      "string"
    ],
    "requirementDocumentIds": [
      "string"
    ],
    "reusableLogicToolIds": [
      "string"
    ]
  }
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Migration.MigrationComparisonDataQueryDTO

false

none

» calendarMappingInfo

body

[Varicent.RESTAPI.v1.DTOs.Migration.CalendarMappingDTO]¦null

false

none

»» sourceTimeId

body

string¦null

false

none

»» destinationTimeId

body

string¦null

false

none

»» levelIdMappings

body

object¦null

false

none

»»» additionalProperties

body

string¦null

false

none

» sourceTableMappingInfo

body

[Varicent.RESTAPI.v1.DTOs.Migration.SourceTableMappingInfoDTO]¦null

false

none

»» destination

body

string¦null

false

none

»» source

body

string¦null

false

none

»» candidates

body

[string]¦null

false

none

» overwrite

body

boolean

false

none

» model

body

string¦null

false

none

» items

body

Varicent.RESTAPI.v1.DTOs.Migration.MigratableItemsDTO

false

none

»» blockIds

body

[integer]¦null

false

none

»» importNames

body

[string]¦null

false

none

»» workflowTreeIds

body

[integer]¦null

false

none

»» webTabIds

body

[integer]¦null

false

none

»» webFormFilterIds

body

[integer]¦null

false

none

»» selectedCalendars

body

[string]¦null

false

none

»» processMaps

body

[integer]¦null

false

none

»» bpmWorkflows

body

[integer]¦null

false

none

»» roleIds

body

[integer]¦null

false

none

»» hierarchyIds

body

[integer]¦null

false

none

»» presenterFlexReportIds

body

[integer]¦null

false

none

»» adaptiveFormIds

body

[integer]¦null

false

none

»» reportDataModelIds

body

[integer]¦null

false

none

»» planDocumentIds

body

[integer]¦null

false

none

»» hiddenBpmWorkflowIDs

body

[integer]¦null

false

none

»» hiddenPresenterFlexReportIDs

body

[integer]¦null

false

none

»» planBuilderFolderIds

body

[string]¦null

false

none

»» tableNames

body

[string]¦null

false

none

»» dataStoreIds

body

[integer]¦null

false

none

»» requirementIds

body

[string]¦null

false

none

»» requirementDocumentIds

body

[string]¦null

false

none

»» reusableLogicToolIds

body

[string]¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Migration comparison data and mappings

Varicent.RESTAPI.v1.DTOs.Migration.MigrationComparisonDataDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/migration/mappingscomparisondata", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/migration/mappingscomparisondata");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "calendarMappingInfo": [
    {
      "sourceTimeId": "string",
      "destinationTimeId": "string",
      "levelIdMappings": {}
    }
  ],
  "sourceTableMappingInfo": [
    {
      "destination": "string",
      "source": "string",
      "candidates": []
    }
  ],
  "overwrite": true,
  "model": "string",
  "items": {
    "blockIds": [
      0
    ],
    "importNames": [
      "string"
    ],
    "workflowTreeIds": [
      0
    ],
    "webTabIds": [
      0
    ],
    "webFormFilterIds": [
      0
    ],
    "selectedCalendars": [
      "string"
    ],
    "processMaps": [
      0
    ],
    "bpmWorkflows": [
      0
    ],
    "roleIds": [
      0
    ],
    "hierarchyIds": [
      0
    ],
    "presenterFlexReportIds": [
      0
    ],
    "adaptiveFormIds": [
      0
    ],
    "reportDataModelIds": [
      0
    ],
    "planDocumentIds": [
      0
    ],
    "hiddenBpmWorkflowIDs": [
      0
    ],
    "hiddenPresenterFlexReportIDs": [
      0
    ],
    "planBuilderFolderIds": [
      "string"
    ],
    "tableNames": [
      "string"
    ],
    "dataStoreIds": [
      0
    ],
    "requirementIds": [
      "string"
    ],
    "requirementDocumentIds": [
      "string"
    ],
    "reusableLogicToolIds": [
      "string"
    ]
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/migration/mappingscomparisondata',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/migration/mappingscomparisondata', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/migration/mappingscomparisondata',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "duplicateItemNameLocal": true,
  "duplicateItemNameSource": true,
  "localSchedulerFolders": [
    {
      "id": 0,
      "name": "string",
      "scheduleItemType": "Folder",
      "order": 0,
      "lastRun": "2019-08-24T14:15:22Z",
      "lastRunStatus": "Success",
      "activation": "Enabled",
      "nextRun": "2019-08-24T14:15:22Z",
      "parent": 0,
      "scheduledTime": {},
      "parentItem": null,
      "childScheduleItems": [],
      "settings": {},
      "version": {},
      "previousName": "string",
      "runInParallel": true,
      "externalItemID": "string",
      "ptzId": "string"
    }
  ],
  "migrationItemsMap": {
    "WebReports": [
      {}
    ],
    "WebForms": [
      {}
    ],
    "WebFormFilters": [
      {}
    ],
    "Tables": [
      {}
    ],
    "TaskGroups": [
      {}
    ],
    "Views": [
      {}
    ],
    "Imports": [
      {}
    ],
    "Accounts": [
      {}
    ],
    "Calendars": [
      {}
    ],
    "Calculations": [
      {}
    ],
    "PayeeIDs": [
      {}
    ],
    "Plans": [
      {}
    ],
    "TailoredReports": [
      {}
    ],
    "WorkflowGroups": [
      {}
    ],
    "WorkflowTrees": [
      {}
    ],
    "ComposerBlocks": [
      {}
    ],
    "ComposerPorts": [
      {}
    ],
    "WebTabs": [
      {}
    ],
    "Roles": [
      {}
    ],
    "Users": [
      {}
    ],
    "ProcessMap": [
      {}
    ],
    "DataStores": [
      {}
    ],
    "BPMWorkflows": [
      {}
    ],
    "BPMSwimLanes": [
      {}
    ],
    "BPMNodes": [
      {}
    ],
    "BPMComponents": [
      {}
    ],
    "InputForms": [
      {}
    ],
    "Pulse": [
      {}
    ],
    "Hierarchies": [
      {}
    ],
    "PresenterFlexReports": [
      {}
    ],
    "AdaptiveForms": [
      {}
    ],
    "ExtendedTableColumns": [
      {}
    ],
    "ReportDataModels": [
      {}
    ],
    "PlanDocuments": [
      {}
    ],
    "PlanBuilderFolders": [
      {}
    ],
    "PlanBuilderTableReferences": [
      {}
    ],
    "PlanBuilderCalculationItems": [
      {}
    ],
    "Requirements": [
      {}
    ],
    "RequirementDocuments": [
      {}
    ],
    "ReusableLogicTools": [
      {}
    ]
  },
  "payeeGroupsRequired": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "revisions": {
    "source": 0,
    "destination": 0
  }
}
{"duplicateItemNameLocal":true,"duplicateItemNameSource":true,"localSchedulerFolders":[{"id":0,"name":"string","scheduleItemType":"Folder","order":0,"lastRun":"2019-08-24T14:15:22Z","lastRunStatus":"Success","activation":"Enabled","nextRun":"2019-08-24T14:15:22Z","parent":0,"scheduledTime":{},"parentItem":null,"childScheduleItems":[],"settings":{},"version":{},"previousName":"string","runInParallel":true,"externalItemID":"string","ptzId":"string"}],"migrationItemsMap":{"WebReports":[{}],"WebForms":[{}],"WebFormFilters":[{}],"Tables":[{}],"TaskGroups":[{}],"Views":[{}],"Imports":[{}],"Accounts":[{}],"Calendars":[{}],"Calculations":[{}],"PayeeIDs":[{}],"Plans":[{}],"TailoredReports":[{}],"WorkflowGroups":[{}],"WorkflowTrees":[{}],"ComposerBlocks":[{}],"ComposerPorts":[{}],"WebTabs":[{}],"Roles":[{}],"Users":[{}],"ProcessMap":[{}],"DataStores":[{}],"BPMWorkflows":[{}],"BPMSwimLanes":[{}],"BPMNodes":[{}],"BPMComponents":[{}],"InputForms":[{}],"Pulse":[{}],"Hierarchies":[{}],"PresenterFlexReports":[{}],"AdaptiveForms":[{}],"ExtendedTableColumns":[{}],"ReportDataModels":[{}],"PlanDocuments":[{}],"PlanBuilderFolders":[{}],"PlanBuilderTableReferences":[{}],"PlanBuilderCalculationItems":[{}],"Requirements":[{}],"RequirementDocuments":[{}],"ReusableLogicTools":[{}]},"payeeGroupsRequired":[{"key":"string","value":"string"}],"revisions":{"source":0,"destination":0}}

Run a migration.

Body parameter

{
  "payeeGroupMapping": {
    "property1": "string",
    "property2": "string"
  },
  "processMapTaskLinkMappingInfo": [
    {
      "taskId": 0,
      "processMapId": 0,
      "linkName": "string",
      "url": {}
    }
  ],
  "revisions": {
    "source": 0,
    "destination": 0
  },
  "calendarMappingInfo": [
    {
      "sourceTimeId": "string",
      "destinationTimeId": "string",
      "levelIdMappings": {}
    }
  ],
  "sourceTableMappingInfo": [
    {
      "destination": "string",
      "source": "string",
      "candidates": []
    }
  ],
  "overwrite": true,
  "model": "string",
  "items": {
    "blockIds": [
      0
    ],
    "importNames": [
      "string"
    ],
    "workflowTreeIds": [
      0
    ],
    "webTabIds": [
      0
    ],
    "webFormFilterIds": [
      0
    ],
    "selectedCalendars": [
      "string"
    ],
    "processMaps": [
      0
    ],
    "bpmWorkflows": [
      0
    ],
    "roleIds": [
      0
    ],
    "hierarchyIds": [
      0
    ],
    "presenterFlexReportIds": [
      0
    ],
    "adaptiveFormIds": [
      0
    ],
    "reportDataModelIds": [
      0
    ],
    "planDocumentIds": [
      0
    ],
    "hiddenBpmWorkflowIDs": [
      0
    ],
    "hiddenPresenterFlexReportIDs": [
      0
    ],
    "planBuilderFolderIds": [
      "string"
    ],
    "tableNames": [
      "string"
    ],
    "dataStoreIds": [
      0
    ],
    "requirementIds": [
      "string"
    ],
    "requirementDocumentIds": [
      "string"
    ],
    "reusableLogicToolIds": [
      "string"
    ]
  }
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Migration.RunMigrationQueryDTO

false

none

» payeeGroupMapping

body

object¦null

false

none

»» additionalProperties

body

string

false

none

» processMapTaskLinkMappingInfo

body

[Varicent.RESTAPI.v1.DTOs.Migration.ProcessMapTaskLinkMappingDTO]¦null

false

none

»» taskId

body

integer(int32)

false

none

»» processMapId

body

integer(int32)

false

none

»» linkName

body

string¦null

false

none

»» url

body

Varicent.RESTAPI.v1.DTOs.VaricentUrlDTO

false

none

»»» moduleType

body

string

false

none

»»» actionType

body

string

false

none

»»» elementType

body

string

false

none

»»» moduleTab

body

string¦null

false

none

»»» args

body

object¦null

false

none

»»»» additionalProperties

body

string¦null

false

none

» revisions

body

Varicent.RESTAPI.v1.DTOs.Migration.RevisionsDTO

false

none

»» source

body

integer(int32)

false

none

»» destination

body

integer(int32)

false

none

» calendarMappingInfo

body

[Varicent.RESTAPI.v1.DTOs.Migration.CalendarMappingDTO]¦null

false

none

»» sourceTimeId

body

string¦null

false

none

»» destinationTimeId

body

string¦null

false

none

»» levelIdMappings

body

object¦null

false

none

»»» additionalProperties

body

string¦null

false

none

» sourceTableMappingInfo

body

[Varicent.RESTAPI.v1.DTOs.Migration.SourceTableMappingInfoDTO]¦null

false

none

»» destination

body

string¦null

false

none

»» source

body

string¦null

false

none

»» candidates

body

[string]¦null

false

none

» overwrite

body

boolean

false

none

» model

body

string¦null

false

none

» items

body

Varicent.RESTAPI.v1.DTOs.Migration.MigratableItemsDTO

false

none

»» blockIds

body

[integer]¦null

false

none

»» importNames

body

[string]¦null

false

none

»» workflowTreeIds

body

[integer]¦null

false

none

»» webTabIds

body

[integer]¦null

false

none

»» webFormFilterIds

body

[integer]¦null

false

none

»» selectedCalendars

body

[string]¦null

false

none

»» processMaps

body

[integer]¦null

false

none

»» bpmWorkflows

body

[integer]¦null

false

none

»» roleIds

body

[integer]¦null

false

none

»» hierarchyIds

body

[integer]¦null

false

none

»» presenterFlexReportIds

body

[integer]¦null

false

none

»» adaptiveFormIds

body

[integer]¦null

false

none

»» reportDataModelIds

body

[integer]¦null

false

none

»» planDocumentIds

body

[integer]¦null

false

none

»» hiddenBpmWorkflowIDs

body

[integer]¦null

false

none

»» hiddenPresenterFlexReportIDs

body

[integer]¦null

false

none

»» planBuilderFolderIds

body

[string]¦null

false

none

»» tableNames

body

[string]¦null

false

none

»» dataStoreIds

body

[integer]¦null

false

none

»» requirementIds

body

[string]¦null

false

none

»» requirementDocumentIds

body

[string]¦null

false

none

»» reusableLogicToolIds

body

[string]¦null

false

none

Enumerated Values

Parameter

Value

»»» moduleType

home

»»» moduleType

composer

»»» moduleType

workflow

»»» moduleType

scheduler

»»» moduleType

taskmanager

»»» moduleType

audit

»»» moduleType

payeeledger

»»» moduleType

webforms

»»» moduleType

presenter

»»» moduleType

rowviewer

»»» moduleType

hierarchy

»»» moduleType

calcviewer

»»» moduleType

calculate

»»» moduleType

payeegroups

»»» moduleType

migration

»»» moduleType

localsavedimport

»»» moduleType

remotesavedimport

»»» moduleType

savedpublication

»»» moduleType

portviewer

»»» moduleType

scenarios

»»» moduleType

viewPR

»»» moduleType

progress

»»» moduleType

runSchedulerProcess

»»» moduleType

BPM

»»» moduleType

NonInteractive

»»» moduleType

compPlanManager

»»» moduleType

rapidreports

»»» moduleType

adaptive

»»» moduleType

adaptiveforms

»»» moduleType

plans

»»» moduleType

data

»»» moduleType

people

»»» moduleType

processList

»»» moduleType

manageFile

»»» actionType

None

»»» actionType

Cut

»»» actionType

Copy

»»» actionType

Delete

»»» actionType

Select

»»» actionType

Edit

»»» actionType

Wrap

»»» actionType

ViewUsedByTree

»»» actionType

ViewUsesTree

»»» actionType

UsedBy

»»» actionType

TableEditDescription

»»» actionType

TableAddInputForm

»»» actionType

TableEditInputForm

»»» actionType

TableEditValidationRules

»»» actionType

TableDeleteInputForm

»»» actionType

TableMakeEffectiveDated

»»» actionType

TableImport

»»» actionType

TableDeleteRows

»»» actionType

TableClear

»»» actionType

TableTransform

»»» actionType

TablePurgeHistory

»»» actionType

TableToggleTrackHistory

»»» actionType

TableToggleGlobal

»»» actionType

TableEditWebDataEditPermissions

»»» actionType

TableEditWebDataRestrictions

»»» actionType

TableEditWebDataApproveReject

»»» actionType

TableToggleDirectEdit

»»» actionType

Publish

»»» actionType

CalculationPreview

»»» actionType

CalculationCurrentValue

»»» actionType

CalculationHistory

»»» actionType

CalculationMethod

»»» actionType

PresenterView

»»» actionType

ComponentView

»»» actionType

ComponentUnwrap

»»» actionType

ComponentEditConnections

»»» actionType

ComponentAddInboundConnection

»»» actionType

ComponentAddOutboundConnection

»»» actionType

ComponentManageLinks

»»» actionType

ComponentManageDocuments

»»» actionType

AdaptivePresenterView

»»» actionType

AdaptiveFormView

»»» elementType

none

»»» elementType

table

»»» elementType

presenter

»»» elementType

webform

»»» elementType

calculation

»»» elementType

datastore

»»» elementType

component

»»» elementType

adaptive

»»» elementType

adaptiveform

Responses

Status

Meaning

Description

Schema

200

OK

List of activity endpoints to poll.

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/migration/migrate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/migration/migrate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "payeeGroupMapping": {
    "property1": "string",
    "property2": "string"
  },
  "processMapTaskLinkMappingInfo": [
    {
      "taskId": 0,
      "processMapId": 0,
      "linkName": "string",
      "url": {}
    }
  ],
  "revisions": {
    "source": 0,
    "destination": 0
  },
  "calendarMappingInfo": [
    {
      "sourceTimeId": "string",
      "destinationTimeId": "string",
      "levelIdMappings": {}
    }
  ],
  "sourceTableMappingInfo": [
    {
      "destination": "string",
      "source": "string",
      "candidates": []
    }
  ],
  "overwrite": true,
  "model": "string",
  "items": {
    "blockIds": [
      0
    ],
    "importNames": [
      "string"
    ],
    "workflowTreeIds": [
      0
    ],
    "webTabIds": [
      0
    ],
    "webFormFilterIds": [
      0
    ],
    "selectedCalendars": [
      "string"
    ],
    "processMaps": [
      0
    ],
    "bpmWorkflows": [
      0
    ],
    "roleIds": [
      0
    ],
    "hierarchyIds": [
      0
    ],
    "presenterFlexReportIds": [
      0
    ],
    "adaptiveFormIds": [
      0
    ],
    "reportDataModelIds": [
      0
    ],
    "planDocumentIds": [
      0
    ],
    "hiddenBpmWorkflowIDs": [
      0
    ],
    "hiddenPresenterFlexReportIDs": [
      0
    ],
    "planBuilderFolderIds": [
      "string"
    ],
    "tableNames": [
      "string"
    ],
    "dataStoreIds": [
      0
    ],
    "requirementIds": [
      "string"
    ],
    "requirementDocumentIds": [
      "string"
    ],
    "reusableLogicToolIds": [
      "string"
    ]
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/migration/migrate',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/migration/migrate', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/migration/migrate',
  params: {
  }, headers: headers

p JSON.parse(result)

Subscriptions

Subscribe to a new element.

Body parameter

{
  "id": "string",
  "type": "Block"
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.Subscriptions.SubscribableDTO

false

none

» id

body

string¦null

false

none

» type

body

string

false

none

Enumerated Values

Parameter

Value

» type

Block

» type

Table

» type

Calculation

» type

Plan

» type

TailoredReport

» type

WebForm

» type

WebReport

» type

InputPort

» type

OutputPort

» type

Library

» type

DataStore

» type

AssignTable

» type

Hub

» type

Waypoint

» type

InsertionPoint

Responses

Status

Meaning

Description

Schema

201

Created

Subscription confirmed.

Varicent.RESTAPI.v1.DTOs.Subscriptions.SubscriptionDTO

303

See Other

Subscription already exists.

None

400

Bad Request

Parameter was not complete or correctly built.

string

415

Unsupported Media Type

Element of the specified type cannot be subscribed to.

string

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/subscriptions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/subscriptions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": "string",
  "type": "Block"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/subscriptions',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/subscriptions', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/subscriptions',
  params: {
  }, headers: headers

p JSON.parse(result)

Get the detailed subscriptions for the current user.

Parameters

Name

In

Type

Required

Description

limit

query

integer(int32)

false

Number of records to retrieve.

offset

query

integer(int32)

false

Offset number of records.

Detailed descriptions

limit: Number of records to retrieve.

Default: 50

offset: Offset number of records.

Returns status code 500 if offset exceeds total number of records.

Default: 0

Responses

Status

Meaning

Description

Schema

200

OK

List of detailed subscriptions for the current user.

Inline

400

Bad Request

Pagination parameters are out of bounds.

string

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Subscriptions.SubscriptionDTO]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» subscribable

Varicent.RESTAPI.v1.DTOs.Composer.ElementDTO

false

none

none

»» elementId

integer(int32)

false

none

none

»» parentBlockId

integer(int32)¦null

false

none

none

»» bounds

System.Drawing.RectangleF

false

none

none

»»» location

System.Drawing.PointF

false

none

none

»»»» isEmpty

boolean

false

read-only

none

»»»» x

number(float)

false

none

none

»»»» y

number(float)

false

none

none

»»» size

string

false

none

none

»»» x

number(float)

false

none

none

»»» y

number(float)

false

none

none

»»» width

number(float)

false

none

none

»»» height

number(float)

false

none

none

»»» left

number(float)

false

read-only

none

»»» top

number(float)

false

read-only

none

»»» right

number(float)

false

read-only

none

»»» bottom

number(float)

false

read-only

none

»»» isEmpty

boolean

false

read-only

none

»» color

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

none

»»» a

integer(int32)

false

none

none

»»» b

integer(int32)

false

none

none

»»» g

integer(int32)

false

none

none

»»» r

integer(int32)

false

none

none

»» name

string¦null

false

none

none

»» parentBlock

Varicent.RESTAPI.v1.DTOs.Composer.ExpandableBlockElementDTO

false

none

none

»»» id

integer(int32)

false

none

none

»»» name

string¦null

false

none

none

»»» href

string¦null

false

none

none

»» isVisible

boolean

false

none

none

»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»» rowVersion

integer(int64)

false

none

none

» lastModified

string(date-time)

false

none

none

» lastAuthor

string¦null

false

none

none

» newChangesCount

integer(int32)

false

none

none

» type

string

false

none

none

Enumerated Values

Property

Value

type

Block

type

Table

type

Calculation

type

Plan

type

TailoredReport

type

WebForm

type

WebReport

type

InputPort

type

OutputPort

type

Library

type

DataStore

type

AssignTable

type

Hub

type

Waypoint

type

InsertionPoint

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/subscriptions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/subscriptions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/subscriptions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/subscriptions', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/subscriptions',
  params: {
  }, headers: headers

p JSON.parse(result)

Get the headers for the current user’s subscriptions.

Parameters

Name

In

Type

Required

Description

filter

query

string

false

####Supported operations

Detailed descriptions

filter: ####Supported operations - Equal matching; name=admin - Note that this type of matching is Strictly equal and case sensitive - Starts by; name^admi - Case-unsensitive - Ends with; name$min - Case-unsensitive - Equal matching within a list, aka inuserType=Admin\,Web - Interval marching; date=[2015-09-22\,2015-09-25] - Note that the intervals support the mathematics notation for inclusive/inclusive bounds, aka [a\,b](a\,b) or a mix (a\,b] - Intervals also support open-ended bounds, i.e. (a\,] - Not equal matching; name<>admin - Strict, case-sensitive comparison. - Is contained in; name⊇dmi - Case-unsensitive - NULL checks; name=NULL or name<>NULL - Only supported for equal and not equal operators. #### Multi-filters on the same attribute The filter query also supports the use of an operator. Complete filter definitions, as described above, are expected both sides of the operator. The column filtered must be the same both sides of the operator. Supported operators are: - AND && - OR || ####Multi-filters on different attributes To define a filter on multiple attributes, simply use the ; symbol to separate the various filter statements. ####Supported Fields

Supported: newChangesCount

Responses

Status

Meaning

Description

Schema

204

No Content

Headers containing information on the current user’s subscriptions.

None

400

Bad Request

Filter parameter is invalid.

string

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("HEAD", "http://localhost:8080/api/v1/subscriptions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/subscriptions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("HEAD");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/subscriptions',
{
  method: 'HEAD',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.head('http://localhost:8080/api/v1/subscriptions', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.head 'http://localhost:8080/api/v1/subscriptions',
  params: {
  }, headers: headers

p JSON.parse(result)

Get the details of a subscription.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Details of a subscription.

Varicent.RESTAPI.v1.DTOs.Subscriptions.SubscriptionDTO

404

Not Found

Subscription not found.

string

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/subscriptions/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/subscriptions/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/subscriptions/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/subscriptions/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/subscriptions/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "subscribable": {
    "elementId": 0,
    "parentBlockId": 0,
    "bounds": {
      "location": {},
      "size": "string",
      "x": 0.1,
      "y": 0.1,
      "width": 0.1,
      "height": 0.1,
      "left": 0.1,
      "top": 0.1,
      "right": 0.1,
      "bottom": 0.1,
      "isEmpty": true
    },
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "name": "string",
    "parentBlock": {
      "id": 0,
      "name": "string",
      "href": "string"
    },
    "isVisible": true,
    "version": {
      "rowVersion": 0
    }
  },
  "lastModified": "2019-08-24T14:15:22Z",
  "lastAuthor": "string",
  "newChangesCount": 0,
  "type": "Block"
}
{"id":0,"name":"string","subscribable":{"elementId":0,"parentBlockId":0,"bounds":{"location":{},"size":"string","x":0.1,"y":0.1,"width":0.1,"height":0.1,"left":0.1,"top":0.1,"right":0.1,"bottom":0.1,"isEmpty":true},"color":{"a":0,"b":0,"g":0,"r":0},"name":"string","parentBlock":{"id":0,"name":"string","href":"string"},"isVisible":true,"version":{"rowVersion":0}},"lastModified":"2019-08-24T14:15:22Z","lastAuthor":"string","newChangesCount":0,"type":"Block"}

Delete a subscription.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

204

No Content

Specified subscription has been deleted.

None

404

Not Found

Specified subscription has not been found.

string

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/subscriptions/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/subscriptions/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/subscriptions/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('http://localhost:8080/api/v1/subscriptions/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.delete 'http://localhost:8080/api/v1/subscriptions/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
"string"
"string"

System

Sends a support request email to ICM support.

Body parameter

{
  "severityLevel": 0,
  "summary": "string",
  "description": "string"
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.EmailDTO

false

severityLevel: 1-4 (with 1 being the most urgent and 4 being the least urgent).

» severityLevel

body

integer(int32)

false

none

» summary

body

string¦null

false

none

» description

body

string¦null

false

none

Detailed descriptions

body: severityLevel: 1-4 (with 1 being the most urgent and 4 being the least urgent). summary: Will appear as the email subject. description: Describe the issue you have encountered.

Responses

Status

Meaning

Description

Schema

200

OK

Email succeeded.

None

503

Service Unavailable

Email failed.

string

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/supportRequests", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/supportRequests");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "severityLevel": 0,
  "summary": "string",
  "description": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/supportRequests',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/supportRequests', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/supportRequests',
  params: {
  }, headers: headers

p JSON.parse(result)

HelpControllerV1_RequestContactEmail

Body parameter

{
  "contactEmail": "string"
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Intercom.RequestContactEmailDTO

false

none

» contactEmail

body

string¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Contact email request succeeded.

RESTAPI.v1.DTOs.Intercom.RequestContactEmailResponseDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/requestcontactemail", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/requestcontactemail");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "contactEmail": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/requestcontactemail',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/requestcontactemail', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/requestcontactemail',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "message": "string",
  "preview": "string",
  "expiry": 0,
  "resolved": true
}
{"message":"string","preview":"string","expiry":0,"resolved":true}

SystemTool

Get all system tools.

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/systemtools", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/systemtools");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/systemtools',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/systemtools', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/systemtools',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  "string"
]
["string"]

Analytics

Gets benchmarks

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.DataAnaltyics.BenchmarkDTO]

false

none

none

» planId

integer(int32)

false

none

none

» planName

string¦null

false

none

none

» attainmentPercentile

integer(int32)

false

none

none

» revenueRank

integer(int32)

false

none

none

» comparables

integer(int32)

false

none

none

» payoutPerRevenue

number(double)

false

none

none

» churnRate

integer(int32)

false

none

none

» level

string

false

none

none

Enumerated Values

Property

Value

level

Global

level

Industry

level

Company

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/benchmarks", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/benchmarks");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/benchmarks',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/benchmarks', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/benchmarks',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "planId": 0,
    "planName": "string",
    "attainmentPercentile": 0,
    "revenueRank": 0,
    "comparables": 0,
    "payoutPerRevenue": 0.1,
    "churnRate": 0,
    "level": "Global"
  }
]
[{"planId":0,"planName":"string","attainmentPercentile":0,"revenueRank":0,"comparables":0,"payoutPerRevenue":0.1,"churnRate":0,"level":"Global"}]

Gets compliance results

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/analyticsplans/{id}/reports", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/analyticsplans/{id}/reports");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/analyticsplans/{id}/reports',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/analyticsplans/{id}/reports', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/analyticsplans/{id}/reports',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
null
null

Gets insights

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/analyticsplans/{id}/insights", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/analyticsplans/{id}/insights");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/analyticsplans/{id}/insights',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/analyticsplans/{id}/insights', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/analyticsplans/{id}/insights',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
null
null

DataAnalyticsMeasuresControllerV1_PushData

Parameters

Name

In

Type

Required

Description

planID

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/analyticsplans/{planId}/pushData", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/analyticsplans/{planId}/pushData");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/rpc/analyticsplans/{planId}/pushData',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/v1/rpc/analyticsplans/{planId}/pushData')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/v1/rpc/analyticsplans/{planId}/pushData',
  params: {
  }

p JSON.parse(result)

Get Compensation Plan Analysis.

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.DataAnaltyics.PlanAnalysisDTO]

false

none

none

» planId

integer(int32)

false

none

none

» highlights

[string]¦null

false

none

none

» needsImprovement

[string]¦null

false

none

none

» grade

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/plansAnalysis", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plansAnalysis");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plansAnalysis',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/plansAnalysis', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/plansAnalysis',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "planId": 0,
    "highlights": [
      "string"
    ],
    "needsImprovement": [
      "string"
    ],
    "grade": "string"
  }
]
[{"planId":0,"highlights":["string"],"needsImprovement":["string"],"grade":"string"}]

Messages

Mark the notification as read

Parameters

Name

In

Type

Required

Description

id

query

integer(int32)

false

none

category

query

integer(int32)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Mark the notification as read

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/payee/bpmInquiries/markNotification", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payee/bpmInquiries/markNotification");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/payee/bpmInquiries/markNotification',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/v1/payee/bpmInquiries/markNotification')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/v1/payee/bpmInquiries/markNotification',
  params: {
  }

p JSON.parse(result)

Mark all messages as read

Responses

Status

Meaning

Description

Schema

200

OK

Mark all as read

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/payee/bpmInquiries/markAllNotification", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payee/bpmInquiries/markAllNotification");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/payee/bpmInquiries/markAllNotification',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/v1/payee/bpmInquiries/markAllNotification')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/v1/payee/bpmInquiries/markAllNotification',
  params: {
  }

p JSON.parse(result)

PayeeWeb

PayeeWebSalesforce_Authenticate

Body parameter

{
  "sessionID": "string",
  "hostname": "string",
  "serverURL": "string"
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.PayeeWebSalesforceAuthDTO

false

none

» sessionID

body

string¦null

false

none

» hostname

body

string¦null

false

none

» serverURL

body

string¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/payeeweb/salesforceAuthentication", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/payeeweb/salesforceAuthentication");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "sessionID": "string",
  "hostname": "string",
  "serverURL": "string"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/payeeweb/salesforceAuthentication',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/payeeweb/salesforceAuthentication', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/payeeweb/salesforceAuthentication',
  params: {
  }, headers: headers

p JSON.parse(result)

RapidReport

Get rapid report definition by id.

Parameters

Name

In

Type

Required

Description

name

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get Rapid Report Definition

RESTAPI.v1.DTOs.RapidReport.RapidReportDefinitionDTOV1

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/rapid/definitions/{name}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rapid/definitions/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rapid/definitions/{name}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/rapid/definitions/{name}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/rapid/definitions/{name}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "name": "string",
  "sources": [
    {
      "name": "string",
      "attributes": []
    }
  ],
  "version": {
    "rowVersion": 0
  }
}
{"name":"string","sources":[{"name":"string","attributes":[]}],"version":{"rowVersion":0}}

Update Rapid Report Definition

Body parameter

{
  "name": "string",
  "sources": [
    {
      "name": "string",
      "attributes": []
    }
  ],
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

name

path

string

true

none

body

body

RESTAPI.v1.DTOs.RapidReport.RapidReportDefinitionDTOV1

false

none

» name

body

string¦null

false

none

» sources

body

[RESTAPI.v1.DTOs.RapidReport.RapidReportDefinitionSourceDTOV1]¦null

false

none

»» name

body

string¦null

false

none

»» attributes

body

[RESTAPI.v1.DTOs.RapidReport.RapidReportDefinitionAttributeDTOV1]¦null

false

none

»»» name

body

string¦null

false

none

»»» type

body

string

false

none

»»» isPayeeFilter

body

boolean

false

none

»»» isRequired

body

boolean

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Enumerated Values

Parameter

Value

»»» type

String

»»» type

Number

»»» type

Currency

»»» type

Percent

»»» type

Date

Responses

Status

Meaning

Description

Schema

201

Created

Update Rapid Report Definition

RESTAPI.v1.DTOs.RapidReport.RapidReportDefinitionDTOV1

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/rapid/definitions/{name}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rapid/definitions/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "name": "string",
  "sources": [
    {
      "name": "string",
      "attributes": []
    }
  ],
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rapid/definitions/{name}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/rapid/definitions/{name}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/rapid/definitions/{name}',
  params: {
  }, headers: headers

p JSON.parse(result)

Delete Rapid Report Definition

Parameters

Name

In

Type

Required

Description

name

path

string

true

none

Responses

Status

Meaning

Description

Schema

201

Created

Delete Rapid Report Definition

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/rapid/definitions/{name}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rapid/definitions/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/rapid/definitions/{name}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/rapid/definitions/{name}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/rapid/definitions/{name}',
  params: {
  }

p JSON.parse(result)

Get all rapid report definitions.

Responses

Status

Meaning

Description

Schema

200

OK

Get All Rapid Report Definitions

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.RapidReport.RapidReportDefinitionDTOV1]

false

none

none

» name

string¦null

false

none

none

» sources

[RESTAPI.v1.DTOs.RapidReport.RapidReportDefinitionSourceDTOV1]¦null

false

none

none

»» name

string¦null

false

none

none

»» attributes

[RESTAPI.v1.DTOs.RapidReport.RapidReportDefinitionAttributeDTOV1]¦null

false

none

none

»»» name

string¦null

false

none

none

»»» type

string

false

none

none

»»» isPayeeFilter

boolean

false

none

none

»»» isRequired

boolean

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

Enumerated Values

Property

Value

type

String

type

Number

type

Currency

type

Percent

type

Date

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/rapid/definitions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rapid/definitions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rapid/definitions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/rapid/definitions', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/rapid/definitions',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "name": "string",
    "sources": [
      {}
    ],
    "version": {
      "rowVersion": 0
    }
  }
]
[{"name":"string","sources":[{}],"version":{"rowVersion":0}}]

Add Rapid Report Definition

Body parameter

{
  "name": "string",
  "sources": [
    {
      "name": "string",
      "attributes": []
    }
  ],
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.RapidReport.RapidReportDefinitionDTOV1

false

none

» name

body

string¦null

false

none

» sources

body

[RESTAPI.v1.DTOs.RapidReport.RapidReportDefinitionSourceDTOV1]¦null

false

none

»» name

body

string¦null

false

none

»» attributes

body

[RESTAPI.v1.DTOs.RapidReport.RapidReportDefinitionAttributeDTOV1]¦null

false

none

»»» name

body

string¦null

false

none

»»» type

body

string

false

none

»»» isPayeeFilter

body

boolean

false

none

»»» isRequired

body

boolean

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Enumerated Values

Parameter

Value

»»» type

String

»»» type

Number

»»» type

Currency

»»» type

Percent

»»» type

Date

Responses

Status

Meaning

Description

Schema

201

Created

Add Rapid Report Definition

RESTAPI.v1.DTOs.RapidReport.RapidReportDefinitionDTOV1

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rapid/definitions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rapid/definitions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "name": "string",
  "sources": [
    {
      "name": "string",
      "attributes": []
    }
  ],
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rapid/definitions',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rapid/definitions', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rapid/definitions',
  params: {
  }, headers: headers

p JSON.parse(result)

Get rapid report by id.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get Rapid Report

RESTAPI.v1.DTOs.RapidReport.RapidReportDTOV1

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/rapid/reports/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rapid/reports/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rapid/reports/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/rapid/reports/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/rapid/reports/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "definitionName": "string",
  "workflowObjectId": 0,
  "calendarTimeId": "string",
  "calendarLevel": "string",
  "sources": [
    {
      "name": "string",
      "mappedSourceName": "string",
      "timeFilterMode": "None",
      "timeFilterMappings": {},
      "restrictions": {},
      "attributes": [],
      "mappedDatastoreId": 0,
      "hierarchyPeriodColumn": "string"
    }
  ],
  "metadata": {
    "property1": null,
    "property2": null
  },
  "hierarchyID": 0,
  "version": {
    "rowVersion": 0
  }
}
{"id":0,"name":"string","definitionName":"string","workflowObjectId":0,"calendarTimeId":"string","calendarLevel":"string","sources":[{"name":"string","mappedSourceName":"string","timeFilterMode":"None","timeFilterMappings":{},"restrictions":{},"attributes":[],"mappedDatastoreId":0,"hierarchyPeriodColumn":"string"}],"metadata":{"property1":null,"property2":null},"hierarchyID":0,"version":{"rowVersion":0}}

Update a rapid report.

Body parameter

{
  "id": 0,
  "name": "string",
  "definitionName": "string",
  "workflowObjectId": 0,
  "calendarTimeId": "string",
  "calendarLevel": "string",
  "sources": [
    {
      "name": "string",
      "mappedSourceName": "string",
      "timeFilterMode": "None",
      "timeFilterMappings": {},
      "restrictions": {},
      "attributes": [],
      "mappedDatastoreId": 0,
      "hierarchyPeriodColumn": "string"
    }
  ],
  "metadata": {
    "property1": null,
    "property2": null
  },
  "hierarchyID": 0,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

RESTAPI.v1.DTOs.RapidReport.RapidReportDTOV1

false

none

» id

body

integer(int32)

false

none

» name

body

string¦null

false

none

» definitionName

body

string¦null

false

none

» workflowObjectId

body

integer(int32)¦null

false

none

» calendarTimeId

body

string¦null

false

none

» calendarLevel

body

string¦null

false

none

» sources

body

[RESTAPI.v1.DTOs.RapidReport.RapidReportSourceDTOV1]¦null

false

none

»» name

body

string¦null

false

none

»» mappedSourceName

body

string¦null

false

none

»» timeFilterMode

body

string

false

none

»» timeFilterMappings

body

RESTAPI.v1.DTOs.RapidReport.RapidReportSourceTimeFilterMappingsDTOV1

false

none

»»» periodMappedColumnName

body

string¦null

false

none

»»» rangeStartDateMappedColumnName

body

string¦null

false

none

»»» rangeEndDateMappedColumnName

body

string¦null

false

none

»»» dateMappedColumnName

body

string¦null

false

none

»» restrictions

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»»» alias

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» table

body

string¦null

false

none

»»»»» customSelect

body

string¦null

false

none

»»»»» dataType

body

string

false

none

»»»»» type

body

string

false

none

»»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»» expressionType

body

string

false

none

»»»»»» cases

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»»» expressionType

body

string

false

none

»»»»»»» cases

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» arguments

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»» constraintType

body

string

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»» condition

body

any

false

none

»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»» literalType

body

string

false

none

»»»»»»»»» value

body

any

false

none

»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»» constraints

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» literalRight

body

any

false

none

»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» right

body

any

false

none

»»»»»»»» expressionLeft

body

any

false

none

»»»»»»»» expressionRight

body

any

false

none

»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»» like

body

string¦null

false

none

»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»»» trueValue

body

any

false

none

»»»»»»» falseValue

body

any

false

none

»»»»»»» isDate

body

boolean

false

none

»»»»»»» literalType

body

string

false

none

»»»»»»» value

body

any

false

none

»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» isDate

body

boolean

false

none

»»»»»» literalType

body

string

false

none

»»»»»» value

body

any

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»»» m_namespace

body

string¦null

false

none

»»»»»» name

body

string¦null

false

none

»»»»» query

body

any

false

none

»»»»» alias

body

string¦null

false

none

»»»»» sourceType

body

string

false

none

»»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»» joinType

body

string

false

none

»»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»» constraintType

body

string

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»» caseSensitive

body

boolean

false

none

»»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»» like

body

string¦null

false

none

»»»»»» escapeWildcards

body

boolean

false

none

»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» queryDefinitionRight

body

any

false

none

»»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» direction

body

string

false

none

»»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»» distinct

body

boolean

false

none

»»»» unionWith

body

any

false

none

»»»» exceptWith

body

any

false

none

»»» sourceNames

body

object¦null

false

none

»»»» additionalProperties

body

string¦null

false

none

»» attributes

body

[RESTAPI.v1.DTOs.RapidReport.RapidReportAttributeDTOV1]¦null

false

none

»»» name

body

string¦null

false

none

»»» mappedAttributeName

body

string¦null

false

none

»»» displayName

body

string¦null

false

none

»»» type

body

string

false

none

»»» isUserDefined

body

boolean

false

none

»» mappedDatastoreId

body

integer(int32)¦null

false

none

»» hierarchyPeriodColumn

body

string¦null

false

none

» metadata

body

object¦null

false

none

»» additionalProperties

body

any

false

none

» hierarchyID

body

integer(int32)¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

»» timeFilterMode

None

»» timeFilterMode

Period

»» timeFilterMode

EffectiveDateRange

»» timeFilterMode

Date

»»»»» dataType

Int

»»»»» dataType

Decimal

»»»»» dataType

DateTime

»»»»» dataType

None

»»»»» dataType

String

»»»»» type

SelectAll

»»»»» type

SelectItem

»»»»» type

SelectLiteral

»»»»» type

SelectCustom

»»»»» type

SelectExpression

»»»»»» expressionType

caseExpression

»»»»»» expressionType

dataField

»»»»»» expressionType

function

»»»»»» expressionType

ifExpression

»»»»»» expressionType

literal

»»»»»»» expressionType

caseExpression

»»»»»»» expressionType

dataField

»»»»»»» expressionType

function

»»»»»»» expressionType

ifExpression

»»»»»»» expressionType

literal

»»»»»»»» constraintType

clause

»»»»»»»» constraintType

constraint

»»»»»»»» constraintType

expressionConstraint

»»»»»»»» constraintType

likeConstraint

»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»» constraintType

subQueryConstraint

»»»»»»»»» expressionType

caseExpression

»»»»»»»»» expressionType

dataField

»»»»»»»»» expressionType

function

»»»»»»»»» expressionType

ifExpression

»»»»»»»»» expressionType

literal

»»»»»»»»» literalType

Integer

»»»»»»»»» literalType

Decimal

»»»»»»»»» literalType

Date

»»»»»»»»» literalType

DateTime

»»»»»»»»» literalType

String

»»»»»»»»» literalType

Float

»»»»»»»»» literalType

Long

»»»»»»»»» literalType

Null

»»»»»»»»» literalType

Parameter

»»»»»»»»» literalType

Guid

»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»» literalType

Boolean

»»»»»»» literalType

Integer

»»»»»»» literalType

Decimal

»»»»»»» literalType

Date

»»»»»»» literalType

DateTime

»»»»»»» literalType

String

»»»»»»» literalType

Float

»»»»»»» literalType

Long

»»»»»»» literalType

Null

»»»»»»» literalType

Parameter

»»»»»»» literalType

Guid

»»»»»»» literalType

SystemUtcTime

»»»»»»» literalType

Boolean

»»»»»» literalType

Integer

»»»»»» literalType

Decimal

»»»»»» literalType

Date

»»»»»» literalType

DateTime

»»»»»» literalType

String

»»»»»» literalType

Float

»»»»»» literalType

Long

»»»»»» literalType

Null

»»»»»» literalType

Parameter

»»»»»» literalType

Guid

»»»»»» literalType

SystemUtcTime

»»»»»» literalType

Boolean

»»»»» sourceType

Table

»»»»» sourceType

Query

»»»»» joinType

Inner

»»»»» joinType

Left

»»»»» joinType

Right

»»»»» joinType

Cross

»»»»» joinType

CrossApply

»»»»» joinType

OuterApply

»»»»»» constraintType

clause

»»»»»» constraintType

constraint

»»»»»» constraintType

expressionConstraint

»»»»»» constraintType

likeConstraint

»»»»»» constraintType

rowVersionConstraint

»»»»»» constraintType

subQueryConstraint

»»»»» direction

Ascending

»»»»» direction

Descending

»»»»» direction

AscendingNullsFirst

»»»»» direction

DescendingNullsLast

»»» type

String

»»» type

Number

»»» type

Currency

»»» type

Percent

»»» type

Date

Responses

Status

Meaning

Description

Schema

200

OK

Update a Rapid Report.

RESTAPI.v1.DTOs.RapidReport.RapidReportDTOV1

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/rapid/reports/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rapid/reports/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "name": "string",
  "definitionName": "string",
  "workflowObjectId": 0,
  "calendarTimeId": "string",
  "calendarLevel": "string",
  "sources": [
    {
      "name": "string",
      "mappedSourceName": "string",
      "timeFilterMode": "None",
      "timeFilterMappings": {},
      "restrictions": {},
      "attributes": [],
      "mappedDatastoreId": 0,
      "hierarchyPeriodColumn": "string"
    }
  ],
  "metadata": {
    "property1": null,
    "property2": null
  },
  "hierarchyID": 0,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rapid/reports/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/rapid/reports/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/rapid/reports/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

Deletes a rapid report

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Delete a Rapid Report.

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/rapid/reports/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rapid/reports/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/rapid/reports/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/rapid/reports/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/rapid/reports/{id}',
  params: {
  }

p JSON.parse(result)

Get all rapid reports.

Parameters

Name

In

Type

Required

Description

definitionName

query

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Get All Rapid Reports

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.RapidReport.RapidReportDTOV1]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» definitionName

string¦null

false

none

none

» workflowObjectId

integer(int32)¦null

false

none

none

» calendarTimeId

string¦null

false

none

none

» calendarLevel

string¦null

false

none

none

» sources

[RESTAPI.v1.DTOs.RapidReport.RapidReportSourceDTOV1]¦null

false

none

none

»» name

string¦null

false

none

none

»» mappedSourceName

string¦null

false

none

none

»» timeFilterMode

string

false

none

none

»» timeFilterMappings

RESTAPI.v1.DTOs.RapidReport.RapidReportSourceTimeFilterMappingsDTOV1

false

none

none

»»» periodMappedColumnName

string¦null

false

none

none

»»» rangeStartDateMappedColumnName

string¦null

false

none

none

»»» rangeEndDateMappedColumnName

string¦null

false

none

none

»»» dateMappedColumnName

string¦null

false

none

none

»» restrictions

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

»»» query

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

»»»» selectItems

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

none

»»»»» alias

string¦null

false

none

none

»»»»» column

string¦null

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» customSelect

string¦null

false

none

none

»»»»» dataType

string

false

none

none

»»»»» type

string

false

none

none

»»»»» value

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»»» expressionType

string

false

none

none

»»»»»» cases

array¦null

false

none

none

»»»»»»» anonymous

any

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» column

string¦null

false

none

none

»»»»»» op

string¦null

false

none

none

»»»»»» arguments

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

none

[DTO version of IExpression]

»»»»»»» expressionType

string

false

none

none

»»»»»»» cases

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» column

string¦null

false

none

none

»»»»»»» op

string¦null

false

none

none

»»»»»»» arguments

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»»»» constraintType

string

false

none

none

»»»»»»»» op

string¦null

false

none

none

»»»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»»» expressionType

string

false

none

none

»»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»» table

string¦null

false

none

none

»»»»»»»»» column

string¦null

false

none

none

»»»»»»»»» op

string¦null

false

none

none

»»»»»»»»» arguments

array¦null

false

none

none

»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»» condition

any

false

none

none

»»»»»»»»» trueValue

any

false

none

none

»»»»»»»»» falseValue

any

false

none

none

»»»»»»»»» isDate

boolean

false

none

none

»»»»»»»»» literalType

string

false

none

none

»»»»»»»»» value

any

false

none

none

»»»»»»»» caseSensitive

boolean

false

none

none

»»»»»»»» constraints

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» literalRight

any

false

none

none

»»»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»» right

any

false

none

none

»»»»»»»» expressionLeft

any

false

none

none

»»»»»»»» expressionRight

any

false

none

none

»»»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»»»» like

string¦null

false

none

none

»»»»»»»» escapeWildcards

boolean

false

none

none

»»»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»»»» rowVersion

integer(int64)

false

none

none

»»»»»»»» table

string¦null

false

none

none

»»»»»»»» queryDefinitionRight

any

false

none

none

»»»»»»» trueValue

any

false

none

none

»»»»»»» falseValue

any

false

none

none

»»»»»»» isDate

boolean

false

none

none

»»»»»»» literalType

string

false

none

none

»»»»»»» value

any

false

none

none

»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»» trueValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»» falseValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»» isDate

boolean

false

none

none

»»»»»» literalType

string

false

none

none

»»»»»» value

any

false

none

none

»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»»» namespaceTable

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

none

»»»»»» m_namespace

string¦null

false

none

none

»»»»»» name

string¦null

false

none

none

»»»»» query

any

false

none

none

»»»»» alias

string¦null

false

none

none

»»»»» sourceType

string

false

none

none

»»»» joins

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

none

»»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»»» joinType

string

false

none

none

»»»»» onClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»»» constraintType

string

false

none

none

»»»»»» op

string¦null

false

none

none

»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»» caseSensitive

boolean

false

none

none

»»»»»» constraints

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

none

[DTO version of IConstraint]

»»»»»» literalRight

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»» right

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»» expressionLeft

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»» expressionRight

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»» like

string¦null

false

none

none

»»»»»» escapeWildcards

boolean

false

none

none

»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» queryDefinitionRight

any

false

none

none

»»»» whereClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»» order

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» column

string¦null

false

none

none

»»»»» direction

string

false

none

none

»»»» group

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» column

string¦null

false

none

none

»»»» havingClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»» distinct

boolean

false

none

none

»»»» unionWith

any

false

none

none

»»»» exceptWith

any

false

none

none

»»» sourceNames

object¦null

false

none

none

»»»» additionalProperties

string¦null

false

none

none

»» attributes

[RESTAPI.v1.DTOs.RapidReport.RapidReportAttributeDTOV1]¦null

false

none

none

»»» name

string¦null

false

none

none

»»» mappedAttributeName

string¦null

false

none

none

»»» displayName

string¦null

false

none

none

»»» type

string

false

none

none

»»» isUserDefined

boolean

false

none

none

»» mappedDatastoreId

integer(int32)¦null

false

none

none

»» hierarchyPeriodColumn

string¦null

false

none

none

» metadata

object¦null

false

none

none

»» additionalProperties

any

false

none

none

» hierarchyID

integer(int32)¦null

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

timeFilterMode

None

timeFilterMode

Period

timeFilterMode

EffectiveDateRange

timeFilterMode

Date

dataType

Int

dataType

Decimal

dataType

DateTime

dataType

None

dataType

String

type

SelectAll

type

SelectItem

type

SelectLiteral

type

SelectCustom

type

SelectExpression

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

sourceType

Table

sourceType

Query

joinType

Inner

joinType

Left

joinType

Right

joinType

Cross

joinType

CrossApply

joinType

OuterApply

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

direction

Ascending

direction

Descending

direction

AscendingNullsFirst

direction

DescendingNullsLast

type

String

type

Number

type

Currency

type

Percent

type

Date

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/rapid/reports", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rapid/reports");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rapid/reports',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/rapid/reports', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/rapid/reports',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "name": "string",
    "definitionName": "string",
    "workflowObjectId": 0,
    "calendarTimeId": "string",
    "calendarLevel": "string",
    "sources": [
      {}
    ],
    "metadata": {
      "property1": null,
      "property2": null
    },
    "hierarchyID": 0,
    "version": {
      "rowVersion": 0
    }
  }
]
[{"id":0,"name":"string","definitionName":"string","workflowObjectId":0,"calendarTimeId":"string","calendarLevel":"string","sources":[{}],"metadata":{"property1":null,"property2":null},"hierarchyID":0,"version":{"rowVersion":0}}]

Create a pulse report.

Body parameter

{
  "id": 0,
  "name": "string",
  "definitionName": "string",
  "workflowObjectId": 0,
  "calendarTimeId": "string",
  "calendarLevel": "string",
  "sources": [
    {
      "name": "string",
      "mappedSourceName": "string",
      "timeFilterMode": "None",
      "timeFilterMappings": {},
      "restrictions": {},
      "attributes": [],
      "mappedDatastoreId": 0,
      "hierarchyPeriodColumn": "string"
    }
  ],
  "metadata": {
    "property1": null,
    "property2": null
  },
  "hierarchyID": 0,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.RapidReport.RapidReportDTOV1

false

none

» id

body

integer(int32)

false

none

» name

body

string¦null

false

none

» definitionName

body

string¦null

false

none

» workflowObjectId

body

integer(int32)¦null

false

none

» calendarTimeId

body

string¦null

false

none

» calendarLevel

body

string¦null

false

none

» sources

body

[RESTAPI.v1.DTOs.RapidReport.RapidReportSourceDTOV1]¦null

false

none

»» name

body

string¦null

false

none

»» mappedSourceName

body

string¦null

false

none

»» timeFilterMode

body

string

false

none

»» timeFilterMappings

body

RESTAPI.v1.DTOs.RapidReport.RapidReportSourceTimeFilterMappingsDTOV1

false

none

»»» periodMappedColumnName

body

string¦null

false

none

»»» rangeStartDateMappedColumnName

body

string¦null

false

none

»»» rangeEndDateMappedColumnName

body

string¦null

false

none

»»» dateMappedColumnName

body

string¦null

false

none

»» restrictions

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

»»» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»»»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»»»» alias

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» table

body

string¦null

false

none

»»»»» customSelect

body

string¦null

false

none

»»»»» dataType

body

string

false

none

»»»»» type

body

string

false

none

»»»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»» expressionType

body

string

false

none

»»»»»» cases

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» column

body

string¦null

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»»»» expressionType

body

string

false

none

»»»»»»» cases

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» arguments

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»»»» constraintType

body

string

false

none

»»»»»»»» op

body

string¦null

false

none

»»»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»»» expressionType

body

string

false

none

»»»»»»»»» cases

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»» table

body

string¦null

false

none

»»»»»»»»» column

body

string¦null

false

none

»»»»»»»»» op

body

string¦null

false

none

»»»»»»»»» arguments

body

array¦null

false

none

»»»»»»»»»» anonymous

body

any

false

none

»»»»»»»»» condition

body

any

false

none

»»»»»»»»» trueValue

body

any

false

none

»»»»»»»»» falseValue

body

any

false

none

»»»»»»»»» isDate

body

boolean

false

none

»»»»»»»»» literalType

body

string

false

none

»»»»»»»»» value

body

any

false

none

»»»»»»»» caseSensitive

body

boolean

false

none

»»»»»»»» constraints

body

array¦null

false

none

»»»»»»»»» anonymous

body

any

false

none

»»»»»»»» literalRight

body

any

false

none

»»»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»»» right

body

any

false

none

»»»»»»»» expressionLeft

body

any

false

none

»»»»»»»» expressionRight

body

any

false

none

»»»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»»»» like

body

string¦null

false

none

»»»»»»»» escapeWildcards

body

boolean

false

none

»»»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»»»» table

body

string¦null

false

none

»»»»»»»» queryDefinitionRight

body

any

false

none

»»»»»»» trueValue

body

any

false

none

»»»»»»» falseValue

body

any

false

none

»»»»»»» isDate

body

boolean

false

none

»»»»»»» literalType

body

string

false

none

»»»»»»» value

body

any

false

none

»»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» isDate

body

boolean

false

none

»»»»»» literalType

body

string

false

none

»»»»»» value

body

any

false

none

»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»»»» m_namespace

body

string¦null

false

none

»»»»»» name

body

string¦null

false

none

»»»»» query

body

any

false

none

»»»»» alias

body

string¦null

false

none

»»»»» sourceType

body

string

false

none

»»»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»»»» joinType

body

string

false

none

»»»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»»»» constraintType

body

string

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»» caseSensitive

body

boolean

false

none

»»»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»» like

body

string¦null

false

none

»»»»»» escapeWildcards

body

boolean

false

none

»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» queryDefinitionRight

body

any

false

none

»»»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» direction

body

string

false

none

»»»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»» distinct

body

boolean

false

none

»»»» unionWith

body

any

false

none

»»»» exceptWith

body

any

false

none

»»» sourceNames

body

object¦null

false

none

»»»» additionalProperties

body

string¦null

false

none

»» attributes

body

[RESTAPI.v1.DTOs.RapidReport.RapidReportAttributeDTOV1]¦null

false

none

»»» name

body

string¦null

false

none

»»» mappedAttributeName

body

string¦null

false

none

»»» displayName

body

string¦null

false

none

»»» type

body

string

false

none

»»» isUserDefined

body

boolean

false

none

»» mappedDatastoreId

body

integer(int32)¦null

false

none

»» hierarchyPeriodColumn

body

string¦null

false

none

» metadata

body

object¦null

false

none

»» additionalProperties

body

any

false

none

» hierarchyID

body

integer(int32)¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

Enumerated Values

Parameter

Value

»» timeFilterMode

None

»» timeFilterMode

Period

»» timeFilterMode

EffectiveDateRange

»» timeFilterMode

Date

»»»»» dataType

Int

»»»»» dataType

Decimal

»»»»» dataType

DateTime

»»»»» dataType

None

»»»»» dataType

String

»»»»» type

SelectAll

»»»»» type

SelectItem

»»»»» type

SelectLiteral

»»»»» type

SelectCustom

»»»»» type

SelectExpression

»»»»»» expressionType

caseExpression

»»»»»» expressionType

dataField

»»»»»» expressionType

function

»»»»»» expressionType

ifExpression

»»»»»» expressionType

literal

»»»»»»» expressionType

caseExpression

»»»»»»» expressionType

dataField

»»»»»»» expressionType

function

»»»»»»» expressionType

ifExpression

»»»»»»» expressionType

literal

»»»»»»»» constraintType

clause

»»»»»»»» constraintType

constraint

»»»»»»»» constraintType

expressionConstraint

»»»»»»»» constraintType

likeConstraint

»»»»»»»» constraintType

rowVersionConstraint

»»»»»»»» constraintType

subQueryConstraint

»»»»»»»»» expressionType

caseExpression

»»»»»»»»» expressionType

dataField

»»»»»»»»» expressionType

function

»»»»»»»»» expressionType

ifExpression

»»»»»»»»» expressionType

literal

»»»»»»»»» literalType

Integer

»»»»»»»»» literalType

Decimal

»»»»»»»»» literalType

Date

»»»»»»»»» literalType

DateTime

»»»»»»»»» literalType

String

»»»»»»»»» literalType

Float

»»»»»»»»» literalType

Long

»»»»»»»»» literalType

Null

»»»»»»»»» literalType

Parameter

»»»»»»»»» literalType

Guid

»»»»»»»»» literalType

SystemUtcTime

»»»»»»»»» literalType

Boolean

»»»»»»» literalType

Integer

»»»»»»» literalType

Decimal

»»»»»»» literalType

Date

»»»»»»» literalType

DateTime

»»»»»»» literalType

String

»»»»»»» literalType

Float

»»»»»»» literalType

Long

»»»»»»» literalType

Null

»»»»»»» literalType

Parameter

»»»»»»» literalType

Guid

»»»»»»» literalType

SystemUtcTime

»»»»»»» literalType

Boolean

»»»»»» literalType

Integer

»»»»»» literalType

Decimal

»»»»»» literalType

Date

»»»»»» literalType

DateTime

»»»»»» literalType

String

»»»»»» literalType

Float

»»»»»» literalType

Long

»»»»»» literalType

Null

»»»»»» literalType

Parameter

»»»»»» literalType

Guid

»»»»»» literalType

SystemUtcTime

»»»»»» literalType

Boolean

»»»»» sourceType

Table

»»»»» sourceType

Query

»»»»» joinType

Inner

»»»»» joinType

Left

»»»»» joinType

Right

»»»»» joinType

Cross

»»»»» joinType

CrossApply

»»»»» joinType

OuterApply

»»»»»» constraintType

clause

»»»»»» constraintType

constraint

»»»»»» constraintType

expressionConstraint

»»»»»» constraintType

likeConstraint

»»»»»» constraintType

rowVersionConstraint

»»»»»» constraintType

subQueryConstraint

»»»»» direction

Ascending

»»»»» direction

Descending

»»»»» direction

AscendingNullsFirst

»»»»» direction

DescendingNullsLast

»»» type

String

»»» type

Number

»»» type

Currency

»»» type

Percent

»»» type

Date

Responses

Status

Meaning

Description

Schema

201

Created

Add a Rapid Report.

RESTAPI.v1.DTOs.RapidReport.RapidReportDTOV1

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rapid/reports", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rapid/reports");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "name": "string",
  "definitionName": "string",
  "workflowObjectId": 0,
  "calendarTimeId": "string",
  "calendarLevel": "string",
  "sources": [
    {
      "name": "string",
      "mappedSourceName": "string",
      "timeFilterMode": "None",
      "timeFilterMappings": {},
      "restrictions": {},
      "attributes": [],
      "mappedDatastoreId": 0,
      "hierarchyPeriodColumn": "string"
    }
  ],
  "metadata": {
    "property1": null,
    "property2": null
  },
  "hierarchyID": 0,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rapid/reports',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rapid/reports', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rapid/reports',
  params: {
  }, headers: headers

p JSON.parse(result)

Get rapid report data source by report id and source name.

Parameters

Name

In

Type

Required

Description

reportId

path

integer(int32)

true

none

sourceName

path

string

true

none

attributeColumns

query

array[string]

false

none

limit

query

integer(int32)

false

none

offset

query

integer(int32)

false

none

orderBy

query

string

false

none

orderDirection

query

string

false

none

periodFilter

query

string

false

none

effectiveDateFilter

query

string(date-time)

false

none

startDateFilter

query

string(date-time)

false

none

endDateFilter

query

string(date-time)

false

none

filter

query

string

false

none

parentPeriod

query

string

false

none

distinct

query

boolean

false

none

hierarchyPeriod

query

string

false

none

hierarchyPayee

query

string

false

none

Enumerated Values

Parameter

Value

orderDirection

Ascending

orderDirection

Descending

orderDirection

AscendingNullsFirst

orderDirection

DescendingNullsLast

Responses

Status

Meaning

Description

Schema

200

OK

Get Rapid Report Data Source

RESTAPI.v1.DTOs.RapidReport.RapidReportDataSourceDTOV1

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/rapid/reports/{reportid}/data/{sourcename}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rapid/reports/{reportid}/data/{sourcename}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rapid/reports/{reportid}/data/{sourcename}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/rapid/reports/{reportid}/data/{sourcename}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/rapid/reports/{reportid}/data/{sourcename}',
  params: {
  }, headers: headers

p JSON.parse(result)

Get available rapid report hierarchy periods

Parameters

Name

In

Type

Required

Description

reportId

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get Rapid Report Hierarchy Periods

RESTAPI.v1.DTOs.RapidReport.RapidReportDataSourceDTOV1

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/payee/rapid/reports/{reportid}/hierarchy/periods", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payee/rapid/reports/{reportid}/hierarchy/periods");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/payee/rapid/reports/{reportid}/hierarchy/periods',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/payee/rapid/reports/{reportid}/hierarchy/periods', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/payee/rapid/reports/{reportid}/hierarchy/periods',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "dataRows": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "schema": {
    "property1": {
      "attributeType": "String"
    },
    "property2": {
      "attributeType": "String"
    }
  },
  "totalRows": 0
}
{"dataRows":[{"property1":null,"property2":null}],"schema":{"property1":{"attributeType":"String"},"property2":{"attributeType":"String"}},"totalRows":0}

Get available rapid report hierarchy available payees

Parameters

Name

In

Type

Required

Description

reportId

path

integer(int32)

true

none

selectedPeriod

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get Rapid Report Hierarchy Payees

RESTAPI.v1.DTOs.RapidReport.RapidReportDataSourceDTOV1

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/payee/rapid/reports/{reportid}/hierarchy/payees/{selectedperiod}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payee/rapid/reports/{reportid}/hierarchy/payees/{selectedperiod}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/payee/rapid/reports/{reportid}/hierarchy/payees/{selectedperiod}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/payee/rapid/reports/{reportid}/hierarchy/payees/{selectedperiod}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/payee/rapid/reports/{reportid}/hierarchy/payees/{selectedperiod}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "dataRows": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "schema": {
    "property1": {
      "attributeType": "String"
    },
    "property2": {
      "attributeType": "String"
    }
  },
  "totalRows": 0
}
{"dataRows":[{"property1":null,"property2":null}],"schema":{"property1":{"attributeType":"String"},"property2":{"attributeType":"String"}},"totalRows":0}

Get rapid report mappable sources

Responses

Status

Meaning

Description

Schema

200

OK

Get Rapid Report Mappable Sources

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.RapidReport.RapidReportMappableSourceDTOV1]

false

none

none

» name

string¦null

false

none

none

» displayName

string¦null

false

none

none

» columns

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

none

»» name

string¦null

false

none

none

»» type

string

false

none

none

»» isKey

boolean

false

none

none

»» nullable

boolean

false

none

none

»» values

string¦null

false

none

none

»» lockedPeriod

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

none

»»» start

string(date-time)

false

none

none

»»» end

string(date-time)

false

none

none

»» referencedCol

string¦null

false

none

none

»» picklistFilter

string¦null

false

none

none

»» displayName

string¦null

false

none

none

»» isELTPeriod

boolean¦null

false

none

none

» datastoreId

integer(int32)¦null

false

none

none

» joinCount

integer(int32)¦null

false

none

none

Enumerated Values

Property

Value

type

String

type

LongString

type

MaxString

type

Date

type

DateTime

type

Decimal

type

Int

type

Long

type

Float

type

BLOB

type

Identity

type

CLOB

type

RowVersion

type

UID

type

VarCharMax

type

Boolean

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/rapid/mappablesources", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rapid/mappablesources");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rapid/mappablesources',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/rapid/mappablesources', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/rapid/mappablesources',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "name": "string",
    "displayName": "string",
    "columns": [
      {}
    ],
    "datastoreId": 0,
    "joinCount": 0
  }
]
[{"name":"string","displayName":"string","columns":[{}],"datastoreId":0,"joinCount":0}]

Get rapid report mappable sources schemas for restriction wizard

Responses

Status

Meaning

Description

Schema

200

OK

Get Rapid Report Mappable Sources Schemas

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Composer.DataSourceSchemaDTO]

false

none

none

» displayName

string¦null

false

none

none

» details

Varicent.RESTAPI.v1.DTOs.ExpandableResourceDTO

false

none

none

»» href

string¦null

false

none

none

» type

string

false

none

none

» fullTableSchema

Varicent.RESTAPI.v1.DTOs.FullTableSchemaDTO

false

none

none

»» columns

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

none

»»» name

string¦null

false

none

none

»»» type

string

false

none

none

»»» isKey

boolean

false

none

none

»»» nullable

boolean

false

none

none

»»» values

string¦null

false

none

none

»»» lockedPeriod

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

none

»»»» start

string(date-time)

false

none

none

»»»» end

string(date-time)

false

none

none

»»» referencedCol

string¦null

false

none

none

»»» picklistFilter

string¦null

false

none

none

»»» displayName

string¦null

false

none

none

»»» isELTPeriod

boolean¦null

false

none

none

»» table

string¦null

false

none

none

»» name

string¦null

false

none

none

»» referencedSources

[string]¦null

false

none

none

»» referencedTimes

[Varicent.RESTAPI.v1.DTOs.FrequencyDTO]¦null

false

none

none

»»» levelId

string¦null

false

none

none

»»» timeId

string¦null

false

none

none

»» referencedSourcesDictionary

object¦null

false

none

none

»»» additionalProperties

string

false

none

none

»» referencedTimesDictionary

object¦null

false

none

none

»»» additionalProperties

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

none

» tableDefinition

Varicent.RESTAPI.v1.DTOs.TableDefinitionDTO

false

none

none

»» table

Varicent.RESTAPI.v1.DTOs.CustomTableDTO

false

none

none

»»» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»» rowVersion

integer(int64)

false

none

none

»»» name

string¦null

false

none

none

»»» tableType

string

false

none

none

»»» effectiveDated

boolean

false

none

none

»»» workflowObjectID

integer(int32)

false

none

none

»»» hierarchyMetadata

RESTAPI.v1.DTOs.Hierarchy.HierarchyMetadataDTO

false

none

none

»»»» tableName

string¦null

false

none

none

»»»» idColumnName

string¦null

false

none

none

»»»» parentColumnName

string¦null

false

none

none

»»» lastUpdatedTracking

boolean¦null

false

none

none

»» columns

[Varicent.RESTAPI.v1.DTOs.ColumnDefinitionDTO]¦null

false

none

none

»»» column

Varicent.RESTAPI.v1.DTOs.CustomColumnDTO

false

none

none

»»»» name

string¦null

false

none

none

»»»» type

string

false

none

none

»»»» referencedTable

string¦null

false

none

none

»»»» referencedName

string¦null

false

none

none

»»»» source

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

»»»»» query

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

»»»»»» selectItems

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

none

»»»»»»» alias

string¦null

false

none

none

»»»»»»» column

string¦null

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» customSelect

string¦null

false

none

none

»»»»»»» dataType

string

false

none

none

»»»»»»» type

string

false

none

none

»»»»»»» value

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»»»»» expressionType

string

false

none

none

»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»» anonymous

any

false

none

none

»»»»»»»» table

string¦null

false

none

none

»»»»»»»» column

string¦null

false

none

none

»»»»»»»» op

string¦null

false

none

none

»»»»»»»» arguments

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

none

[DTO version of IExpression]

»»»»»»»»» expressionType

string

false

none

none

»»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»» table

string¦null

false

none

none

»»»»»»»»» column

string¦null

false

none

none

»»»»»»»»» op

string¦null

false

none

none

»»»»»»»»» arguments

array¦null

false

none

none

»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»»»»»» constraintType

string

false

none

none

»»»»»»»»»» op

string¦null

false

none

none

»»»»»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»»»»» expressionType

string

false

none

none

»»»»»»»»»»» cases

array¦null

false

none

none

»»»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»»»» table

string¦null

false

none

none

»»»»»»»»»»» column

string¦null

false

none

none

»»»»»»»»»»» op

string¦null

false

none

none

»»»»»»»»»»» arguments

array¦null

false

none

none

»»»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»»»» condition

any

false

none

none

»»»»»»»»»»» trueValue

any

false

none

none

»»»»»»»»»»» falseValue

any

false

none

none

»»»»»»»»»»» isDate

boolean

false

none

none

»»»»»»»»»»» literalType

string

false

none

none

»»»»»»»»»»» value

any

false

none

none

»»»»»»»»»» caseSensitive

boolean

false

none

none

»»»»»»»»»» constraints

array¦null

false

none

none

»»»»»»»»»»» anonymous

any

false

none

none

»»»»»»»»»» literalRight

any

false

none

none

»»»»»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»»»» right

any

false

none

none

»»»»»»»»»» expressionLeft

any

false

none

none

»»»»»»»»»» expressionRight

any

false

none

none

»»»»»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»»»»»» like

string¦null

false

none

none

»»»»»»»»»» escapeWildcards

boolean

false

none

none

»»»»»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»»»»» table

string¦null

false

none

none

»»»»»»»»»» queryDefinitionRight

any

false

none

none

»»»»»»»»» trueValue

any

false

none

none

»»»»»»»»» falseValue

any

false

none

none

»»»»»»»»» isDate

boolean

false

none

none

»»»»»»»»» literalType

string

false

none

none

»»»»»»»»» value

any

false

none

none

»»»»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»»»» trueValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»»» falseValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»»» isDate

boolean

false

none

none

»»»»»»»» literalType

string

false

none

none

»»»»»»»» value

any

false

none

none

»»»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»»»»» namespaceTable

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

none

»»»»»»»» m_namespace

string¦null

false

none

none

»»»»»»»» name

string¦null

false

none

none

»»»»»»» query

any

false

none

none

»»»»»»» alias

string¦null

false

none

none

»»»»»»» sourceType

string

false

none

none

»»»»»» joins

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

none

»»»»»»» source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

»»»»»»» joinType

string

false

none

none

»»»»»»» onClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»»»»» constraintType

string

false

none

none

»»»»»»»» op

string¦null

false

none

none

»»»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»» caseSensitive

boolean

false

none

none

»»»»»»»» constraints

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

none

[DTO version of IConstraint]

»»»»»»»» literalRight

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»»» right

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»»» expressionLeft

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»»» expressionRight

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»»»» like

string¦null

false

none

none

»»»»»»»» escapeWildcards

boolean

false

none

none

»»»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»»» table

string¦null

false

none

none

»»»»»»»» queryDefinitionRight

any

false

none

none

»»»»»» whereClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»»» order

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» column

string¦null

false

none

none

»»»»»»» direction

string

false

none

none

»»»»»» group

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» column

string¦null

false

none

none

»»»»»» havingClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

»»»»»» distinct

boolean

false

none

none

»»»»»» unionWith

any

false

none

none

»»»»»» exceptWith

any

false

none

none

»»»»» sourceNames

object¦null

false

none

none

»»»»»» additionalProperties

string¦null

false

none

none

»»»» pickListParams

[Varicent.RESTAPI.v1.DTOs.PickListParamDTO]¦null

false

none

none

»»»»» joinAlias

string¦null

false

none

none

»»»»» joinColumn

string¦null

false

none

none

»»»»» op

string

false

none

none

»»»» isKey

boolean

false

none

none

»»» isRemovable

boolean

false

none

none

»»» isNullable

boolean

false

none

none

»»» referencedColumn

string¦null

false

none

none

»» time

Varicent.RESTAPI.v1.DTOs.TableTimeDTO

false

none

none

»»» timeId

string¦null

false

none

none

»»» dateColumn

string¦null

false

none

none

»»» lockedOn

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

»»» min

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

»»» max

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

» calculationDefinition

Varicent.RESTAPI.v1.DTOs.CalculationDefinitionDTO

false

none

none

»» calculationId

integer(int32)

false

none

none

»» calculationType

string

false

none

none

»» planBuilderCalculationId

string¦null

false

none

none

Enumerated Values

Property

Value

type

Table

type

Calculation

type

DataStore

type

Port

type

Symon

type

PlanBuilderCalculation

type

String

type

LongString

type

MaxString

type

Date

type

DateTime

type

Decimal

type

Int

type

Long

type

Float

type

BLOB

type

Identity

type

CLOB

type

RowVersion

type

UID

type

VarCharMax

type

Boolean

tableType

System

tableType

Dimension

tableType

Structural

tableType

Lookup

tableType

Data

tableType

View

tableType

Custom

tableType

StarSchema

tableType

ExportTable

tableType

CreditingRule

tableType

AssignTable

tableType

PlcmCustomTable

tableType

PlcmStructuralTable

tableType

PlcmTable

tableType

DataSource

tableType

Cached

tableType

MaterializedView

type

Text

type

Date

type

List

type

Numeric

type

Email

type

Url

type

Comment

type

DateTime

dataType

Int

dataType

Decimal

dataType

DateTime

dataType

None

dataType

String

type

SelectAll

type

SelectItem

type

SelectLiteral

type

SelectCustom

type

SelectExpression

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

sourceType

Table

sourceType

Query

joinType

Inner

joinType

Left

joinType

Right

joinType

Cross

joinType

CrossApply

joinType

OuterApply

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

direction

Ascending

direction

Descending

direction

AscendingNullsFirst

direction

DescendingNullsLast

op

LessThan

op

LessThanEquals

op

Equals

op

NotEquals

op

GreaterThan

op

GreaterThanEquals

op

IsNull

op

IsNotNull

op

In

op

NotIn

calculationType

Mathematical

calculationType

Sorting

calculationType

TimeShift

calculationType

Category

calculationType

Symon

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/rapid/mappablesourcesschemas", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rapid/mappablesourcesschemas");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rapid/mappablesourcesschemas',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/rapid/mappablesourcesschemas', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/rapid/mappablesourcesschemas',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "displayName": "string",
    "details": {
      "href": "string"
    },
    "type": "Table",
    "fullTableSchema": {
      "columns": [],
      "table": "string",
      "name": "string",
      "referencedSources": [],
      "referencedTimes": [],
      "referencedSourcesDictionary": {},
      "referencedTimesDictionary": {}
    },
    "tableDefinition": {
      "table": {},
      "columns": [],
      "time": {}
    },
    "calculationDefinition": {
      "calculationId": 0,
      "calculationType": "Mathematical",
      "planBuilderCalculationId": "string"
    }
  }
]
[{"displayName":"string","details":{"href":"string"},"type":"Table","fullTableSchema":{"columns":[],"table":"string","name":"string","referencedSources":[],"referencedTimes":[],"referencedSourcesDictionary":{},"referencedTimesDictionary":{}},"tableDefinition":{"table":{},"columns":[],"time":{}},"calculationDefinition":{"calculationId":0,"calculationType":"Mathematical","planBuilderCalculationId":"string"}}]

Hierarchy

Get all hierarchies.

Responses

Status

Meaning

Description

Schema

200

OK

Get all hierarchies

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.Hierarchy.HierarchyDTOV1]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» description

string¦null

false

none

none

» sourceName

string¦null

false

none

none

» sourceLabel

string¦null

false

none

none

» payeeColumnName

string¦null

false

none

none

» reportsToColumnName

string¦null

false

none

none

» periodColumnName

string¦null

false

none

none

» sourceData

RESTAPI.v1.DTOs.Hierarchy.HierarchySourceDTOV1

false

none

none

»» name

string¦null

false

none

none

»» label

string¦null

false

none

none

»» type

string¦null

false

none

none

»» columns

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

none

»»» name

string¦null

false

none

none

»»» type

string

false

none

none

»»» isKey

boolean

false

none

none

»»» nullable

boolean

false

none

none

»»» values

string¦null

false

none

none

»»» lockedPeriod

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

none

»»»» start

string(date-time)

false

none

none

»»»» end

string(date-time)

false

none

none

»»» referencedCol

string¦null

false

none

none

»»» picklistFilter

string¦null

false

none

none

»»» displayName

string¦null

false

none

none

»»» isELTPeriod

boolean¦null

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

Enumerated Values

Property

Value

type

String

type

LongString

type

MaxString

type

Date

type

DateTime

type

Decimal

type

Int

type

Long

type

Float

type

BLOB

type

Identity

type

CLOB

type

RowVersion

type

UID

type

VarCharMax

type

Boolean

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/hierarchies", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/hierarchies");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/hierarchies',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/hierarchies', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/hierarchies',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "name": "string",
    "description": "string",
    "sourceName": "string",
    "sourceLabel": "string",
    "payeeColumnName": "string",
    "reportsToColumnName": "string",
    "periodColumnName": "string",
    "sourceData": {
      "name": "string",
      "label": "string",
      "type": "string",
      "columns": []
    },
    "version": {
      "rowVersion": 0
    }
  }
]
[{"id":0,"name":"string","description":"string","sourceName":"string","sourceLabel":"string","payeeColumnName":"string","reportsToColumnName":"string","periodColumnName":"string","sourceData":{"name":"string","label":"string","type":"string","columns":[]},"version":{"rowVersion":0}}]

Create a hierarchy.

Body parameter

{
  "id": 0,
  "name": "string",
  "description": "string",
  "sourceName": "string",
  "sourceLabel": "string",
  "payeeColumnName": "string",
  "reportsToColumnName": "string",
  "periodColumnName": "string",
  "sourceData": {
    "name": "string",
    "label": "string",
    "type": "string",
    "columns": [
      {}
    ]
  },
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Hierarchy.HierarchyDTOV1

false

none

» id

body

integer(int32)

false

none

» name

body

string¦null

false

none

» description

body

string¦null

false

none

» sourceName

body

string¦null

false

none

» sourceLabel

body

string¦null

false

none

» payeeColumnName

body

string¦null

false

none

» reportsToColumnName

body

string¦null

false

none

» periodColumnName

body

string¦null

false

none

» sourceData

body

RESTAPI.v1.DTOs.Hierarchy.HierarchySourceDTOV1

false

none

»» name

body

string¦null

false

none

»» label

body

string¦null

false

none

»» type

body

string¦null

false

none

»» columns

body

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

»»» name

body

string¦null

false

none

»»» type

body

string

false

none

»»» isKey

body

boolean

false

none

»»» nullable

body

boolean

false

none

»»» values

body

string¦null

false

none

»»» lockedPeriod

body

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

»»»» start

body

string(date-time)

false

none

»»»» end

body

string(date-time)

false

none

»»» referencedCol

body

string¦null

false

none

»»» picklistFilter

body

string¦null

false

none

»»» displayName

body

string¦null

false

none

»»» isELTPeriod

body

boolean¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Enumerated Values

Parameter

Value

»»» type

String

»»» type

LongString

»»» type

MaxString

»»» type

Date

»»» type

DateTime

»»» type

Decimal

»»» type

Int

»»» type

Long

»»» type

Float

»»» type

BLOB

»»» type

Identity

»»» type

CLOB

»»» type

RowVersion

»»» type

UID

»»» type

VarCharMax

»»» type

Boolean

Responses

Status

Meaning

Description

Schema

201

Created

Create a hierarchy

RESTAPI.v1.DTOs.Hierarchy.HierarchyDTOV1

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/hierarchies", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/hierarchies");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "name": "string",
  "description": "string",
  "sourceName": "string",
  "sourceLabel": "string",
  "payeeColumnName": "string",
  "reportsToColumnName": "string",
  "periodColumnName": "string",
  "sourceData": {
    "name": "string",
    "label": "string",
    "type": "string",
    "columns": [
      {}
    ]
  },
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/hierarchies',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/hierarchies', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/hierarchies',
  params: {
  }, headers: headers

p JSON.parse(result)

Get hierarchy by ID.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Get hierarchy by ID

RESTAPI.v1.DTOs.Hierarchy.HierarchyDTOV1

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/hierarchies/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/hierarchies/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/hierarchies/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/hierarchies/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/hierarchies/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "description": "string",
  "sourceName": "string",
  "sourceLabel": "string",
  "payeeColumnName": "string",
  "reportsToColumnName": "string",
  "periodColumnName": "string",
  "sourceData": {
    "name": "string",
    "label": "string",
    "type": "string",
    "columns": [
      {}
    ]
  },
  "version": {
    "rowVersion": 0
  }
}
{"id":0,"name":"string","description":"string","sourceName":"string","sourceLabel":"string","payeeColumnName":"string","reportsToColumnName":"string","periodColumnName":"string","sourceData":{"name":"string","label":"string","type":"string","columns":[{}]},"version":{"rowVersion":0}}

Update a hierarchy.

Body parameter

{
  "id": 0,
  "name": "string",
  "description": "string",
  "sourceName": "string",
  "sourceLabel": "string",
  "payeeColumnName": "string",
  "reportsToColumnName": "string",
  "periodColumnName": "string",
  "sourceData": {
    "name": "string",
    "label": "string",
    "type": "string",
    "columns": [
      {}
    ]
  },
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

RESTAPI.v1.DTOs.Hierarchy.HierarchyDTOV1

false

none

» id

body

integer(int32)

false

none

» name

body

string¦null

false

none

» description

body

string¦null

false

none

» sourceName

body

string¦null

false

none

» sourceLabel

body

string¦null

false

none

» payeeColumnName

body

string¦null

false

none

» reportsToColumnName

body

string¦null

false

none

» periodColumnName

body

string¦null

false

none

» sourceData

body

RESTAPI.v1.DTOs.Hierarchy.HierarchySourceDTOV1

false

none

»» name

body

string¦null

false

none

»» label

body

string¦null

false

none

»» type

body

string¦null

false

none

»» columns

body

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

»»» name

body

string¦null

false

none

»»» type

body

string

false

none

»»» isKey

body

boolean

false

none

»»» nullable

body

boolean

false

none

»»» values

body

string¦null

false

none

»»» lockedPeriod

body

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

»»»» start

body

string(date-time)

false

none

»»»» end

body

string(date-time)

false

none

»»» referencedCol

body

string¦null

false

none

»»» picklistFilter

body

string¦null

false

none

»»» displayName

body

string¦null

false

none

»»» isELTPeriod

body

boolean¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Enumerated Values

Parameter

Value

»»» type

String

»»» type

LongString

»»» type

MaxString

»»» type

Date

»»» type

DateTime

»»» type

Decimal

»»» type

Int

»»» type

Long

»»» type

Float

»»» type

BLOB

»»» type

Identity

»»» type

CLOB

»»» type

RowVersion

»»» type

UID

»»» type

VarCharMax

»»» type

Boolean

Responses

Status

Meaning

Description

Schema

200

OK

Update a hierarchy

RESTAPI.v1.DTOs.Hierarchy.HierarchyDTOV1

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/hierarchies/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/hierarchies/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "id": 0,
  "name": "string",
  "description": "string",
  "sourceName": "string",
  "sourceLabel": "string",
  "payeeColumnName": "string",
  "reportsToColumnName": "string",
  "periodColumnName": "string",
  "sourceData": {
    "name": "string",
    "label": "string",
    "type": "string",
    "columns": [
      {}
    ]
  },
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/hierarchies/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/hierarchies/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/hierarchies/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

Delete a hierarchy.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

204

No Content

Delete a hierarchy

RESTAPI.v1.DTOs.Hierarchy.HierarchyDTOV1

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/hierarchies/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/hierarchies/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/hierarchies/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('http://localhost:8080/api/v1/hierarchies/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.delete 'http://localhost:8080/api/v1/hierarchies/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "id": 0,
  "name": "string",
  "description": "string",
  "sourceName": "string",
  "sourceLabel": "string",
  "payeeColumnName": "string",
  "reportsToColumnName": "string",
  "periodColumnName": "string",
  "sourceData": {
    "name": "string",
    "label": "string",
    "type": "string",
    "columns": [
      {}
    ]
  },
  "version": {
    "rowVersion": 0
  }
}
{"id":0,"name":"string","description":"string","sourceName":"string","sourceLabel":"string","payeeColumnName":"string","reportsToColumnName":"string","periodColumnName":"string","sourceData":{"name":"string","label":"string","type":"string","columns":[{}]},"version":{"rowVersion":0}}

Get sources available to be mapped to a hierarchy.

Parameters

Name

In

Type

Required

Description

displayNameFilter

query

string

false

none

limit

query

integer(int32)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Get available sources

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.Hierarchy.HierarchySourceDTOV1]

false

none

none

» name

string¦null

false

none

none

» label

string¦null

false

none

none

» type

string¦null

false

none

none

» columns

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

none

»» name

string¦null

false

none

none

»» type

string

false

none

none

»» isKey

boolean

false

none

none

»» nullable

boolean

false

none

none

»» values

string¦null

false

none

none

»» lockedPeriod

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

none

»»» start

string(date-time)

false

none

none

»»» end

string(date-time)

false

none

none

»» referencedCol

string¦null

false

none

none

»» picklistFilter

string¦null

false

none

none

»» displayName

string¦null

false

none

none

»» isELTPeriod

boolean¦null

false

none

none

Enumerated Values

Property

Value

type

String

type

LongString

type

MaxString

type

Date

type

DateTime

type

Decimal

type

Int

type

Long

type

Float

type

BLOB

type

Identity

type

CLOB

type

RowVersion

type

UID

type

VarCharMax

type

Boolean

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/hierarchies/sources", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/hierarchies/sources");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/hierarchies/sources',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/hierarchies/sources', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/hierarchies/sources',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "name": "string",
    "label": "string",
    "type": "string",
    "columns": [
      {}
    ]
  }
]
[{"name":"string","label":"string","type":"string","columns":[{}]}]

Get minimal hierarchy information. Does not require view permissions for hierarchies.

Responses

Status

Meaning

Description

Schema

200

OK

Get compact hierarchies

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.Hierarchy.HierarchyCompactDTOV1]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/hierarchiescompact", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/hierarchiescompact");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/hierarchiescompact',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/hierarchiescompact', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/hierarchiescompact',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "name": "string"
  }
]
[{"id":0,"name":"string"}]

Gets available periods for a given hierarchy for the current web user.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

201

Created

Get periods for hierarchy

RESTAPI.v1.DTOs.Hierarchy.HierarchyPeriodDTOV1

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/payee/hierarchies/{id}/periods", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payee/hierarchies/{id}/periods");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/payee/hierarchies/{id}/periods',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/payee/hierarchies/{id}/periods', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/payee/hierarchies/{id}/periods',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "periods": [
    "string"
  ]
}
{"periods":["string"]}

Get visible payees for the current web user for a given hierarchy and period.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

period

query

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Get visible payees for hierarchy and period

RESTAPI.v1.DTOs.Hierarchy.HierarchyPayeeDTOV1

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/payee/hierarchies/{id}/payees", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payee/hierarchies/{id}/payees");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/payee/hierarchies/{id}/payees',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/payee/hierarchies/{id}/payees', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/payee/hierarchies/{id}/payees',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "currentPayee": "string",
  "visiblePayees": [
    "string"
  ]
}
{"currentPayee":"string","visiblePayees":["string"]}

HealthDashboard

Run Evaluation

Body parameter

{
  "metricIDs": [
    "string"
  ]
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v2.DTOs.HealthDashboard.HealthSnapshotRequestDTO

false

none

» metricIDs

body

[string]¦null

false

none

Responses

Status

Meaning

Description

Schema

201

Created

Run Model Health Evaluation

Inline

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v2/rpc/healthdashboard/run", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v2/rpc/healthdashboard/run");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "metricIDs": [
    "string"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v2/rpc/healthdashboard/run',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v2/rpc/healthdashboard/run', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v2/rpc/healthdashboard/run',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "property1": "string",
  "property2": "string"
}
{"property1":"string","property2":"string"}

Generate a snapshot and return summary.

Body parameter

{
  "metricIDs": [
    "string"
  ]
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v2.DTOs.HealthDashboard.HealthSnapshotRequestDTO

false

none

» metricIDs

body

[string]¦null

false

none

Responses

Status

Meaning

Description

Schema

201

Created

Run Model Health Evaluation and return summary

RESTAPI.v2.DTOs.HealthDashboard.HealthSnapshotResponseDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v2/healthdashboard/summary", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v2/healthdashboard/summary");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "metricIDs": [
    "string"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v2/healthdashboard/summary',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v2/healthdashboard/summary', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v2/healthdashboard/summary',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "snapshotID": 0,
  "metrics": [
    {
      "metric": {},
      "status": "Success",
      "value": 0
    }
  ]
}
{"snapshotID":0,"metrics":[{"metric":{},"status":"Success","value":0}]}

Generate a snapshot and return details.

Body parameter

{
  "metricIDs": [
    "string"
  ]
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v2.DTOs.HealthDashboard.HealthSnapshotRequestDTO

false

none

» metricIDs

body

[string]¦null

false

none

Responses

Status

Meaning

Description

Schema

201

Created

Run Model Health Evaluation and return detailed summary

RESTAPI.v2.DTOs.HealthDashboard.HealthSnapshotDetailsResponseDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v2/healthdashboard/details", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v2/healthdashboard/details");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "metricIDs": [
    "string"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v2/healthdashboard/details',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v2/healthdashboard/details', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v2/healthdashboard/details',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "snapshotID": 0,
  "runDate": "2019-08-24T14:15:22Z",
  "metrics": [
    {
      "summary": {},
      "details": {},
      "links": [],
      "reviews": [],
      "displayType": []
    }
  ]
}
{"snapshotID":0,"runDate":"2019-08-24T14:15:22Z","metrics":[{"summary":{},"details":{},"links":[],"reviews":[],"displayType":[]}]}

Delete Snapshot.

Body parameter

[
  0
]

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

false

none

Responses

Status

Meaning

Description

Schema

201

Created

Delete multiple Health Evaluations

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v2/healthdashboard", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v2/healthdashboard");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  0
]';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v2/healthdashboard',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.delete('http://localhost:8080/api/v2/healthdashboard', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.delete 'http://localhost:8080/api/v2/healthdashboard',
  params: {
  }, headers: headers

p JSON.parse(result)

Get summary result from saved snapshot.

Parameters

Name

In

Type

Required

Description

snapshot

path

string

true

none

Responses

Status

Meaning

Description

Schema

201

Created

Get Health Evaluation Summary

RESTAPI.v2.DTOs.HealthDashboard.HealthSnapshotResponseDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v2/healthdashboard/{snapshot}/summary", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v2/healthdashboard/{snapshot}/summary");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v2/healthdashboard/{snapshot}/summary',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v2/healthdashboard/{snapshot}/summary', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v2/healthdashboard/{snapshot}/summary',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "snapshotID": 0,
  "metrics": [
    {
      "metric": {},
      "status": "Success",
      "value": 0
    }
  ]
}
{"snapshotID":0,"metrics":[{"metric":{},"status":"Success","value":0}]}

Get detailed result from saved snapshot.

Parameters

Name

In

Type

Required

Description

snapshot

path

string

true

none

Responses

Status

Meaning

Description

Schema

201

Created

Get Health Evaluation Summary and Detail

RESTAPI.v2.DTOs.HealthDashboard.HealthSnapshotDetailsResponseDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v2/healthdashboard/{snapshot}/details", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v2/healthdashboard/{snapshot}/details");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v2/healthdashboard/{snapshot}/details',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v2/healthdashboard/{snapshot}/details', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v2/healthdashboard/{snapshot}/details',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "snapshotID": 0,
  "runDate": "2019-08-24T14:15:22Z",
  "metrics": [
    {
      "summary": {},
      "details": {},
      "links": [],
      "reviews": [],
      "displayType": []
    }
  ]
}
{"snapshotID":0,"runDate":"2019-08-24T14:15:22Z","metrics":[{"summary":{},"details":{},"links":[],"reviews":[],"displayType":[]}]}

Get detail result for single metric from saved snapshot.

Parameters

Name

In

Type

Required

Description

snapshot

path

string

true

none

metricId

path

string

true

none

Responses

Status

Meaning

Description

Schema

201

Created

Get Health Evaluation Summary and Detail for single Metric

RESTAPI.v2.DTOs.HealthDashboard.HealthSnapshotDetailsResponseDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v2/healthdashboard/{snapshot}/details/{metricId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v2/healthdashboard/{snapshot}/details/{metricId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v2/healthdashboard/{snapshot}/details/{metricId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v2/healthdashboard/{snapshot}/details/{metricId}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v2/healthdashboard/{snapshot}/details/{metricId}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "snapshotID": 0,
  "runDate": "2019-08-24T14:15:22Z",
  "metrics": [
    {
      "summary": {},
      "details": {},
      "links": [],
      "reviews": [],
      "displayType": []
    }
  ]
}
{"snapshotID":0,"runDate":"2019-08-24T14:15:22Z","metrics":[{"summary":{},"details":{},"links":[],"reviews":[],"displayType":[]}]}

Get Metrics.

Responses

Status

Meaning

Description

Schema

201

Created

Get Set of Health Evaluation Metrics

RESTAPI.v2.DTOs.HealthDashboard.HealthMetricsResponseDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v2/healthdashboard/metrics", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v2/healthdashboard/metrics");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v2/healthdashboard/metrics',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v2/healthdashboard/metrics', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v2/healthdashboard/metrics',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "metrics": [
    {
      "id": "string",
      "name": "string",
      "description": "string"
    }
  ]
}
{"metrics":[{"id":"string","name":"string","description":"string"}]}

Get Snapshots.

Responses

Status

Meaning

Description

Schema

201

Created

Get Set of Health Evaluations

RESTAPI.v2.DTOs.HealthDashboard.HealthSnapshotsResponseDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v2/healthdashboard/snapshots", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v2/healthdashboard/snapshots");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v2/healthdashboard/snapshots',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v2/healthdashboard/snapshots', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v2/healthdashboard/snapshots',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "snapshots": [
    {
      "snapshotID": 0,
      "runDate": "2019-08-24T14:15:22Z"
    }
  ]
}
{"snapshots":[{"snapshotID":0,"runDate":"2019-08-24T14:15:22Z"}]}

Returns Snapshot as an excel file

Parameters

Name

In

Type

Required

Description

snapshot

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

System.Net.Http.StreamContent

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v2/rpc/healthdashboard/export/{snapshot}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v2/rpc/healthdashboard/export/{snapshot}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v2/rpc/healthdashboard/export/{snapshot}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v2/rpc/healthdashboard/export/{snapshot}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v2/rpc/healthdashboard/export/{snapshot}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "headers": [
    {
      "key": "string",
      "value": []
    }
  ]
}
{"headers":[{"key":"string","value":[]}]}

Add review to snapshot detail.

Body parameter

{
  "snapshotID": 0,
  "metricID": "string",
  "rowID": 0,
  "objectID": "string",
  "reviewed": 0,
  "comment": "string",
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

snapshotID

path

integer(int32)

true

none

body

body

RESTAPI.v2.DTOs.HealthDashboard.HealthMetricResultItemReviewDTO

false

none

» snapshotID

body

integer(int32)

false

none

» metricID

body

string¦null

false

none

» rowID

body

integer(int32)

false

none

» objectID

body

string¦null

false

none

» reviewed

body

integer(int32)

false

none

» comment

body

string¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Responses

Status

Meaning

Description

Schema

201

Created

Add review to snapshot detail

RESTAPI.v2.DTOs.HealthDashboard.HealthMetricResultItemReviewDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v2/healthdashboard/{snapshotID}/review", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v2/healthdashboard/{snapshotID}/review");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "snapshotID": 0,
  "metricID": "string",
  "rowID": 0,
  "objectID": "string",
  "reviewed": 0,
  "comment": "string",
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v2/healthdashboard/{snapshotID}/review',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v2/healthdashboard/{snapshotID}/review', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v2/healthdashboard/{snapshotID}/review',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "snapshotID": 0,
  "metricID": "string",
  "rowID": 0,
  "objectID": "string",
  "reviewed": 0,
  "comment": "string",
  "version": {
    "rowVersion": 0
  }
}
{"snapshotID":0,"metricID":"string","rowID":0,"objectID":"string","reviewed":0,"comment":"string","version":{"rowVersion":0}}

Update review to snapshot detail.

Body parameter

{
  "snapshotID": 0,
  "metricID": "string",
  "rowID": 0,
  "objectID": "string",
  "reviewed": 0,
  "comment": "string",
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

snapshotID

path

integer(int32)

true

none

body

body

RESTAPI.v2.DTOs.HealthDashboard.HealthMetricResultItemReviewDTO

false

none

» snapshotID

body

integer(int32)

false

none

» metricID

body

string¦null

false

none

» rowID

body

integer(int32)

false

none

» objectID

body

string¦null

false

none

» reviewed

body

integer(int32)

false

none

» comment

body

string¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Responses

Status

Meaning

Description

Schema

201

Created

Update review to snapshot detail

RESTAPI.v2.DTOs.HealthDashboard.HealthMetricResultItemReviewDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v2/healthdashboard/{snapshotID}/review", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v2/healthdashboard/{snapshotID}/review");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "snapshotID": 0,
  "metricID": "string",
  "rowID": 0,
  "objectID": "string",
  "reviewed": 0,
  "comment": "string",
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v2/healthdashboard/{snapshotID}/review',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v2/healthdashboard/{snapshotID}/review', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v2/healthdashboard/{snapshotID}/review',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "snapshotID": 0,
  "metricID": "string",
  "rowID": 0,
  "objectID": "string",
  "reviewed": 0,
  "comment": "string",
  "version": {
    "rowVersion": 0
  }
}
{"snapshotID":0,"metricID":"string","rowID":0,"objectID":"string","reviewed":0,"comment":"string","version":{"rowVersion":0}}

Delete review to snapshot detail.

Parameters

Name

In

Type

Required

Description

snapshotID

path

integer(int32)

true

none

metricID

path

string

true

none

dataRowID

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

201

Created

Delete review to snapshot detail

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v2/healthdashboard/{snapshotID}/review/{metricID}/details/{dataRowID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v2/healthdashboard/{snapshotID}/review/{metricID}/details/{dataRowID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v2/healthdashboard/{snapshotID}/review/{metricID}/details/{dataRowID}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v2/healthdashboard/{snapshotID}/review/{metricID}/details/{dataRowID}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v2/healthdashboard/{snapshotID}/review/{metricID}/details/{dataRowID}',
  params: {
  }

p JSON.parse(result)

Intercom

IntercomControllerV2_GetIntercomUserHash

Parameters

Name

In

Type

Required

Description

userID

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

string

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v2/intercom/hash/{userID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v2/intercom/hash/{userID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v2/intercom/hash/{userID}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v2/intercom/hash/{userID}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v2/intercom/hash/{userID}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
"string"
"string"

DocumentationBucketUrl

Get Tenant’s Documentation Bucket URL

Parameters

Name

In

Type

Required

Description

tenantId

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

string

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/documentation/documentationbucketurl/{tenantId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/documentation/documentationbucketurl/{tenantId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/documentation/documentationbucketurl/{tenantId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/documentation/documentationbucketurl/{tenantId}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/documentation/documentationbucketurl/{tenantId}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
"string"
"string"

AdminUserSetting

Create rule for the workflow inquiry form

Body parameter

{
  "myAssignedInquiry": null,
  "myAffiliatedInquiry": null,
  "myUnAssignedInquiry": null
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Notification.Notification_WFSettingTypes_AdminDTO

false

none

» myAssignedInquiry

body

any

false

none

» myAffiliatedInquiry

body

any

false

none

» myUnAssignedInquiry

body

any

false

none

Responses

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/user/setting/notification/workflow/admin/create", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/user/setting/notification/workflow/admin/create");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "myAssignedInquiry": null,
  "myAffiliatedInquiry": null,
  "myUnAssignedInquiry": null
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/user/setting/notification/workflow/admin/create',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/user/setting/notification/workflow/admin/create', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/user/setting/notification/workflow/admin/create',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "adminId": "string",
  "wfSettings": {
    "myAssignedInquiry": null,
    "myAffiliatedInquiry": null,
    "myUnAssignedInquiry": null
  }
}
{"adminId":"string","wfSettings":{"myAssignedInquiry":null,"myAffiliatedInquiry":null,"myUnAssignedInquiry":null}}

AdminSettingControllerV1_Notification_Workflow_ReadUserOrSystemDefault

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.Notification.Notification_WFSetting_AdminDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/user/setting/notification/workflow/admin/readorsystemdefault", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/user/setting/notification/workflow/admin/readorsystemdefault");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/user/setting/notification/workflow/admin/readorsystemdefault',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/user/setting/notification/workflow/admin/readorsystemdefault', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/user/setting/notification/workflow/admin/readorsystemdefault',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "adminId": "string",
  "wfSettings": {
    "myAssignedInquiry": null,
    "myAffiliatedInquiry": null,
    "myUnAssignedInquiry": null
  }
}
{"adminId":"string","wfSettings":{"myAssignedInquiry":null,"myAffiliatedInquiry":null,"myUnAssignedInquiry":null}}

AdminSettingControllerV1_Notification_Workflow_Update

Body parameter

{
  "myAssignedInquiry": null,
  "myAffiliatedInquiry": null,
  "myUnAssignedInquiry": null
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Notification.Notification_WFSettingTypes_AdminDTO

false

none

» myAssignedInquiry

body

any

false

none

» myAffiliatedInquiry

body

any

false

none

» myUnAssignedInquiry

body

any

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.Notification.Notification_WFSetting_AdminDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/user/setting/notification/workflow/admin/update", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/user/setting/notification/workflow/admin/update");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "myAssignedInquiry": null,
  "myAffiliatedInquiry": null,
  "myUnAssignedInquiry": null
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/user/setting/notification/workflow/admin/update',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/user/setting/notification/workflow/admin/update', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/user/setting/notification/workflow/admin/update',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "adminId": "string",
  "wfSettings": {
    "myAssignedInquiry": null,
    "myAffiliatedInquiry": null,
    "myUnAssignedInquiry": null
  }
}
{"adminId":"string","wfSettings":{"myAssignedInquiry":null,"myAffiliatedInquiry":null,"myUnAssignedInquiry":null}}

AdminSettingControllerV1_Notification_Workflow_Delete

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/user/setting/notification/workflow/admin/delete", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/user/setting/notification/workflow/admin/delete");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/user/setting/notification/workflow/admin/delete',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/user/setting/notification/workflow/admin/delete')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/user/setting/notification/workflow/admin/delete',
  params: {
  }

p JSON.parse(result)

PayeeUserSetting

Create payee Notification Setting info

Body parameter

{
  "myCreatedInquiry": {
    "anAdminIsAssigned": true,
    "formValueChange": true,
    "commentOnInquiry": true,
    "takeAction": true
  },
  "myAffiliatedInquiry": {
    "anAdminIsAssigned": true,
    "formValueChange": true,
    "commentOnInquiry": true,
    "takeAction": true
  }
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Notification.Notification_WFSettingTypes_PayeeDTO

false

none

» myCreatedInquiry

body

RESTAPI.v1.DTOs.Notification.CreatedInquiryDTO

false

none

»» anAdminIsAssigned

body

boolean

false

none

»» formValueChange

body

boolean

false

none

»» commentOnInquiry

body

boolean

false

none

»» takeAction

body

boolean

false

none

» myAffiliatedInquiry

body

RESTAPI.v1.DTOs.Notification.AffiliatedInquiryDTO

false

none

»» anAdminIsAssigned

body

boolean

false

none

»» formValueChange

body

boolean

false

none

»» commentOnInquiry

body

boolean

false

none

»» takeAction

body

boolean

false

none

Responses

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/user/setting/notification/workflow/payee/create", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/user/setting/notification/workflow/payee/create");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "myCreatedInquiry": {
    "anAdminIsAssigned": true,
    "formValueChange": true,
    "commentOnInquiry": true,
    "takeAction": true
  },
  "myAffiliatedInquiry": {
    "anAdminIsAssigned": true,
    "formValueChange": true,
    "commentOnInquiry": true,
    "takeAction": true
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/user/setting/notification/workflow/payee/create',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/user/setting/notification/workflow/payee/create', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/user/setting/notification/workflow/payee/create',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "payeeid": "string",
  "wfsettings": {
    "myCreatedInquiry": {
      "anAdminIsAssigned": true,
      "formValueChange": true,
      "commentOnInquiry": true,
      "takeAction": true
    },
    "myAffiliatedInquiry": {
      "anAdminIsAssigned": true,
      "formValueChange": true,
      "commentOnInquiry": true,
      "takeAction": true
    }
  }
}
{"payeeid":"string","wfsettings":{"myCreatedInquiry":{"anAdminIsAssigned":true,"formValueChange":true,"commentOnInquiry":true,"takeAction":true},"myAffiliatedInquiry":{"anAdminIsAssigned":true,"formValueChange":true,"commentOnInquiry":true,"takeAction":true}}}

PayeeSettingControllerV1_Notification_Workflow_ReadUserOrSystemDefault

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.Notification.Notification_WFSetting_PayeeDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/user/setting/notification/workflow/payee/readorsystemdefault", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/user/setting/notification/workflow/payee/readorsystemdefault");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/user/setting/notification/workflow/payee/readorsystemdefault',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/user/setting/notification/workflow/payee/readorsystemdefault', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/user/setting/notification/workflow/payee/readorsystemdefault',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "payeeid": "string",
  "wfsettings": {
    "myCreatedInquiry": {
      "anAdminIsAssigned": true,
      "formValueChange": true,
      "commentOnInquiry": true,
      "takeAction": true
    },
    "myAffiliatedInquiry": {
      "anAdminIsAssigned": true,
      "formValueChange": true,
      "commentOnInquiry": true,
      "takeAction": true
    }
  }
}
{"payeeid":"string","wfsettings":{"myCreatedInquiry":{"anAdminIsAssigned":true,"formValueChange":true,"commentOnInquiry":true,"takeAction":true},"myAffiliatedInquiry":{"anAdminIsAssigned":true,"formValueChange":true,"commentOnInquiry":true,"takeAction":true}}}

PayeeSettingControllerV1_Notification_Workflow_Update

Body parameter

{
  "myCreatedInquiry": {
    "anAdminIsAssigned": true,
    "formValueChange": true,
    "commentOnInquiry": true,
    "takeAction": true
  },
  "myAffiliatedInquiry": {
    "anAdminIsAssigned": true,
    "formValueChange": true,
    "commentOnInquiry": true,
    "takeAction": true
  }
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Notification.Notification_WFSettingTypes_PayeeDTO

false

none

» myCreatedInquiry

body

RESTAPI.v1.DTOs.Notification.CreatedInquiryDTO

false

none

»» anAdminIsAssigned

body

boolean

false

none

»» formValueChange

body

boolean

false

none

»» commentOnInquiry

body

boolean

false

none

»» takeAction

body

boolean

false

none

» myAffiliatedInquiry

body

RESTAPI.v1.DTOs.Notification.AffiliatedInquiryDTO

false

none

»» anAdminIsAssigned

body

boolean

false

none

»» formValueChange

body

boolean

false

none

»» commentOnInquiry

body

boolean

false

none

»» takeAction

body

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.Notification.Notification_WFSetting_PayeeDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/user/setting/notification/workflow/payee/update", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/user/setting/notification/workflow/payee/update");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "myCreatedInquiry": {
    "anAdminIsAssigned": true,
    "formValueChange": true,
    "commentOnInquiry": true,
    "takeAction": true
  },
  "myAffiliatedInquiry": {
    "anAdminIsAssigned": true,
    "formValueChange": true,
    "commentOnInquiry": true,
    "takeAction": true
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/user/setting/notification/workflow/payee/update',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/user/setting/notification/workflow/payee/update', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/user/setting/notification/workflow/payee/update',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "payeeid": "string",
  "wfsettings": {
    "myCreatedInquiry": {
      "anAdminIsAssigned": true,
      "formValueChange": true,
      "commentOnInquiry": true,
      "takeAction": true
    },
    "myAffiliatedInquiry": {
      "anAdminIsAssigned": true,
      "formValueChange": true,
      "commentOnInquiry": true,
      "takeAction": true
    }
  }
}
{"payeeid":"string","wfsettings":{"myCreatedInquiry":{"anAdminIsAssigned":true,"formValueChange":true,"commentOnInquiry":true,"takeAction":true},"myAffiliatedInquiry":{"anAdminIsAssigned":true,"formValueChange":true,"commentOnInquiry":true,"takeAction":true}}}

PayeeSettingControllerV1_Notification_Workflow_Delete

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/user/setting/notification/workflow/payee/delete", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/user/setting/notification/workflow/payee/delete");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/user/setting/notification/workflow/payee/delete',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/user/setting/notification/workflow/payee/delete')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/user/setting/notification/workflow/payee/delete',
  params: {
  }

p JSON.parse(result)

AutomatedTestLoggerStatus

Get the automated test logger status.

Responses

Status

Meaning

Description

Schema

200

OK

Get automated test logger status

boolean

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/automatedtestloggerstatus", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/automatedtestloggerstatus");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/automatedtestloggerstatus',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/automatedtestloggerstatus', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/automatedtestloggerstatus',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
true
true

Get the automated test logger message queue count.

Responses

Status

Meaning

Description

Schema

200

OK

Get the automated test logger message queue count

integer

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/automatedtestloggerstatus/messagecount", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/automatedtestloggerstatus/messagecount");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/automatedtestloggerstatus/messagecount',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/automatedtestloggerstatus/messagecount', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/automatedtestloggerstatus/messagecount',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
0
0

SingleActionResolver

Gets all migrated Module 1 Plan Docs mapped to the corresponding Module2 Plan Docs.

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.PlanDocsMigration.MigratedPlanDocsDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/plandocs/convert", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plandocs/convert");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plandocs/convert',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/plandocs/convert', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/plandocs/convert',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "migratedPlanDocsMap": {
    "property1": 0,
    "property2": 0
  }
}
{"migratedPlanDocsMap":{"property1":0,"property2":0}}

Migrates all Plan Docs in a model from Module1 to Module2.

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/plandocs/convert", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plandocs/convert");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plandocs/convert',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/plandocs/convert', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/plandocs/convert',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "property1": "string",
  "property2": "string"
}
{"property1":"string","property2":"string"}

Migrates a specific Plan Doc in a model from Module1 to Module2.

Parameters

Name

In

Type

Required

Description

planApprovalTemplateId

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/plandocs/convert/{planApprovalTemplateId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plandocs/convert/{planApprovalTemplateId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plandocs/convert/{planApprovalTemplateId}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/plandocs/convert/{planApprovalTemplateId}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/plandocs/convert/{planApprovalTemplateId}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "property1": "string",
  "property2": "string"
}
{"property1":"string","property2":"string"}

Allows a specific Plan Doc in a model to be migrated again from Module1 to Module2.

Parameters

Name

In

Type

Required

Description

planApprovalTemplateId

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/plandocs/unconvert/{planApprovalTemplateId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plandocs/unconvert/{planApprovalTemplateId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plandocs/unconvert/{planApprovalTemplateId}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/plandocs/unconvert/{planApprovalTemplateId}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/plandocs/unconvert/{planApprovalTemplateId}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "property1": "string",
  "property2": "string"
}
{"property1":"string","property2":"string"}

Gets all Plan Doc Migration Audit Logs.

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.Domain.Audit.AuditItem]

false

none

none

» message

string¦null

false

none

none

» hasHistory

boolean

false

none

none

» auditId

integer(int32)

false

none

none

» type

string

false

none

none

» userId

string¦null

false

none

none

» module

string¦null

false

none

none

» event

string¦null

false

read-only

none

» time

string(date-time)

false

none

none

» revisionStart

integer(int32)¦null

false

none

none

» revisionEnd

integer(int32)¦null

false

none

none

Enumerated Values

Property

Value

type

Admin

type

Web

type

Anonymous

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/plandocs/audit", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plandocs/audit");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/plandocs/audit',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/plandocs/audit', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/plandocs/audit',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "message": "string",
    "hasHistory": true,
    "auditId": 0,
    "type": "Admin",
    "userId": "string",
    "module": "string",
    "event": "string",
    "time": "2019-08-24T14:15:22Z",
    "revisionStart": 0,
    "revisionEnd": 0
  }
]
[{"message":"string","hasHistory":true,"auditId":0,"type":"Admin","userId":"string","module":"string","event":"string","time":"2019-08-24T14:15:22Z","revisionStart":0,"revisionEnd":0}]

Execute Action From Single Action Token

Parameters

Name

In

Type

Required

Description

access_token

query

string

false

none

Responses

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/singleactionresolver/execute", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/singleactionresolver/execute");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/singleactionresolver/execute',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/singleactionresolver/execute', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/singleactionresolver/execute',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "workflowActionSingleActionResultDTO": {
    "workflowId": 0,
    "inquiryId": 0,
    "workflowActionName": "string",
    "userName": "string",
    "resolvedWorkflowActionStatus": "Succeeded"
  }
}
{"workflowActionSingleActionResultDTO":{"workflowId":0,"inquiryId":0,"workflowActionName":"string","userName":"string","resolvedWorkflowActionStatus":"Succeeded"}}

TenantCustomBanner

Get Tenant’s Custom Banner by Tenant Id

Responses

Status

Meaning

Description

Schema

200

OK

Success

string

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/tenantcustombanner", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/tenantcustombanner");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/tenantcustombanner',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/tenantcustombanner', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/tenantcustombanner',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
"string"
"string"

CalculationsControllerV1

Initialize locked records sync to meta bucket (SPM-91414, MP-1811)

Responses

Status

Meaning

Description

Schema

202

Accepted

Initial Sync triggered

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/initsynctometa", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/initsynctometa");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/initsynctometa',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/initsynctometa')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/initsynctometa',
  params: {
  }

p JSON.parse(result)

CloudDataWarehouse

Syncback calculation result to CDW

Responses

Status

Meaning

Description

Schema

202

Accepted

Trigger syncback to CDW

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/internal/cdw/syncback", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/cdw/syncback");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/internal/cdw/syncback',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/internal/cdw/syncback')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/internal/cdw/syncback',
  params: {
  }

p JSON.parse(result)

Evict calculation results supported by CDW

Responses

Status

Meaning

Description

Schema

200

OK

Eviction triggered

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/internal/cdw/evict", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/cdw/evict");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/internal/cdw/evict',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/internal/cdw/evict')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/internal/cdw/evict',
  params: {
  }

p JSON.parse(result)

DataControllerV1

this endpoint may be called in at least the following situations:

  • From row viewer’s editor, when populating the list of available options for a picklist column

  • From row viewer in order to show the description of a field directly from a row (e.g. clicking on a cell from the ‘Parent’ column from the ‘Payee’ table after enabling it to show the descriptions.

Parameters

Name

In

Type

Required

Description

tablename

path

string

true

none

columnname

path

string

true

none

effectiveDate

query

string(date-time)

false

none

rowData

query

string

false

none

offset

query

integer(int32)

false

none

limit

query

integer(int32)

false

none

filter

query

string

false

none

isColumnFilter

query

boolean

false

none

isDropDownList

query

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/customtables/{tablename}/descriptions/{columnName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/customtables/{tablename}/descriptions/{columnName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/customtables/{tablename}/descriptions/{columnName}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.get('http://localhost:8080/api/v1/customtables/{tablename}/descriptions/{columnName}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.get 'http://localhost:8080/api/v1/customtables/{tablename}/descriptions/{columnName}',
  params: {
  }

p JSON.parse(result)

DataStoresControllerV1

Get datastore view restrictions.

Parameters

Name

In

Type

Required

Description

datastoreId

path

integer(int32)

true

DataStore Id

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.Composer.WebDataEditRestrictionsDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/datastores/viewrestrictions/{datastoreid}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/datastores/viewrestrictions/{datastoreid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/datastores/viewrestrictions/{datastoreid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/datastores/viewrestrictions/{datastoreid}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/datastores/viewrestrictions/{datastoreid}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "source": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "tableSchema": {
    "columns": [
      {}
    ],
    "table": "string",
    "name": "string",
    "referencedSources": [
      "string"
    ],
    "referencedTimes": [
      {}
    ],
    "referencedSourcesDictionary": {
      "property1": "string",
      "property2": "string"
    },
    "referencedTimesDictionary": {
      "property1": {},
      "property2": {}
    }
  }
}
{"source":{"query":{"selectItems":[],"source":{},"joins":[],"whereClause":{},"order":[],"group":[],"havingClause":{},"distinct":true,"unionWith":null,"exceptWith":null},"sourceNames":{"property1":"string","property2":"string"}},"tableSchema":{"columns":[{}],"table":"string","name":"string","referencedSources":["string"],"referencedTimes":[{}],"referencedSourcesDictionary":{"property1":"string","property2":"string"},"referencedTimesDictionary":{"property1":{},"property2":{}}}}

Update datastore view restrictions.

Body parameter

{
  "query": {
    "selectItems": [
      {}
    ],
    "source": {
      "namespaceTable": {},
      "query": null,
      "alias": "string",
      "sourceType": "Table"
    },
    "joins": [
      {}
    ],
    "whereClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "order": [
      {}
    ],
    "group": [
      {}
    ],
    "havingClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "distinct": true,
    "unionWith": null,
    "exceptWith": null
  },
  "sourceNames": {
    "property1": "string",
    "property2": "string"
  }
}

Parameters

Name

In

Type

Required

Description

datastoreId

path

integer(int32)

true

DataStore Id

body

body

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

Query of restriction

» query

body

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

»» selectItems

body

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦null

false

none

»»» alias

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» table

body

string¦null

false

none

»»» customSelect

body

string¦null

false

none

»»» dataType

body

string

false

none

»»» type

body

string

false

none

»»» value

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» expressionType

body

string

false

none

»»»» cases

body

array¦null

false

none

»»»»» anonymous

body

any

false

none

»»»» table

body

string¦null

false

none

»»»» column

body

string¦null

false

none

»»»» op

body

string¦null

false

none

»»»» arguments

body

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

[DTO version of IExpression]

»»»»» expressionType

body

string

false

none

»»»»» cases

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» table

body

string¦null

false

none

»»»»» column

body

string¦null

false

none

»»»»» op

body

string¦null

false

none

»»»»» arguments

body

array¦null

false

none

»»»»»» anonymous

body

any

false

none

»»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»»»» constraintType

body

string

false

none

»»»»»» op

body

string¦null

false

none

»»»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»»» expressionType

body

string

false

none

»»»»»»» cases

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» table

body

string¦null

false

none

»»»»»»» column

body

string¦null

false

none

»»»»»»» op

body

string¦null

false

none

»»»»»»» arguments

body

array¦null

false

none

»»»»»»»» anonymous

body

any

false

none

»»»»»»» condition

body

any

false

none

»»»»»»» trueValue

body

any

false

none

»»»»»»» falseValue

body

any

false

none

»»»»»»» isDate

body

boolean

false

none

»»»»»»» literalType

body

string

false

none

»»»»»»» value

body

any

false

none

»»»»»» caseSensitive

body

boolean

false

none

»»»»»» constraints

body

array¦null

false

none

»»»»»»» anonymous

body

any

false

none

»»»»»» literalRight

body

any

false

none

»»»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»»»» right

body

any

false

none

»»»»»» expressionLeft

body

any

false

none

»»»»»» expressionRight

body

any

false

none

»»»»»» isPreciseDecimal

body

boolean

false

none

»»»»»» like

body

string¦null

false

none

»»»»»» escapeWildcards

body

boolean

false

none

»»»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»»»»» rowVersion

body

integer(int64)

false

none

»»»»»» table

body

string¦null

false

none

»»»»»» queryDefinitionRight

body

any

false

none

»»»»» trueValue

body

any

false

none

»»»»» falseValue

body

any

false

none

»»»»» isDate

body

boolean

false

none

»»»»» literalType

body

string

false

none

»»»»» value

body

any

false

none

»»»» condition

body

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

DTO version of IConstraint

»»»» trueValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» falseValue

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» isDate

body

boolean

false

none

»»»» literalType

body

string

false

none

»»»» value

body

any

false

none

»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»» namespaceTable

body

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

»»»» m_namespace

body

string¦null

false

none

»»»» name

body

string¦null

false

none

»»» query

body

any

false

none

»»» alias

body

string¦null

false

none

»»» sourceType

body

string

false

none

»» joins

body

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

»»» source

body

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

»»» joinType

body

string

false

none

»»» onClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»»»» constraintType

body

string

false

none

»»»» op

body

string¦null

false

none

»»»» dataFieldLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» caseSensitive

body

boolean

false

none

»»»» constraints

body

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

[DTO version of IConstraint]

»»»» literalRight

body

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

»»»» dataFieldRight

body

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

»»»» right

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» expressionLeft

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» expressionRight

body

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

DTO version of IExpression

»»»» isPreciseDecimal

body

boolean

false

none

»»»» like

body

string¦null

false

none

»»»» escapeWildcards

body

boolean

false

none

»»»» rowVersion

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»»»» table

body

string¦null

false

none

»»»» queryDefinitionRight

body

any

false

none

»» whereClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» order

body

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»»» direction

body

string

false

none

»» group

body

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

»»» table

body

string¦null

false

none

»»» column

body

string¦null

false

none

»» havingClause

body

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

»» distinct

body

boolean

false

none

»» unionWith

body

any

false

none

»» exceptWith

body

any

false

none

» sourceNames

body

object¦null

false

none

»» additionalProperties

body

string¦null

false

none

Enumerated Values

Parameter

Value

»»» dataType

Int

»»» dataType

Decimal

»»» dataType

DateTime

»»» dataType

None

»»» dataType

String

»»» type

SelectAll

»»» type

SelectItem

»»» type

SelectLiteral

»»» type

SelectCustom

»»» type

SelectExpression

»»»» expressionType

caseExpression

»»»» expressionType

dataField

»»»» expressionType

function

»»»» expressionType

ifExpression

»»»» expressionType

literal

»»»»» expressionType

caseExpression

»»»»» expressionType

dataField

»»»»» expressionType

function

»»»»» expressionType

ifExpression

»»»»» expressionType

literal

»»»»»» constraintType

clause

»»»»»» constraintType

constraint

»»»»»» constraintType

expressionConstraint

»»»»»» constraintType

likeConstraint

»»»»»» constraintType

rowVersionConstraint

»»»»»» constraintType

subQueryConstraint

»»»»»»» expressionType

caseExpression

»»»»»»» expressionType

dataField

»»»»»»» expressionType

function

»»»»»»» expressionType

ifExpression

»»»»»»» expressionType

literal

»»»»»»» literalType

Integer

»»»»»»» literalType

Decimal

»»»»»»» literalType

Date

»»»»»»» literalType

DateTime

»»»»»»» literalType

String

»»»»»»» literalType

Float

»»»»»»» literalType

Long

»»»»»»» literalType

Null

»»»»»»» literalType

Parameter

»»»»»»» literalType

Guid

»»»»»»» literalType

SystemUtcTime

»»»»»»» literalType

Boolean

»»»»» literalType

Integer

»»»»» literalType

Decimal

»»»»» literalType

Date

»»»»» literalType

DateTime

»»»»» literalType

String

»»»»» literalType

Float

»»»»» literalType

Long

»»»»» literalType

Null

»»»»» literalType

Parameter

»»»»» literalType

Guid

»»»»» literalType

SystemUtcTime

»»»»» literalType

Boolean

»»»» literalType

Integer

»»»» literalType

Decimal

»»»» literalType

Date

»»»» literalType

DateTime

»»»» literalType

String

»»»» literalType

Float

»»»» literalType

Long

»»»» literalType

Null

»»»» literalType

Parameter

»»»» literalType

Guid

»»»» literalType

SystemUtcTime

»»»» literalType

Boolean

»»» sourceType

Table

»»» sourceType

Query

»»» joinType

Inner

»»» joinType

Left

»»» joinType

Right

»»» joinType

Cross

»»» joinType

CrossApply

»»» joinType

OuterApply

»»»» constraintType

clause

»»»» constraintType

constraint

»»»» constraintType

expressionConstraint

»»»» constraintType

likeConstraint

»»»» constraintType

rowVersionConstraint

»»»» constraintType

subQueryConstraint

»»» direction

Ascending

»»» direction

Descending

»»» direction

AscendingNullsFirst

»»» direction

DescendingNullsLast

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/datastores/viewrestrictions/{datastoreid}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/datastores/viewrestrictions/{datastoreid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "query": {
    "selectItems": [
      {}
    ],
    "source": {
      "namespaceTable": {},
      "query": null,
      "alias": "string",
      "sourceType": "Table"
    },
    "joins": [
      {}
    ],
    "whereClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "order": [
      {}
    ],
    "group": [
      {}
    ],
    "havingClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "distinct": true,
    "unionWith": null,
    "exceptWith": null
  },
  "sourceNames": {
    "property1": "string",
    "property2": "string"
  }
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/datastores/viewrestrictions/{datastoreid}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/datastores/viewrestrictions/{datastoreid}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/datastores/viewrestrictions/{datastoreid}',
  params: {
  }, headers: headers

p JSON.parse(result)

Delete datastore view restrictions.

Parameters

Name

In

Type

Required

Description

datastoreId

path

integer(int32)

true

DataStore Id

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/v1/datastores/viewrestrictions/{datastoreid}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/datastores/viewrestrictions/{datastoreid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/datastores/viewrestrictions/{datastoreid}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/v1/datastores/viewrestrictions/{datastoreid}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/v1/datastores/viewrestrictions/{datastoreid}',
  params: {
  }

p JSON.parse(result)

ExcelTransformControllerV1

ExcelTransformControllerV1_TransformCsvToExcel

Body parameter

[
  {
    "categoryName": "string",
    "categoryRestriction": "string"
  }
]

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Composer.TransferToExcelDTO

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Transforms csv to excel

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.Composer.TransferToExcelDTO]

false

none

none

» categoryName

string¦null

false

none

none

» categoryRestriction

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/csvtoexcel", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/csvtoexcel");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  {
    "categoryName": "string",
    "categoryRestriction": "string"
  }
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/csvtoexcel',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/csvtoexcel', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/csvtoexcel',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "categoryName": "string",
    "categoryRestriction": "string"
  }
]
[{"categoryName":"string","categoryRestriction":"string"}]

ExcelTransformControllerV1_TransformExcelToCsv

Body parameter

{
  "fileName": "string",
  "data64": "string"
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Composer.TransferToCsvDTO

false

none

» fileName

body

string¦null

false

none

» data64

body

string¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Transforms excel to csv

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.Composer.ResponseCsvDTO]

false

none

none

» content

string¦null

false

none

none

» sheetName

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/exceltocsv", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/exceltocsv");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "fileName": "string",
  "data64": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/exceltocsv',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/exceltocsv', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/exceltocsv',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "content": "string",
    "sheetName": "string"
  }
]
[{"content":"string","sheetName":"string"}]

Convert a set of data in the form of headers and rows into a .xlsx file.

Body parameter

{
  "headerRow": [
    "string"
  ],
  "rows": [
    "string"
  ],
  "columnTypes": [
    "Number"
  ]
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.ExportToExcelDTO

false

The data to be converted formatted as an ExportToExcelDTO.

» headerRow

body

[string]¦null

false

none

» rows

body

[string]¦null

false

none

» columnTypes

body

[string]¦null

false

none

Enumerated Values

Parameter

Value

» columnTypes

Number

» columnTypes

String

» columnTypes

Date

Responses

Status

Meaning

Description

Schema

200

OK

Exports data rows to xlsx format.

string

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/rowstoexcel", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/rowstoexcel");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "headerRow": [
    "string"
  ],
  "rows": [
    "string"
  ],
  "columnTypes": [
    "Number"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/rowstoexcel',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/rowstoexcel', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/rowstoexcel',
  params: {
  }, headers: headers

p JSON.parse(result)

Convert a set of data in the form of headers and rows into a .xlsx file formatted for a PA chart.

Body parameter

{
  "headerRow": [
    "string"
  ],
  "rows": [
    "string"
  ],
  "columnTypes": [
    "Number"
  ]
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.ExportToExcelDTO

false

The data to be converted formatted as an ExportToExcelDTO.

» headerRow

body

[string]¦null

false

none

» rows

body

[string]¦null

false

none

» columnTypes

body

[string]¦null

false

none

Enumerated Values

Parameter

Value

» columnTypes

Number

» columnTypes

String

» columnTypes

Date

Responses

Status

Meaning

Description

Schema

200

OK

Exports data rows to xlsx format for PA charts.

string

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/rpc/rowstoexcelforchart", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/rowstoexcelforchart");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "headerRow": [
    "string"
  ],
  "rows": [
    "string"
  ],
  "columnTypes": [
    "Number"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/rowstoexcelforchart',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/rpc/rowstoexcelforchart', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/rpc/rowstoexcelforchart',
  params: {
  }, headers: headers

p JSON.parse(result)

ExtToolLogControllerV1

Get IDs and Dates for all recent external tool runs.

Parameters

Name

In

Type

Required

Description

offset

query

integer(int32)

false

none

limit

query

integer(int32)

false

none

fields

query

string

false

none

unique

query

boolean

false

none

filter

query

string

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Get most recent external tool runs.

Varicent.RESTAPI.v1.DTOs.ResultSetDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/exttoollog", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/exttoollog");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/exttoollog',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/exttoollog', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/exttoollog',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "columnDefinitions": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "data": [
    null
  ],
  "columnSourceMap": {
    "property1": "string",
    "property2": "string"
  },
  "isDataSynced": true,
  "hierarchyMetadata": {
    "tableName": "string",
    "idColumnName": "string",
    "parentColumnName": "string"
  }
}
{"columnDefinitions":[{"name":"string","type":"String","isKey":true,"nullable":true,"values":"string","lockedPeriod":{},"referencedCol":"string","picklistFilter":"string","displayName":"string","isELTPeriod":true}],"data":[null],"columnSourceMap":{"property1":"string","property2":"string"},"isDataSynced":true,"hierarchyMetadata":{"tableName":"string","idColumnName":"string","parentColumnName":"string"}}

Get all console lines for a specific run.

Parameters

Name

In

Type

Required

Description

runID

path

string

true

Run ID

Responses

Status

Meaning

Description

Schema

200

OK

Get all console lines for run

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/exttoollog/{runID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/exttoollog/{runID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/exttoollog/{runID}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/exttoollog/{runID}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/exttoollog/{runID}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "property1": "string",
  "property2": "string"
}
{"property1":"string","property2":"string"}

Get all console lines with chunkID > lastChunkID for a specific run.

Parameters

Name

In

Type

Required

Description

runID

path

string

true

Run ID

lastChunkID

path

string

true

Chunk ID of the last chunk previously fetched

Responses

Status

Meaning

Description

Schema

200

OK

Get new console lines for run

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/exttoollog/{runID}/{lastChunkID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/exttoollog/{runID}/{lastChunkID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/exttoollog/{runID}/{lastChunkID}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/exttoollog/{runID}/{lastChunkID}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/exttoollog/{runID}/{lastChunkID}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  "string"
]
["string"]

Get extID of current runID, smallest and largest runID

Parameters

Name

In

Type

Required

Description

runID

path

string

true

Run ID

Responses

Status

Meaning

Description

Schema

200

OK

Get information for run

Inline

Response Schema

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/exttoolloginfo/{runID}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/exttoolloginfo/{runID}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/exttoolloginfo/{runID}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/exttoolloginfo/{runID}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/exttoolloginfo/{runID}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  "string"
]
["string"]

MailControllerV1

Send Email

Body parameter

{
  "subject": "string",
  "to": [
    "string"
  ],
  "useHtml": true,
  "body": "string",
  "cc": [
    "string"
  ],
  "bcc": [
    "string"
  ],
  "attachments": [
    {
      "fileName": "string",
      "content": "string"
    }
  ]
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Mail.MailDTO

false

none

» subject

body

string¦null

false

none

» to

body

[string]¦null

false

none

» useHtml

body

boolean

false

none

» body

body

string¦null

false

none

» cc

body

[string]¦null

false

none

» bcc

body

[string]¦null

false

none

» attachments

body

[RESTAPI.v1.DTOs.Mail.EmailAttachmentDTO]¦null

false

none

»» fileName

body

string¦null

false

none

»» content

body

string¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Send an email

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/payee/tsapi/sendMail", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payee/tsapi/sendMail");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "subject": "string",
  "to": [
    "string"
  ],
  "useHtml": true,
  "body": "string",
  "cc": [
    "string"
  ],
  "bcc": [
    "string"
  ],
  "attachments": [
    {
      "fileName": "string",
      "content": "string"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/payee/tsapi/sendMail',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/payee/tsapi/sendMail', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/payee/tsapi/sendMail',
  params: {
  }, headers: headers

p JSON.parse(result)

MailControllerV1_SendMailAdmin

Body parameter

{
  "subject": "string",
  "to": [
    "string"
  ],
  "useHtml": true,
  "body": "string",
  "cc": [
    "string"
  ],
  "bcc": [
    "string"
  ],
  "attachments": [
    {
      "fileName": "string",
      "content": "string"
    }
  ]
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Mail.MailDTO

false

none

» subject

body

string¦null

false

none

» to

body

[string]¦null

false

none

» useHtml

body

boolean

false

none

» body

body

string¦null

false

none

» cc

body

[string]¦null

false

none

» bcc

body

[string]¦null

false

none

» attachments

body

[RESTAPI.v1.DTOs.Mail.EmailAttachmentDTO]¦null

false

none

»» fileName

body

string¦null

false

none

»» content

body

string¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Send an email

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/admin/tsapi/sendMail", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/admin/tsapi/sendMail");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "subject": "string",
  "to": [
    "string"
  ],
  "useHtml": true,
  "body": "string",
  "cc": [
    "string"
  ],
  "bcc": [
    "string"
  ],
  "attachments": [
    {
      "fileName": "string",
      "content": "string"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/admin/tsapi/sendMail',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/admin/tsapi/sendMail', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/admin/tsapi/sendMail',
  params: {
  }, headers: headers

p JSON.parse(result)

MigrationsControllerV1

Get the list of workflows for migration.

Parameters

Name

In

Type

Required

Description

orderBy

query

string

false

####Description

Detailed descriptions

orderBy: ####Description

OrderBy provides sorting by column (multiple columns supported, comma delimited).

####Syntax

Direction: + (ascending), - (descending)

Column: name

####Example

orderBy=-date

####Supported Fields

name

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowDTO]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

» description

string¦null

false

none

none

» isSingleInstance

boolean

false

none

none

» workflowState

string

false

none

none

» conditionalVars

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowConditionVariableDTO]¦null

false

none

none

»» expressionName

string¦null

false

none

none

»» name

string¦null

false

none

none

»» variableType

string

false

none

none

» columnCount

integer(int32)

false

none

none

» workflowConfig

RESTAPI.v1.DTOs.BPMWorkflowConfigDTO

false

none

none

»» pendingWorkflowEnabled

boolean

false

none

none

» runCount

integer(int32)

false

none

none

» runDate

string¦null

false

none

none

» runBy

string¦null

false

none

none

» lastActioned

string¦null

false

none

none

» workflowType

string

false

none

none

» webReport

Varicent.RESTAPI.v1.DTOs.BPMWorkflowWebReportDTO

false

none

none

»» parameters

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowParameterDTO]¦null

false

none

none

»»» paramName

string¦null

false

none

none

»»» value

string¦null

false

none

none

»»» paramType

string

false

none

none

»»» valueType

string

false

none

none

»»» usesReportValue

boolean

false

none

none

»»» isRequired

boolean

false

none

none

»» layoutAssignment

object¦null

false

none

none

»»» additionalProperties

[RESTAPI.v1.DTOs.PairDTO2[System.Boolean,System.Boolean]](#schemarestapi.v1.dtos.pairdto2[system.boolean,system.boolean])

false

none

none

»»»» first

boolean

false

none

none

»»»» second

boolean

false

none

none

»» webReportID

integer(int32)

false

none

none

» inquiry

Varicent.RESTAPI.v1.DTOs.BPMWorkflowInquiryDTO

false

none

none

»» hasRun

boolean

false

none

none

»» components

[RESTAPI.v1.DTOs.BPM.BPMComponentDTO]¦null

false

none

none

»»» workflowID

integer(int32)

false

none

none

»»» componentID

integer(int32)

false

none

none

»»» name

string¦null

false

none

none

»»» type

string

false

none

none

»»» order

integer(int32)

false

none

none

»»» categories

[RESTAPI.v1.DTOs.BPMInquiryCategoryDTO]¦null

false

none

none

»»»» categoryID

integer(int32)

false

none

none

»»»» value

string¦null

false

none

none

»»» source

RESTAPI.v1.DTOs.BPM.BPMComponentSourceDTO

false

none

none

»»»» sourceID

integer(int32)¦null

false

none

none

»»»» sourceReference

RESTAPI.v1.DTOs.BPM.BPMComponentSourceReferenceDTO

false

none

none

»»»»» tableName

string¦null

false

none

none

»»»»» calculationID

integer(int32)¦null

false

none

none

»»»»» dataStoreID

integer(int32)¦null

false

none

none

»»»»» planBuilderCalculationID

string¦null

false

none

none

»»»» sourceFilters

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFiltersDTO

false

none

none

»»»»» filters

[RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterDTO]¦null

false

none

none

»»»»»» constraint

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterConstraintDTO

false

none

none

»»»»»»» columnName

string¦null

false

none

none

»»»»»»» operator

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterOperatorDTO

false

none

none

»»»»»»»» type

string

false

none

none

»»»»»»» value

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterValueDTO

false

none

none

»»»»»»»» text

string¦null

false

none

none

»»»»»»»» numeric

number(double)¦null

false

none

none

»»»»»»»» date

string(date-time)¦null

false

none

none

»»»»»»»» special

string¦null

false

none

none

»»»»»»»» valueId

integer(int32)¦null

false

none

none

»»»»»»»» rangeValue

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexRangeValueDTO

false

none

none

»»»»»»»»» min

any

false

none

none

»»»»»»»»» max

any

false

none

none

»»»»»»» caseSensitive

boolean¦null

false

none

none

»»»»»» and

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterAndDTO

false

none

none

»»»»»»» filters

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»» or

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterOrDTO

false

none

none

»»»»»»» filters

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»» not

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterNotDTO

false

none

none

»»»»»»» filter

any

false

none

none

»»»»»» metadata

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterMetaDataDTO

false

none

none

»»»»»»» additionalProperties

any

false

none

none

»»»» columns

[RESTAPI.v1.DTOs.BPM.BPMComponentSourceColumnDTO]¦null

false

none

none

»»»»» columnName

string¦null

false

none

none

»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»» rowVersion

integer(int64)

false

none

none

»»» config

RESTAPI.v1.DTOs.BPM.BPMComponentConfigDTO

false

none

none

»»»» pickList

RESTAPI.v1.DTOs.BPM.BPMComponentPickListDTO

false

none

none

»»»»» additionalProperties

any

false

none

none

»»»»» placeholder

string¦null

false

none

none

»»»»» sort

string¦null

false

none

none

»»»»» parameterName

string¦null

false

none

none

»»»»» userGenerated

boolean

false

none

none

»»»»» hasError

boolean

false

none

none

»»»»» required

boolean

false

none

none

»»»»» enabled

boolean

false

none

none

»»»»» visible

boolean

false

none

none

»»»»» defaultValue

string¦null

false

none

none

»»»» title

RESTAPI.v1.DTOs.BPM.BPMComponentTitleDTO

false

none

none

»»»»» additionalProperties

any

false

none

none

»»»»» content

string¦null

false

none

none

»»»»» userGenerated

boolean

false

none

none

»»»»» hasError

boolean

false

none

none

»»»»» required

boolean

false

none

none

»»»»» enabled

boolean

false

none

none

»»»»» visible

boolean

false

none

none

»»»»» defaultValue

string¦null

false

none

none

»»»» subject

RESTAPI.v1.DTOs.BPM.BPMComponentSubjectDTO

false

none

none

»»»»» additionalProperties

any

false

none

none

»»»»» placeholder

string¦null

false

none

none

»»»»» parameterName

string¦null

false

none

none

»»»»» userGenerated

boolean

false

none

none

»»»»» hasError

boolean

false

none

none

»»»»» required

boolean

false

none

none

»»»»» enabled

boolean

false

none

none

»»»»» visible

boolean

false

none

none

»»»»» defaultValue

string¦null

false

none

none

»»»» description

RESTAPI.v1.DTOs.BPM.BPMComponentDescriptionDTO

false

none

none

»»»»» additionalProperties

any

false

none

none

»»»»» placeholder

string¦null

false

none

none

»»»»» parameterName

string¦null

false

none

none

»»»»» charLimit

integer(int32)

false

none

none

»»»»» userGenerated

boolean

false

none

none

»»»»» hasError

boolean

false

none

none

»»»»» required

boolean

false

none

none

»»»»» enabled

boolean

false

none

none

»»»»» visible

boolean

false

none

none

»»»»» defaultValue

string¦null

false

none

none

»»»» text

RESTAPI.v1.DTOs.BPM.BPMComponentTextDTO

false

none

none

»»»»» additionalProperties

any

false

none

none

»»»»» placeholder

string¦null

false

none

none

»»»»» charLimit

integer(int32)

false

none

none

»»»»» content

string¦null

false

none

none

»»»»» parameterName

string¦null

false

none

none

»»»»» userGenerated

boolean

false

none

none

»»»»» hasError

boolean

false

none

none

»»»»» required

boolean

false

none

none

»»»»» templateList

[RESTAPI.v1.DTOs.BPM.CommentTemplateDTO]¦null

false

none

none

»»»»»» value

string¦null

false

none

none

»»»»» enabled

boolean

false

none

none

»»»»» visible

boolean

false

none

none

»»»»» defaultValue

string¦null

false

none

none

»»»» numeric

RESTAPI.v1.DTOs.BPM.BPMComponentNumericDTO

false

none

none

»»»»» additionalProperties

any

false

none

none

»»»»» placeholder

string¦null

false

none

none

»»»»» charLimit

integer(int32)

false

none

none

»»»»» content

string¦null

false

none

none

»»»»» parameterName

string¦null

false

none

none

»»»»» userGenerated

boolean

false

none

none

»»»»» hasError

boolean

false

none

none

»»»»» required

boolean

false

none

none

»»»»» enabled

boolean

false

none

none

»»»»» visible

boolean

false

none

none

»»»»» defaultValue

integer(int32)

false

none

none

»»»» sourcePickList

RESTAPI.v1.DTOs.BPM.BPMComponentSourcePickListDTO

false

none

none

»»»»» additionalProperties

any

false

none

none

»»»»» displayName

string¦null

false

none

none

»»»»» displayColumn

string¦null

false

none

none

»»»»» displayColumnDBType

string

false

none

none

»»»»» idColumn

string¦null

false

none

none

»»»»» idColumnDBType

string

false

none

none

»»»»» placeholder

string¦null

false

none

none

»»»»» sort

string¦null

false

none

none

»»»»» sortOrder

string

false

none

none

»»»»» parameterName

string¦null

false

none

none

»»»»» hasError

boolean

false

none

none

»»»»» required

boolean

false

none

none

»»»»» userGenerated

boolean

false

none

none

»»»»» hideIDColumn

boolean¦null

false

none

none

»»»»» enabled

boolean

false

none

none

»»»»» visible

boolean

false

none

none

»»»»» defaultValue

string¦null

false

none

none

»»» componentMappings

[RESTAPI.v1.DTOs.BPM.BPMAutoAdjustComponentMappingDTO]¦null

false

none

none

»»»» nodeID

integer(int32)

false

none

none

»»»» nodeName

string¦null

false

none

none

»»»» tableName

string¦null

false

none

none

»»»» columnName

string¦null

false

none

none

»»»» dataType

string¦null

false

none

none

»»»» isPrimaryKey

boolean

false

none

none

»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

» bpmWorkflowPresenterFlexReportDTO

Varicent.RESTAPI.v1.DTOs.BPMWorkflowPresenterFlexReportDTO

false

none

none

»» reportId

integer(int32)

false

none

none

»» parameters

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowParameterDTO]¦null

false

none

none

»» objectRestrictions

object¦null

false

none

none

»»» additionalProperties

RESTAPI.v1.DTOs.BPM.BPMVisibilityEditabilityDTO

false

none

none

»»»» visible

boolean

false

none

none

»»»» editable

boolean

false

none

none

» bpmWorkflowPlanDocPresenterFlexReportDTO

Varicent.RESTAPI.v1.DTOs.BPMWorkflowPlanDocPresenterFlexReportDTO

false

none

none

»» reportId

integer(int32)

false

none

none

»» parameters

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowParameterDTO]¦null

false

none

none

»» templateType

string

false

none

none

» assignedReports

[string]¦null

false

none

none

» numReportsAssigned

integer(int32)

false

none

none

» permissions

Varicent.RESTAPI.v1.DTOs.WorkflowPermissionsDTO

false

none

none

»» advanceToken

[string]¦null

false

none

none

»» viewDocuments

[string]¦null

false

none

none

» parentFolder

Varicent.RESTAPI.v1.DTOs.BPMFolderDTO

false

none

none

»» folderID

integer(int32)

false

none

none

»» folderName

string¦null

false

none

none

»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» workflowType

string¦null

false

none

none

» parameters

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowParameterDTO]¦null

false

none

none

» layoutAssignment

object¦null

false

none

none

»» additionalProperties

[RESTAPI.v1.DTOs.PairDTO2[System.Boolean,System.Boolean]](#schemarestapi.v1.dtos.pairdto2[system.boolean,system.boolean])

false

none

none

» webReportID

integer(int32)

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

workflowState

Stopped

workflowState

Started

workflowState

Stopping

workflowState

Starting

workflowState

Archived

workflowState

Draft

variableType

Text

variableType

Date

variableType

Numeric

workflowType

PresenterReport

workflowType

Inquiry

workflowType

PlanApproval

workflowType

PresenterFlexReport

workflowType

PlanDocument

paramType

Text

paramType

Date

paramType

Numeric

valueType

Constant

valueType

Value

type

pickList

type

title

type

subject

type

description

type

text

type

numeric

type

sourcePickList

type

Equals

type

NotEquals

type

LessThan

type

LessThanEquals

type

GreaterThan

type

GreaterThanEquals

type

IsNull

type

IsNotNull

type

Contains

type

NotContains

type

StartWith

type

EndWith

type

InRange

type

InArray

type

NotInArray

special

CurrentWebUser

special

CurrentDate

special

CurrentRowValue

special

WorkflowFormID

displayColumnDBType

String

displayColumnDBType

LongString

displayColumnDBType

MaxString

displayColumnDBType

Date

displayColumnDBType

DateTime

displayColumnDBType

Decimal

displayColumnDBType

Int

displayColumnDBType

Long

displayColumnDBType

Float

displayColumnDBType

BLOB

displayColumnDBType

Identity

displayColumnDBType

CLOB

displayColumnDBType

RowVersion

displayColumnDBType

UID

displayColumnDBType

VarCharMax

displayColumnDBType

Boolean

idColumnDBType

String

idColumnDBType

LongString

idColumnDBType

MaxString

idColumnDBType

Date

idColumnDBType

DateTime

idColumnDBType

Decimal

idColumnDBType

Int

idColumnDBType

Long

idColumnDBType

Float

idColumnDBType

BLOB

idColumnDBType

Identity

idColumnDBType

CLOB

idColumnDBType

RowVersion

idColumnDBType

UID

idColumnDBType

VarCharMax

idColumnDBType

Boolean

sortOrder

Ascending

sortOrder

Descending

sortOrder

AscendingNullsFirst

sortOrder

DescendingNullsLast

templateType

Payee

templateType

ManagerPayee

templateType

Custom

workflowType

PresenterReport

workflowType

Inquiry

workflowType

PlanApproval

workflowType

PresenterFlexReport

workflowType

PlanDocument

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/rpc/migration/workflows", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/migration/workflows");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/migration/workflows',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/rpc/migration/workflows', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/rpc/migration/workflows',
  params: {
  }, headers: headers

p JSON.parse(result)

Get the list of plan documents for migration.

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentDTO]

false

none

none

» planDocumentId

integer(int32)¦null

false

none

none

» name

string¦null

false

none

none

» workflowId

integer(int32)

false

none

none

» metadata

RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentMetadataDTO

false

none

none

»» additionalProperties

any

false

none

none

» distributionStatus

string

false

none

none

» agreementVisited

boolean

false

none

none

» workflowVisited

boolean

false

none

none

» payeeCount

integer(int32)

false

none

none

» payeeStatusCount

object¦null

false

none

none

»» additionalProperties

integer(int32)¦null

false

none

none

» reportId

integer(int32)

false

none

none

» isWorkflowRunning

boolean

false

none

none

» description

string¦null

false

none

none

» workflowState

string

false

none

none

» errors

object¦null

false

none

none

»» NoError

string

false

none

none

»» CannotBeEmpty

string

false

none

none

»» LessThan100Char

string

false

none

none

»» NoTrailingSpaces

string

false

none

none

»» NameAlreadyExists

string

false

none

none

»» PresenterAdaptiveSpecificError

string

false

none

none

» hasAdminSwimlane

boolean

false

none

none

» adminActionsCount

integer(int32)

false

none

none

» nodeErrorsCount

integer(int32)

false

none

none

» showDuplicateCallout

boolean

false

none

none

» pdfGenerationFails

integer(int32)

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

Enumerated Values

Property

Value

distributionStatus

Draft

distributionStatus

Ready

distributionStatus

DistributionInProgress

distributionStatus

Distributed

workflowState

NotStarted

workflowState

InProgress

workflowState

Ended

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/rpc/migration/plandocuments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/rpc/migration/plandocuments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/rpc/migration/plandocuments',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/rpc/migration/plandocuments', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/rpc/migration/plandocuments',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "planDocumentId": 0,
    "name": "string",
    "workflowId": 0,
    "metadata": {
      "property1": null,
      "property2": null
    },
    "distributionStatus": "Draft",
    "agreementVisited": true,
    "workflowVisited": true,
    "payeeCount": 0,
    "payeeStatusCount": {
      "property1": 0,
      "property2": 0
    },
    "reportId": 0,
    "isWorkflowRunning": true,
    "description": "string",
    "workflowState": "NotStarted",
    "errors": {
      "NoError": "string",
      "CannotBeEmpty": "string",
      "LessThan100Char": "string",
      "NoTrailingSpaces": "string",
      "NameAlreadyExists": "string",
      "PresenterAdaptiveSpecificError": "string"
    },
    "hasAdminSwimlane": true,
    "adminActionsCount": 0,
    "nodeErrorsCount": 0,
    "showDuplicateCallout": true,
    "pdfGenerationFails": 0,
    "version": {
      "rowVersion": 0
    }
  }
]
[{"planDocumentId":0,"name":"string","workflowId":0,"metadata":{"property1":null,"property2":null},"distributionStatus":"Draft","agreementVisited":true,"workflowVisited":true,"payeeCount":0,"payeeStatusCount":{"property1":0,"property2":0},"reportId":0,"isWorkflowRunning":true,"description":"string","workflowState":"NotStarted","errors":{"NoError":"string","CannotBeEmpty":"string","LessThan100Char":"string","NoTrailingSpaces":"string","NameAlreadyExists":"string","PresenterAdaptiveSpecificError":"string"},"hasAdminSwimlane":true,"adminActionsCount":0,"nodeErrorsCount":0,"showDuplicateCallout":true,"pdfGenerationFails":0,"version":{"rowVersion":0}}]

ModelControllerV1

Get the the production status for each model

Responses

Status

Meaning

Description

Schema

200

OK

Return production status of models accessible by admin

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

[string]

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/productionmodels", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/productionmodels");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/productionmodels',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/productionmodels', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/productionmodels',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "property1": [
    "string"
  ],
  "property2": [
    "string"
  ]
}
{"property1":["string"],"property2":["string"]}

PlanApproval

Get all the plan approval template.

Parameters

Name

In

Type

Required

Description

limit

query

integer(int32)

false

none

offset

query

integer(int32)

false

none

orderBy

query

string

false

none

orderDirection

query

string

false

none

filterBy

query

string

false

none

Enumerated Values

Parameter

Value

orderDirection

Ascending

orderDirection

Descending

orderDirection

AscendingNullsFirst

orderDirection

DescendingNullsLast

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.Plans.PlanApprovalFetchTemplatesDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/internal/plan-approvals", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plan-approvals");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plan-approvals',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/internal/plan-approvals', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/internal/plan-approvals',
  params: {
  }, headers: headers

p JSON.parse(result)

Insert a plan approval template.

Body parameter

{
  "planApprovalTemplateId": 0,
  "name": "string",
  "reportId": 0,
  "workflowId": 0,
  "workflowType": "Payee",
  "recipientCount": 0,
  "metadataPlanApproval": {
    "property1": null,
    "property2": null
  },
  "metadataPresenterFlex": {
    "property1": null,
    "property2": null
  },
  "type": "Default",
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Plans.PlanApprovalReportDTO

false

none

» planApprovalTemplateId

body

integer(int32)¦null

false

none

» name

body

string¦null

false

none

» reportId

body

integer(int32)

false

none

» workflowId

body

integer(int32)¦null

false

none

» workflowType

body

string

false

none

» recipientCount

body

integer(int32)

false

none

» metadataPlanApproval

body

RESTAPI.v1.DTOs.Plans.PlanApprovalMetadataDTO

false

none

»» additionalProperties

body

any

false

none

» metadataPresenterFlex

body

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexReportMetadataDTO

false

none

»» additionalProperties

body

any

false

none

» type

body

string¦null

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Enumerated Values

Parameter

Value

» workflowType

Payee

» workflowType

ManagerPayee

» type

Default

» type

StandardReport

» type

PlanApproval

» type

PlanDocument

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.Plans.PlanApprovalTemplateDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/internal/plan-approvals", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plan-approvals");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "planApprovalTemplateId": 0,
  "name": "string",
  "reportId": 0,
  "workflowId": 0,
  "workflowType": "Payee",
  "recipientCount": 0,
  "metadataPlanApproval": {
    "property1": null,
    "property2": null
  },
  "metadataPresenterFlex": {
    "property1": null,
    "property2": null
  },
  "type": "Default",
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plan-approvals',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/internal/plan-approvals', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/internal/plan-approvals',
  params: {
  }, headers: headers

p JSON.parse(result)

Get a plan approval template.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.Plans.PlanApprovalTemplateDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/internal/plan-approvals/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plan-approvals/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plan-approvals/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/internal/plan-approvals/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/internal/plan-approvals/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "planApprovalTemplateId": 0,
  "name": "string",
  "reportId": 0,
  "workflowId": 0,
  "workflowType": "Payee",
  "recipientCount": 0,
  "recipientStatusCount": {
    "Selected": 0,
    "PreManagerApproval": 0,
    "PayeeSign": 0,
    "Complete": 0
  },
  "metadata": {
    "property1": null,
    "property2": null
  },
  "distributionStatus": "Draft",
  "version": {
    "rowVersion": 0
  },
  "migratedPlanDocumentId": 0
}
{"planApprovalTemplateId":0,"name":"string","reportId":0,"workflowId":0,"workflowType":"Payee","recipientCount":0,"recipientStatusCount":{"Selected":0,"PreManagerApproval":0,"PayeeSign":0,"Complete":0},"metadata":{"property1":null,"property2":null},"distributionStatus":"Draft","version":{"rowVersion":0},"migratedPlanDocumentId":0}

Update the plan approval template.

Body parameter

{
  "planApprovalTemplateId": 0,
  "name": "string",
  "reportId": 0,
  "workflowId": 0,
  "workflowType": "Payee",
  "recipientCount": 0,
  "recipientStatusCount": {
    "Selected": 0,
    "PreManagerApproval": 0,
    "PayeeSign": 0,
    "Complete": 0
  },
  "metadata": {
    "property1": null,
    "property2": null
  },
  "distributionStatus": "Draft",
  "version": {
    "rowVersion": 0
  },
  "migratedPlanDocumentId": 0
}

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

RESTAPI.v1.DTOs.Plans.PlanApprovalTemplateDTO

false

none

» planApprovalTemplateId

body

integer(int32)¦null

false

none

» name

body

string¦null

false

none

» reportId

body

integer(int32)

false

none

» workflowId

body

integer(int32)¦null

false

none

» workflowType

body

string

false

none

» recipientCount

body

integer(int32)

false

none

» recipientStatusCount

body

object¦null

false

none

»» Selected

body

integer(int32)

false

none

»» PreManagerApproval

body

integer(int32)

false

none

»» PayeeSign

body

integer(int32)

false

none

»» Complete

body

integer(int32)

false

none

» metadata

body

RESTAPI.v1.DTOs.Plans.PlanApprovalMetadataDTO

false

none

»» additionalProperties

body

any

false

none

» distributionStatus

body

string

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

» migratedPlanDocumentId

body

integer(int32)¦null

false

none

Enumerated Values

Parameter

Value

» workflowType

Payee

» workflowType

ManagerPayee

» distributionStatus

Draft

» distributionStatus

Ready

» distributionStatus

DistributionInProgress

» distributionStatus

Distributed

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.Plans.PlanApprovalTemplateDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/internal/plan-approvals/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plan-approvals/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "planApprovalTemplateId": 0,
  "name": "string",
  "reportId": 0,
  "workflowId": 0,
  "workflowType": "Payee",
  "recipientCount": 0,
  "recipientStatusCount": {
    "Selected": 0,
    "PreManagerApproval": 0,
    "PayeeSign": 0,
    "Complete": 0
  },
  "metadata": {
    "property1": null,
    "property2": null
  },
  "distributionStatus": "Draft",
  "version": {
    "rowVersion": 0
  },
  "migratedPlanDocumentId": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plan-approvals/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/internal/plan-approvals/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/internal/plan-approvals/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

Delete the plan approval template.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/internal/plan-approvals/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plan-approvals/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/internal/plan-approvals/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/internal/plan-approvals/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/internal/plan-approvals/{id}',
  params: {
  }

p JSON.parse(result)

Refresh the plan approval template distribution status

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

The plan approval template ID

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.Plans.PlanApprovalTemplateDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/internal/plan-approvals/{id}/refresh", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plan-approvals/{id}/refresh");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plan-approvals/{id}/refresh',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/internal/plan-approvals/{id}/refresh', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/internal/plan-approvals/{id}/refresh',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "planApprovalTemplateId": 0,
  "name": "string",
  "reportId": 0,
  "workflowId": 0,
  "workflowType": "Payee",
  "recipientCount": 0,
  "recipientStatusCount": {
    "Selected": 0,
    "PreManagerApproval": 0,
    "PayeeSign": 0,
    "Complete": 0
  },
  "metadata": {
    "property1": null,
    "property2": null
  },
  "distributionStatus": "Draft",
  "version": {
    "rowVersion": 0
  },
  "migratedPlanDocumentId": 0
}
{"planApprovalTemplateId":0,"name":"string","reportId":0,"workflowId":0,"workflowType":"Payee","recipientCount":0,"recipientStatusCount":{"Selected":0,"PreManagerApproval":0,"PayeeSign":0,"Complete":0},"metadata":{"property1":null,"property2":null},"distributionStatus":"Draft","version":{"rowVersion":0},"migratedPlanDocumentId":0}

Get the plan approval document for the given template payee.

Parameters

Name

In

Type

Required

Description

templateId

path

integer(int32)

true

none

payeeId

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.Plans.PlanApprovalDocumentDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee/{payeeId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee/{payeeId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee/{payeeId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee/{payeeId}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee/{payeeId}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "planApprovalTemplateId": 0,
  "payeeDetails": {
    "title": "string",
    "reportsToPayee": null,
    "payeeProfilePicture": "string",
    "groupIds": [
      0
    ],
    "groupNames": [
      "string"
    ],
    "name": "string",
    "id": "string"
  },
  "tokenId": 0,
  "status": "Selected",
  "createdAt": "2019-08-24T14:15:22Z",
  "lastModified": "2019-08-24T14:15:22Z",
  "signatureInfos": [
    {
      "signerId": "string",
      "signerName": "string",
      "signAt": "2019-08-24T14:15:22Z"
    }
  ],
  "documentDistributionStatus": "NotProcessed",
  "distributionLiveActivityId": 0,
  "version": {
    "rowVersion": 0
  },
  "migratedPlanDocumentId": 0
}
{"planApprovalTemplateId":0,"payeeDetails":{"title":"string","reportsToPayee":null,"payeeProfilePicture":"string","groupIds":[0],"groupNames":["string"],"name":"string","id":"string"},"tokenId":0,"status":"Selected","createdAt":"2019-08-24T14:15:22Z","lastModified":"2019-08-24T14:15:22Z","signatureInfos":[{"signerId":"string","signerName":"string","signAt":"2019-08-24T14:15:22Z"}],"documentDistributionStatus":"NotProcessed","distributionLiveActivityId":0,"version":{"rowVersion":0},"migratedPlanDocumentId":0}

Sign the plan approval document for the given template payee

Parameters

Name

In

Type

Required

Description

templateId

path

integer(int32)

true

none

payeeId

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

string

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee/{payeeId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee/{payeeId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee/{payeeId}',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee/{payeeId}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee/{payeeId}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
"string"
"string"

Get all the distributions of a plan approval template.

Parameters

Name

In

Type

Required

Description

templateId

path

integer(int32)

true

none

limit

query

integer(int32)

false

none

offset

query

integer(int32)

false

none

orderBy

query

string

false

none

orderDirection

query

string

false

none

filterBy

query

string

false

none

includeProfilePictures

query

boolean

false

none

addSignatureInfo

query

boolean

false

none

Enumerated Values

Parameter

Value

orderDirection

Ascending

orderDirection

Descending

orderDirection

AscendingNullsFirst

orderDirection

DescendingNullsLast

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.Plans.PlanApprovalDocumentDTO]

false

none

none

» planApprovalTemplateId

integer(int32)

false

none

none

» payeeDetails

Varicent.RESTAPI.v1.DTOs.PayeeIndepthDetailsDTO

false

none

none

»» title

string¦null

false

none

none

»» reportsToPayee

any

false

none

none

»» payeeProfilePicture

string(byte)¦null

false

none

none

»» groupIds

[integer]¦null

false

none

none

»» groupNames

[string]¦null

false

none

none

»» name

string¦null

false

none

none

»» id

string¦null

false

none

none

» tokenId

integer(int32)¦null

false

none

none

» status

string

false

none

none

» createdAt

string(date-time)¦null

false

none

none

» lastModified

string(date-time)¦null

false

none

none

» signatureInfos

[RESTAPI.v1.DTOs.Plans.PlanApprovalSignatureInfoDTO]¦null

false

none

none

»» signerId

string¦null

false

none

none

»» signerName

string¦null

false

none

none

»» signAt

string(date-time)

false

none

none

» documentDistributionStatus

string

false

none

none

» distributionLiveActivityId

integer(int32)¦null

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

» migratedPlanDocumentId

integer(int32)¦null

false

none

none

Enumerated Values

Property

Value

status

Selected

status

PreManagerApproval

status

PayeeSign

status

Complete

documentDistributionStatus

NotProcessed

documentDistributionStatus

Sending

documentDistributionStatus

Sent

documentDistributionStatus

Failed

documentDistributionStatus

RestartFailed

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/internal/plan-approvals/{templateId}/document", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plan-approvals/{templateId}/document");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plan-approvals/{templateId}/document',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/internal/plan-approvals/{templateId}/document', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/internal/plan-approvals/{templateId}/document',
  params: {
  }, headers: headers

p JSON.parse(result)

Distribute the plan approval document for the given template payees.

Body parameter

[
  "string"
]

Parameters

Name

In

Type

Required

Description

templateId

path

integer(int32)

true

none

body

body

array[string]

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.Plans.PlanApprovalDistributeTemplateDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/internal/plan-approvals/{templateId}/document", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plan-approvals/{templateId}/document");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  "string"
]';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plan-approvals/{templateId}/document',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/internal/plan-approvals/{templateId}/document', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/internal/plan-approvals/{templateId}/document',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "completedactivities": "string",
  "liveactivities": "string",
  "planTemplate": {
    "planApprovalTemplateId": 0,
    "name": "string",
    "reportId": 0,
    "workflowId": 0,
    "workflowType": "Payee",
    "recipientCount": 0,
    "recipientStatusCount": {
      "Selected": 0,
      "PreManagerApproval": 0,
      "PayeeSign": 0,
      "Complete": 0
    },
    "metadata": {
      "property1": null,
      "property2": null
    },
    "distributionStatus": "Draft",
    "version": {
      "rowVersion": 0
    },
    "migratedPlanDocumentId": 0
  }
}
{"completedactivities":"string","liveactivities":"string","planTemplate":{"planApprovalTemplateId":0,"name":"string","reportId":0,"workflowId":0,"workflowType":"Payee","recipientCount":0,"recipientStatusCount":{"Selected":0,"PreManagerApproval":0,"PayeeSign":0,"Complete":0},"metadata":{"property1":null,"property2":null},"distributionStatus":"Draft","version":{"rowVersion":0},"migratedPlanDocumentId":0}}

Get all the payees for selection for plan approval template.

Parameters

Name

In

Type

Required

Description

templateId

path

integer(int32)

true

none

showSelected

query

boolean

false

none

keyword

query

string

false

none

limit

query

integer(int32)

false

none

offset

query

integer(int32)

false

none

orderBy

query

string

false

none

orderDirection

query

string

false

none

filterBy

query

string

false

none

reportsToPayee

query

boolean

false

none

isActive

query

boolean

false

none

Enumerated Values

Parameter

Value

orderDirection

Ascending

orderDirection

Descending

orderDirection

AscendingNullsFirst

orderDirection

DescendingNullsLast

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.Plans.PlanApprovalPayeeDTO]

false

none

none

» payeeDetails

Varicent.RESTAPI.v1.DTOs.PayeeIndepthDetailsDTO

false

none

none

»» title

string¦null

false

none

none

»» reportsToPayee

any

false

none

none

»» payeeProfilePicture

string(byte)¦null

false

none

none

»» groupIds

[integer]¦null

false

none

none

»» groupNames

[string]¦null

false

none

none

»» name

string¦null

false

none

none

»» id

string¦null

false

none

none

» selected

boolean

false

none

none

» distributed

boolean

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee',
  params: {
  }, headers: headers

p JSON.parse(result)

Select the payees for the given plan approval template.

Body parameter

[
  "string"
]

Parameters

Name

In

Type

Required

Description

templateId

path

integer(int32)

true

none

addOnly

query

boolean

false

none

body

body

array[string]

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  "string"
]';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.put('http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee',
  params: {
  }, headers: headers

p JSON.parse(result)

Restart the plan approval document for the given template payee.

Body parameter

{
  "payeeIds": [
    "string"
  ],
  "statuses": [
    "Selected"
  ]
}

Parameters

Name

In

Type

Required

Description

templateId

path

integer(int32)

true

none

body

body

RESTAPI.v1.DTOs.Plans.SelectedPayeesToDistributeDTO

false

none

» payeeIds

body

[string]¦null

false

none

» statuses

body

[string]¦null

false

none

Enumerated Values

Parameter

Value

» statuses

Selected

» statuses

PreManagerApproval

» statuses

PayeeSign

» statuses

Complete

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.Plans.PlanApprovalDistributeTemplateDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "payeeIds": [
    "string"
  ],
  "statuses": [
    "Selected"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee',
  params: {
  }, headers: headers

p JSON.parse(result)

Delete the plan approval document for the given template payee.

If the selected payee list is empty, the documents of the selected approval statuses will be deleted

Body parameter

{
  "payeeIds": [
    "string"
  ],
  "statuses": [
    "Selected"
  ]
}

Parameters

Name

In

Type

Required

Description

templateId

path

integer(int32)

true

none

body

body

RESTAPI.v1.DTOs.Plans.SelectedPayeesToDistributeDTO

false

none

» payeeIds

body

[string]¦null

false

none

» statuses

body

[string]¦null

false

none

Enumerated Values

Parameter

Value

» statuses

Selected

» statuses

PreManagerApproval

» statuses

PayeeSign

» statuses

Complete

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "payeeIds": [
    "string"
  ],
  "statuses": [
    "Selected"
  ]
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.delete('http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.delete 'http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee',
  params: {
  }, headers: headers

p JSON.parse(result)

Get the key and description for some payee fields, e.g. title

Parameters

Name

In

Type

Required

Description

tableName

path

string

true

none

filter

query

string

false

none

limit

query

integer(int32)

false

none

Responses

Status

Meaning

Description

Schema

200

OK

ID and description for different fields of payee are returned

RESTAPI.v1.DTOs.Plans.PlanApprovalPayeeLookupFieldsDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/internal/plan-approvals/payeeLookupFields/{tableName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plan-approvals/payeeLookupFields/{tableName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plan-approvals/payeeLookupFields/{tableName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/internal/plan-approvals/payeeLookupFields/{tableName}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/internal/plan-approvals/payeeLookupFields/{tableName}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "data": {
    "property1": "string",
    "property2": "string"
  }
}
{"data":{"property1":"string","property2":"string"}}

Get all portal access groups.

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.Plans.PayeePortalAccessGroupDTO]

false

none

none

» id

integer(int32)

false

none

none

» name

string¦null

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/internal/plan-approvals/portalaccessgroups", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plan-approvals/portalaccessgroups");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plan-approvals/portalaccessgroups',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/internal/plan-approvals/portalaccessgroups', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/internal/plan-approvals/portalaccessgroups',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "name": "string"
  }
]
[{"id":0,"name":"string"}]

Submit the document and move token to next node

Parameters

Name

In

Type

Required

Description

tokenId

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.Plans.PlanApprovalDocumentDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/internal/plan-approvals/token/{tokenId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plan-approvals/token/{tokenId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plan-approvals/token/{tokenId}',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/internal/plan-approvals/token/{tokenId}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/internal/plan-approvals/token/{tokenId}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "planApprovalTemplateId": 0,
  "payeeDetails": {
    "title": "string",
    "reportsToPayee": null,
    "payeeProfilePicture": "string",
    "groupIds": [
      0
    ],
    "groupNames": [
      "string"
    ],
    "name": "string",
    "id": "string"
  },
  "tokenId": 0,
  "status": "Selected",
  "createdAt": "2019-08-24T14:15:22Z",
  "lastModified": "2019-08-24T14:15:22Z",
  "signatureInfos": [
    {
      "signerId": "string",
      "signerName": "string",
      "signAt": "2019-08-24T14:15:22Z"
    }
  ],
  "documentDistributionStatus": "NotProcessed",
  "distributionLiveActivityId": 0,
  "version": {
    "rowVersion": 0
  },
  "migratedPlanDocumentId": 0
}
{"planApprovalTemplateId":0,"payeeDetails":{"title":"string","reportsToPayee":null,"payeeProfilePicture":"string","groupIds":[0],"groupNames":["string"],"name":"string","id":"string"},"tokenId":0,"status":"Selected","createdAt":"2019-08-24T14:15:22Z","lastModified":"2019-08-24T14:15:22Z","signatureInfos":[{"signerId":"string","signerName":"string","signAt":"2019-08-24T14:15:22Z"}],"documentDistributionStatus":"NotProcessed","distributionLiveActivityId":0,"version":{"rowVersion":0},"migratedPlanDocumentId":0}

Get the pdf document for the given templateId and payeeId for Admin

Parameters

Name

In

Type

Required

Description

templateId

path

integer(int32)

true

none

payeeId

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

string

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee/{payeeId}/pdf", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee/{payeeId}/pdf");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee/{payeeId}/pdf',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee/{payeeId}/pdf', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee/{payeeId}/pdf',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
"string"
"string"

Get the pdf document for the given templateId and payeeId for Payee

Parameters

Name

In

Type

Required

Description

templateId

path

integer(int32)

true

none

payeeId

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

string

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee/{payeeId}/pdfPayee", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee/{payeeId}/pdfPayee");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee/{payeeId}/pdfPayee',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee/{payeeId}/pdfPayee', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee/{payeeId}/pdfPayee',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
"string"
"string"

Get all plan approval documents associated with a Payee

Parameters

Name

In

Type

Required

Description

templateId

query

string

false

none

assigneePayeeId

query

string

false

none

offset

query

integer(int32)

false

none

limit

query

integer(int32)

false

none

onlyToBeSigned

query

boolean

false

none

includeSignatures

query

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.Plans.PlanApprovalPayeeDetailsDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/internal/plan-approvals/document/payee", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plan-approvals/document/payee");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plan-approvals/document/payee',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/internal/plan-approvals/document/payee', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/internal/plan-approvals/document/payee',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "payeeId": "string",
  "planApprovalDetails": [
    {
      "planApprovalTemplateId": 0,
      "name": "string",
      "documents": [],
      "workflowType": "Payee",
      "documentsCount": 0,
      "filteredDocumentsCount": 0,
      "version": {}
    }
  ],
  "signedDocumentCount": 0,
  "unsignedDocumentCount": 0,
  "version": {
    "rowVersion": 0
  }
}
{"payeeId":"string","planApprovalDetails":[{"planApprovalTemplateId":0,"name":"string","documents":[],"workflowType":"Payee","documentsCount":0,"filteredDocumentsCount":0,"version":{}}],"signedDocumentCount":0,"unsignedDocumentCount":0,"version":{"rowVersion":0}}

Get the details of the document to be signed

Parameters

Name

In

Type

Required

Description

templateId

path

integer(int32)

true

none

payeeId

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.Plans.PlanApprovalDetailsDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/internal/plan-approvals/{templateId}/documentPayee/payee/{payeeId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plan-approvals/{templateId}/documentPayee/payee/{payeeId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plan-approvals/{templateId}/documentPayee/payee/{payeeId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/internal/plan-approvals/{templateId}/documentPayee/payee/{payeeId}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/internal/plan-approvals/{templateId}/documentPayee/payee/{payeeId}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "planApprovalTemplateId": 0,
  "name": "string",
  "documents": [
    {
      "planApprovalTemplateId": 0,
      "payeeDetails": {},
      "tokenId": 0,
      "status": "Selected",
      "createdAt": "2019-08-24T14:15:22Z",
      "lastModified": "2019-08-24T14:15:22Z",
      "signatureInfos": [],
      "documentDistributionStatus": "NotProcessed",
      "distributionLiveActivityId": 0,
      "version": {},
      "migratedPlanDocumentId": 0
    }
  ],
  "workflowType": "Payee",
  "documentsCount": 0,
  "filteredDocumentsCount": 0,
  "version": {
    "rowVersion": 0
  }
}
{"planApprovalTemplateId":0,"name":"string","documents":[{"planApprovalTemplateId":0,"payeeDetails":{},"tokenId":0,"status":"Selected","createdAt":"2019-08-24T14:15:22Z","lastModified":"2019-08-24T14:15:22Z","signatureInfos":[],"documentDistributionStatus":"NotProcessed","distributionLiveActivityId":0,"version":{},"migratedPlanDocumentId":0}],"workflowType":"Payee","documentsCount":0,"filteredDocumentsCount":0,"version":{"rowVersion":0}}

Download a completed document for the given templateId and payeeId

Parameters

Name

In

Type

Required

Description

templateId

path

integer(int32)

true

none

payeeId

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.FileContentDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee/{payeeId}/download", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee/{payeeId}/download");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee/{payeeId}/download',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee/{payeeId}/download', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/internal/plan-approvals/{templateId}/document/payee/{payeeId}/download',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "filename": "string",
  "data64": "string"
}
{"filename":"string","data64":"string"}

Duplicate a Plan Approval Document

Body parameter

{
  "workflowType": "Payee",
  "name": "string",
  "includePayees": true
}

Parameters

Name

In

Type

Required

Description

templateId

path

integer(int32)

true

none

body

body

RESTAPI.v1.DTOs.Plans.PlanApprovalTemplateDuplicateDTO

false

none

» workflowType

body

string

false

none

» name

body

string¦null

false

none

» includePayees

body

boolean

false

none

Enumerated Values

Parameter

Value

» workflowType

Payee

» workflowType

ManagerPayee

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.Plans.PlanApprovalTemplateDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/internal/plan-approvals/{templateId}/duplicate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plan-approvals/{templateId}/duplicate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "workflowType": "Payee",
  "name": "string",
  "includePayees": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plan-approvals/{templateId}/duplicate',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/internal/plan-approvals/{templateId}/duplicate', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/internal/plan-approvals/{templateId}/duplicate',
  params: {
  }, headers: headers

p JSON.parse(result)

Create new publications. For the Location header /api/v1/publications/[publisherID], please replace [publisherID] with the value accordingly.

Body parameter

{
  "templateId": 0,
  "planApprovalStatuses": [
    "Selected"
  ]
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.Plans.PlanApprovalBulkDownloadDTO

false

none

» templateId

body

integer(int32)

false

none

» planApprovalStatuses

body

[string]¦null

false

none

Enumerated Values

Parameter

Value

» planApprovalStatuses

Selected

» planApprovalStatuses

PreManagerApproval

» planApprovalStatuses

PayeeSign

» planApprovalStatuses

Complete

Responses

Status

Meaning

Description

Schema

201

Created

Create new bulk plan documents publications

Inline

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.Publisher.PublisherDefinitionDTO]

false

none

none

» publisherId

integer(int32)

false

none

none

» name

string¦null

false

none

none

» publishType

string

false

none

none

» location

string¦null

false

none

none

» publisherParams

[Varicent.RESTAPI.v1.DTOs.Publisher.PublisherParamsDTO]¦null

false

none

none

»» type

string

false

none

none

»» calculationId

integer(int32)¦null

false

none

none

»» calculationName

string¦null

false

none

none

»» portId

integer(int32)¦null

false

none

none

»» columnMap

object¦null

false

none

none

»»» additionalProperties

string¦null

false

none

none

»» customTableName

string¦null

false

none

none

»» filter

string¦null

false

none

none

»» inputFormID

integer(int32)

false

none

none

»» columns

string¦null

false

none

none

»» headerRow

string¦null

false

none

none

»» compress

boolean¦null

false

none

none

»» customOrderBy

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

none

»»» table

string¦null

false

none

none

»»» column

string¦null

false

none

none

»»» direction

string

false

none

none

»» columnFormat

[Varicent.RESTAPI.v1.DTOs.Publisher.PublisherColumnFormatDTO]¦null

false

none

none

»»» column

string¦null

false

none

none

»»» scale

integer(int32)

false

none

none

»» columnWithDescription

[string]¦null

false

none

none

»» dataStoreName

string¦null

false

none

none

»» delimiter

string¦null

false

none

none

»» compPlanId

string¦null

false

none

none

»» payeeId

string¦null

false

none

none

»» period

string¦null

false

none

none

»» periodLevel

string¦null

false

none

none

»» payeeMajorDim

boolean¦null

false

none

none

»» mailWebUsers

boolean¦null

false

none

none

»» recipients

[string]¦null

false

none

none

»» emailSubject

string¦null

false

none

none

»» emailBody

string¦null

false

none

none

»» singleWorkbook

boolean¦null

false

none

none

»» fileName

string¦null

false

none

none

»» headerImage

string¦null

false

none

none

»» numberPages

boolean¦null

false

none

none

»» showTotalPageNumber

boolean¦null

false

none

none

»» portraitOrientation

boolean¦null

false

none

none

»» autoScale

boolean¦null

false

none

none

»» customScaleValue

number(double)¦null

false

none

none

»» tableViewportWidth

number(double)¦null

false

none

none

»» footerText

string¦null

false

none

none

»» mergePdfFiles

boolean¦null

false

none

none

»» expandAllTableGroups

boolean¦null

false

none

none

»» user

string¦null

false

none

none

»» password

string¦null

false

none

none

»» token

string¦null

false

none

none

»» table

string¦null

false

none

none

»» sandbox

boolean¦null

false

none

none

»» dateFormat

string¦null

false

none

none

»» header

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

none

»»» alignment

string

false

none

none

»»» backColor

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

none

»»»» a

integer(int32)

false

none

none

»»»» b

integer(int32)

false

none

none

»»»» g

integer(int32)

false

none

none

»»»» r

integer(int32)

false

none

none

»»» font

Varicent.RESTAPI.v1.DTOs.FontDefinitionDTO

false

none

none

»»»» family

string¦null

false

none

none

»»»» size

number(float)

false

none

none

»»»» unit

string¦null

false

none

none

»»»» bold

boolean

false

none

none

»»»» italic

boolean

false

none

none

»»»» underline

boolean

false

none

none

»»»» strikeout

boolean

false

none

none

»»» foreColor

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

none

»» row

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

none

»» altRow

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

none

»» webFormId

integer(int32)

false

none

none

»» workflowGroupId

integer(int32)

false

none

none

»» filterValues

object¦null

false

none

none

»»» additionalProperties

string¦null

false

none

none

»» webReportId

integer(int32)¦null

false

none

none

»» parameterValues

object¦null

false

none

none

»»» additionalProperties

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

»»»» expressionType

string

false

none

none

»»»» cases

array¦null

false

none

none

»»»»» anonymous

any

false

none

none

»»»» table

string¦null

false

none

none

»»»» column

string¦null

false

none

none

»»»» op

string¦null

false

none

none

»»»» arguments

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

none

[DTO version of IExpression]

»»»»» expressionType

string

false

none

none

»»»»» cases

array¦null

false

none

none

»»»»»» anonymous

any

false

none

none

»»»»» table

string¦null

false

none

none

»»»»» column

string¦null

false

none

none

»»»»» op

string¦null

false

none

none

»»»»» arguments

array¦null

false

none

none

»»»»»» anonymous

any

false

none

none

»»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»»»» constraintType

string

false

none

none

»»»»»» op

string¦null

false

none

none

»»»»»» dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»»» expressionType

string

false

none

none

»»»»»»» cases

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»»» table

string¦null

false

none

none

»»»»»»» column

string¦null

false

none

none

»»»»»»» op

string¦null

false

none

none

»»»»»»» arguments

array¦null

false

none

none

»»»»»»»» anonymous

any

false

none

none

»»»»»»» condition

any

false

none

none

»»»»»»» trueValue

any

false

none

none

»»»»»»» falseValue

any

false

none

none

»»»»»»» isDate

boolean

false

none

none

»»»»»»» literalType

string

false

none

none

»»»»»»» value

any

false

none

none

»»»»»» caseSensitive

boolean

false

none

none

»»»»»» constraints

array¦null

false

none

none

»»»»»»» anonymous

any

false

none

none

»»»»»» literalRight

any

false

none

none

»»»»»» dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

»»»»»» right

any

false

none

none

»»»»»» expressionLeft

any

false

none

none

»»»»»» expressionRight

any

false

none

none

»»»»»» isPreciseDecimal

boolean

false

none

none

»»»»»» like

string¦null

false

none

none

»»»»»» escapeWildcards

boolean

false

none

none

»»»»»» rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»»»»»»» rowVersion

integer(int64)

false

none

none

»»»»»» table

string¦null

false

none

none

»»»»»» queryDefinitionRight

any

false

none

none

»»»»» trueValue

any

false

none

none

»»»»» falseValue

any

false

none

none

»»»»» isDate

boolean

false

none

none

»»»»» literalType

string

false

none

none

»»»»» value

any

false

none

none

»»»» condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

»»»» trueValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»» falseValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

»»»» isDate

boolean

false

none

none

»»»» literalType

string

false

none

none

»»»» value

any

false

none

none

»» currentUserId

string¦null

false

none

none

»» isBatchExport

boolean

false

none

none

»» batchExportPayeeList

[string]¦null

false

none

none

»» hiddenColumnMap

object¦null

false

none

none

»»» additionalProperties

[string]¦null

false

none

none

»» batchPicklistRefParam

string¦null

false

none

none

»» bpmPublishType

string

false

none

none

»» workflowId

integer(int32)

false

none

none

»» tokenId

integer(int32)

false

none

none

»» timezoneOffset

string¦null

false

none

none

»» offset

integer(int32)

false

none

none

»» limit

integer(int32)

false

none

none

»» orderBy

string¦null

false

none

none

»» queryToolId

integer(int32)

false

none

none

»» name

string¦null

false

none

none

»» fromDataServer

string

false

none

none

»» queryString

string¦null

false

none

none

»» description

string¦null

false

none

none

»» timeout

integer(int32)

false

none

none

»» presenterFlexReportId

integer(int32)¦null

false

none

none

»» webTabId

integer(int32)¦null

false

none

none

»» currentPayeeId

string¦null

false

none

none

»» batchExportPayeeIds

[string]¦null

false

none

none

»» bpmTokenId

integer(int32)¦null

false

none

none

»» planApprovalTemplateId

integer(int32)

false

none

none

»» planApprovalStatus

string

false

none

none

»» planDocumentId

integer(int32)

false

none

none

»» payeeWorkflowStatus

string

false

none

none

»» planBuilderCalculationId

string¦null

false

none

none

»» planBuilderCalculationName

string¦null

false

none

none

»» requirementIds

[string]¦null

false

none

none

»» requirementExportAll

boolean

false

none

none

»» requirementExportTitle

string¦null

false

none

none

»» requirementfilter

string¦null

false

none

none

»» requirementOrderBy

string¦null

false

none

none

» isTemporary

boolean

false

none

none

» enableScreenshot

boolean

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

publishType

CalculationExcel

publishType

CalculationMSCRM

publishType

CalculationPdf

publishType

CalculationSalesforce

publishType

CalculationText

publishType

CustomTableExcel

publishType

CustomTableMSCRM

publishType

CustomTablePdf

publishType

CustomTableSalesforce

publishType

CustomTableText

publishType

WebFormPdf

publishType

WebReportPdf

publishType

BPMExcel

publishType

PortExcel

publishType

PortPdf

publishType

PortSalesforce

publishType

PortText

publishType

PerformanceExcel

publishType

PerformancePdf

publishType

PerformanceSalesforce

publishType

PerformanceText

publishType

PayeeWebWebReportPdf

publishType

DataStoreText

publishType

DataStoreExcel

publishType

QueryToolText

publishType

QueryToolExcel

publishType

CalculationCOS

publishType

CustomTableCOS

publishType

PortCOS

publishType

PerformanceCOS

publishType

PresenterFlexPdf

publishType

PayeeWebPresenterFlexPdf

publishType

HealthDashboardExcel

publishType

PlanDocumentPdf

publishType

StandardReportPdf

publishType

BulkPlanDocumentsZip

publishType

MassPlanDocumentDownloadZip

publishType

AdminPresenterFlexPdf

publishType

PlanDocument2Pdf

publishType

PlanBuilderCalculationExcel

publishType

PlanBuilderCalculationMSCRM

publishType

PlanBuilderCalculationPdf

publishType

PlanBuilderCalculationSalesforce

publishType

PlanBuilderCalculationText

publishType

PlanBuilderCalculationCOS

publishType

RequirementPdf

type

Calculation

type

ColumnMap

type

CustomTable

type

Delimited

type

Email

type

Excel

type

File

type

MSCRM

type

Pdf

type

Performance

type

Salesforce

type

TableStyle

type

WebForm

type

WebReport

type

WebReportView

type

BPM

type

Port

type

DataStore

type

QueryTool

type

PresenterFlex

type

PresenterFlexView

type

PlanDocument

type

StandardReport

type

BulkPlanDocuments

type

PlanDocumentDownload

type

PlanDocument2

type

PlanBuilderCalculation

type

Requirement

direction

Ascending

direction

Descending

direction

AscendingNullsFirst

direction

DescendingNullsLast

dateFormat

Default

dateFormat

DayFirst

dateFormat

MonthFirst

alignment

Justify

alignment

Left

alignment

Center

alignment

Right

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

bpmPublishType

History

bpmPublishType

PendingActions

bpmPublishType

ActionNodeErrors

bpmPublishType

AlertNodeErrors

bpmPublishType

ServiceNodeErrors

bpmPublishType

SignNodeErrors

bpmPublishType

StatusReport

fromDataServer

QUERY_SQL

fromDataServer

QUERY_SPARK

fromDataServer

QUERY_PRESTO

planApprovalStatus

Selected

planApprovalStatus

PreManagerApproval

planApprovalStatus

PayeeSign

planApprovalStatus

Complete

payeeWorkflowStatus

InProgress

payeeWorkflowStatus

Complete

payeeWorkflowStatus

Cancelled

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/internal/plan-approvals/create-bulk-download-publication", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plan-approvals/create-bulk-download-publication");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "templateId": 0,
  "planApprovalStatuses": [
    "Selected"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plan-approvals/create-bulk-download-publication',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/internal/plan-approvals/create-bulk-download-publication', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/internal/plan-approvals/create-bulk-download-publication',
  params: {
  }, headers: headers

p JSON.parse(result)

Get the summary of the last download for the template.

Parameters

Name

In

Type

Required

Description

templateId

path

integer(int32)

true

Template ID

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.Plans.PlanApprovalDocumentBulkDownloadSummaryDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/internal/plan-approvals/last-download-summary/{templateId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plan-approvals/last-download-summary/{templateId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plan-approvals/last-download-summary/{templateId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/internal/plan-approvals/last-download-summary/{templateId}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/internal/plan-approvals/last-download-summary/{templateId}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "templateId": 0,
  "summary": {
    "Selected": {
      "currentFilesCount": 0,
      "lastDownloadFilesCount": 0,
      "lastDownloadAt": "2019-08-24T14:15:22Z",
      "lastDownloadUserId": "string"
    },
    "PreManagerApproval": {
      "currentFilesCount": 0,
      "lastDownloadFilesCount": 0,
      "lastDownloadAt": "2019-08-24T14:15:22Z",
      "lastDownloadUserId": "string"
    },
    "PayeeSign": {
      "currentFilesCount": 0,
      "lastDownloadFilesCount": 0,
      "lastDownloadAt": "2019-08-24T14:15:22Z",
      "lastDownloadUserId": "string"
    },
    "Complete": {
      "currentFilesCount": 0,
      "lastDownloadFilesCount": 0,
      "lastDownloadAt": "2019-08-24T14:15:22Z",
      "lastDownloadUserId": "string"
    }
  }
}
{"templateId":0,"summary":{"Selected":{"currentFilesCount":0,"lastDownloadFilesCount":0,"lastDownloadAt":"2019-08-24T14:15:22Z","lastDownloadUserId":"string"},"PreManagerApproval":{"currentFilesCount":0,"lastDownloadFilesCount":0,"lastDownloadAt":"2019-08-24T14:15:22Z","lastDownloadUserId":"string"},"PayeeSign":{"currentFilesCount":0,"lastDownloadFilesCount":0,"lastDownloadAt":"2019-08-24T14:15:22Z","lastDownloadUserId":"string"},"Complete":{"currentFilesCount":0,"lastDownloadFilesCount":0,"lastDownloadAt":"2019-08-24T14:15:22Z","lastDownloadUserId":"string"}}}

Get the last download data for the template.

Parameters

Name

In

Type

Required

Description

templateId

path

integer(int32)

true

Template ID

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» Selected

RESTAPI.v1.DTOs.Plans.PlanApprovalDocumentBulkDownloadDTO

false

none

none

»» publisherID

integer(int32)

false

none

none

»» downloadAt

string(date-time)

false

none

none

»» userID

string¦null

false

none

none

»» targetFilesCount

integer(int32)

false

none

none

»» actualFilesCount

integer(int32)

false

none

none

»» targetFilenames

string¦null

false

none

none

»» actualFilenames

string¦null

false

none

none

»» errorMessage

string¦null

false

none

none

» PreManagerApproval

RESTAPI.v1.DTOs.Plans.PlanApprovalDocumentBulkDownloadDTO

false

none

none

» PayeeSign

RESTAPI.v1.DTOs.Plans.PlanApprovalDocumentBulkDownloadDTO

false

none

none

» Complete

RESTAPI.v1.DTOs.Plans.PlanApprovalDocumentBulkDownloadDTO

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/internal/plan-approvals/last-download/{templateId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plan-approvals/last-download/{templateId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plan-approvals/last-download/{templateId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/internal/plan-approvals/last-download/{templateId}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/internal/plan-approvals/last-download/{templateId}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "Selected": {
    "publisherID": 0,
    "downloadAt": "2019-08-24T14:15:22Z",
    "userID": "string",
    "targetFilesCount": 0,
    "actualFilesCount": 0,
    "targetFilenames": "string",
    "actualFilenames": "string",
    "errorMessage": "string"
  },
  "PreManagerApproval": {
    "publisherID": 0,
    "downloadAt": "2019-08-24T14:15:22Z",
    "userID": "string",
    "targetFilesCount": 0,
    "actualFilesCount": 0,
    "targetFilenames": "string",
    "actualFilenames": "string",
    "errorMessage": "string"
  },
  "PayeeSign": {
    "publisherID": 0,
    "downloadAt": "2019-08-24T14:15:22Z",
    "userID": "string",
    "targetFilesCount": 0,
    "actualFilesCount": 0,
    "targetFilenames": "string",
    "actualFilenames": "string",
    "errorMessage": "string"
  },
  "Complete": {
    "publisherID": 0,
    "downloadAt": "2019-08-24T14:15:22Z",
    "userID": "string",
    "targetFilesCount": 0,
    "actualFilesCount": 0,
    "targetFilenames": "string",
    "actualFilenames": "string",
    "errorMessage": "string"
  }
}
{"Selected":{"publisherID":0,"downloadAt":"2019-08-24T14:15:22Z","userID":"string","targetFilesCount":0,"actualFilesCount":0,"targetFilenames":"string","actualFilenames":"string","errorMessage":"string"},"PreManagerApproval":{"publisherID":0,"downloadAt":"2019-08-24T14:15:22Z","userID":"string","targetFilesCount":0,"actualFilesCount":0,"targetFilenames":"string","actualFilenames":"string","errorMessage":"string"},"PayeeSign":{"publisherID":0,"downloadAt":"2019-08-24T14:15:22Z","userID":"string","targetFilesCount":0,"actualFilesCount":0,"targetFilenames":"string","actualFilenames":"string","errorMessage":"string"},"Complete":{"publisherID":0,"downloadAt":"2019-08-24T14:15:22Z","userID":"string","targetFilesCount":0,"actualFilesCount":0,"targetFilenames":"string","actualFilenames":"string","errorMessage":"string"}}

PlanDocument

Get a plan document.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/internal/plandocument/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plandocument/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plandocument/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/internal/plandocument/{id}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/internal/plandocument/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "planDocumentId": 0,
  "name": "string",
  "workflowId": 0,
  "metadata": {
    "property1": null,
    "property2": null
  },
  "distributionStatus": "Draft",
  "agreementVisited": true,
  "workflowVisited": true,
  "payeeCount": 0,
  "payeeStatusCount": {
    "property1": 0,
    "property2": 0
  },
  "reportId": 0,
  "isWorkflowRunning": true,
  "description": "string",
  "workflowState": "NotStarted",
  "errors": {
    "NoError": "string",
    "CannotBeEmpty": "string",
    "LessThan100Char": "string",
    "NoTrailingSpaces": "string",
    "NameAlreadyExists": "string",
    "PresenterAdaptiveSpecificError": "string"
  },
  "hasAdminSwimlane": true,
  "adminActionsCount": 0,
  "nodeErrorsCount": 0,
  "showDuplicateCallout": true,
  "pdfGenerationFails": 0,
  "version": {
    "rowVersion": 0
  }
}
{"planDocumentId":0,"name":"string","workflowId":0,"metadata":{"property1":null,"property2":null},"distributionStatus":"Draft","agreementVisited":true,"workflowVisited":true,"payeeCount":0,"payeeStatusCount":{"property1":0,"property2":0},"reportId":0,"isWorkflowRunning":true,"description":"string","workflowState":"NotStarted","errors":{"NoError":"string","CannotBeEmpty":"string","LessThan100Char":"string","NoTrailingSpaces":"string","NameAlreadyExists":"string","PresenterAdaptiveSpecificError":"string"},"hasAdminSwimlane":true,"adminActionsCount":0,"nodeErrorsCount":0,"showDuplicateCallout":true,"pdfGenerationFails":0,"version":{"rowVersion":0}}

Delete the plan document.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/internal/plandocument/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plandocument/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/internal/plandocument/{id}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.delete('http://localhost:8080/api/internal/plandocument/{id}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.delete 'http://localhost:8080/api/internal/plandocument/{id}',
  params: {
  }

p JSON.parse(result)

Get all the plan document.

Parameters

Name

In

Type

Required

Description

limit

query

integer(int32)

false

none

offset

query

integer(int32)

false

none

orderBy

query

string

false

none

orderDirection

query

string

false

none

filterBy

query

string

false

none

Enumerated Values

Parameter

Value

orderDirection

Ascending

orderDirection

Descending

orderDirection

AscendingNullsFirst

orderDirection

DescendingNullsLast

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentDTO]

false

none

none

» planDocumentId

integer(int32)¦null

false

none

none

» name

string¦null

false

none

none

» workflowId

integer(int32)

false

none

none

» metadata

RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentMetadataDTO

false

none

none

»» additionalProperties

any

false

none

none

» distributionStatus

string

false

none

none

» agreementVisited

boolean

false

none

none

» workflowVisited

boolean

false

none

none

» payeeCount

integer(int32)

false

none

none

» payeeStatusCount

object¦null

false

none

none

»» additionalProperties

integer(int32)¦null

false

none

none

» reportId

integer(int32)

false

none

none

» isWorkflowRunning

boolean

false

none

none

» description

string¦null

false

none

none

» workflowState

string

false

none

none

» errors

object¦null

false

none

none

»» NoError

string

false

none

none

»» CannotBeEmpty

string

false

none

none

»» LessThan100Char

string

false

none

none

»» NoTrailingSpaces

string

false

none

none

»» NameAlreadyExists

string

false

none

none

»» PresenterAdaptiveSpecificError

string

false

none

none

» hasAdminSwimlane

boolean

false

none

none

» adminActionsCount

integer(int32)

false

none

none

» nodeErrorsCount

integer(int32)

false

none

none

» showDuplicateCallout

boolean

false

none

none

» pdfGenerationFails

integer(int32)

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

Enumerated Values

Property

Value

distributionStatus

Draft

distributionStatus

Ready

distributionStatus

DistributionInProgress

distributionStatus

Distributed

workflowState

NotStarted

workflowState

InProgress

workflowState

Ended

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/internal/plandocument", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plandocument");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plandocument',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/internal/plandocument', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/internal/plandocument',
  params: {
  }, headers: headers

p JSON.parse(result)

Insert a plan document.

Body parameter

{
  "planDocumentId": 0,
  "name": "string",
  "description": "string",
  "workflowId": 0,
  "templateType": "Payee",
  "metadataPlanDocument": {
    "property1": null,
    "property2": null
  },
  "parentFolderId": 0,
  "order": 0
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.PlanDocuments.CreatePlanDocumentDTO

false

none

» planDocumentId

body

integer(int32)¦null

false

none

» name

body

string¦null

false

none

» description

body

string¦null

false

none

» workflowId

body

integer(int32)¦null

false

none

» templateType

body

string¦null

false

none

» metadataPlanDocument

body

RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentMetadataDTO

false

none

»» additionalProperties

body

any

false

none

» parentFolderId

body

integer(int32)¦null

false

none

» order

body

integer(int32)¦null

false

none

Enumerated Values

Parameter

Value

» templateType

Payee

» templateType

ManagerPayee

» templateType

Custom

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentDTO RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/internal/plandocument", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plandocument");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "planDocumentId": 0,
  "name": "string",
  "description": "string",
  "workflowId": 0,
  "templateType": "Payee",
  "metadataPlanDocument": {
    "property1": null,
    "property2": null
  },
  "parentFolderId": 0,
  "order": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plandocument',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/internal/plandocument', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/internal/plandocument',
  params: {
  }, headers: headers

p JSON.parse(result)

Duplicate a plan document.

Body parameter

{
  "name": "string",
  "planDocumentId": 0,
  "description": "string",
  "metadataPlanDocument": {
    "property1": null,
    "property2": null
  },
  "copyPayees": true
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.PlanDocuments.DuplicatePlanDocumentDTO

false

none

» name

body

string¦null

false

none

» planDocumentId

body

integer(int32)

false

none

» description

body

string¦null

false

none

» metadataPlanDocument

body

RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentMetadataDTO

false

none

»» additionalProperties

body

any

false

none

» copyPayees

body

boolean¦null

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/internal/plandocument", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plandocument");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "name": "string",
  "planDocumentId": 0,
  "description": "string",
  "metadataPlanDocument": {
    "property1": null,
    "property2": null
  },
  "copyPayees": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plandocument',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/internal/plandocument', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/internal/plandocument',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "planDocumentId": 0,
  "name": "string",
  "workflowId": 0,
  "metadata": {
    "property1": null,
    "property2": null
  },
  "distributionStatus": "Draft",
  "agreementVisited": true,
  "workflowVisited": true,
  "payeeCount": 0,
  "payeeStatusCount": {
    "property1": 0,
    "property2": 0
  },
  "reportId": 0,
  "isWorkflowRunning": true,
  "description": "string",
  "workflowState": "NotStarted",
  "errors": {
    "NoError": "string",
    "CannotBeEmpty": "string",
    "LessThan100Char": "string",
    "NoTrailingSpaces": "string",
    "NameAlreadyExists": "string",
    "PresenterAdaptiveSpecificError": "string"
  },
  "hasAdminSwimlane": true,
  "adminActionsCount": 0,
  "nodeErrorsCount": 0,
  "showDuplicateCallout": true,
  "pdfGenerationFails": 0,
  "version": {
    "rowVersion": 0
  }
}
{"planDocumentId":0,"name":"string","workflowId":0,"metadata":{"property1":null,"property2":null},"distributionStatus":"Draft","agreementVisited":true,"workflowVisited":true,"payeeCount":0,"payeeStatusCount":{"property1":0,"property2":0},"reportId":0,"isWorkflowRunning":true,"description":"string","workflowState":"NotStarted","errors":{"NoError":"string","CannotBeEmpty":"string","LessThan100Char":"string","NoTrailingSpaces":"string","NameAlreadyExists":"string","PresenterAdaptiveSpecificError":"string"},"hasAdminSwimlane":true,"adminActionsCount":0,"nodeErrorsCount":0,"showDuplicateCallout":true,"pdfGenerationFails":0,"version":{"rowVersion":0}}

Update the plan document.

Body parameter

{
  "planDocumentId": 0,
  "name": "string",
  "workflowId": 0,
  "metadata": {
    "property1": null,
    "property2": null
  },
  "distributionStatus": "Draft",
  "agreementVisited": true,
  "workflowVisited": true,
  "payeeCount": 0,
  "payeeStatusCount": {
    "property1": 0,
    "property2": 0
  },
  "reportId": 0,
  "isWorkflowRunning": true,
  "description": "string",
  "workflowState": "NotStarted",
  "errors": {
    "NoError": "string",
    "CannotBeEmpty": "string",
    "LessThan100Char": "string",
    "NoTrailingSpaces": "string",
    "NameAlreadyExists": "string",
    "PresenterAdaptiveSpecificError": "string"
  },
  "hasAdminSwimlane": true,
  "adminActionsCount": 0,
  "nodeErrorsCount": 0,
  "showDuplicateCallout": true,
  "pdfGenerationFails": 0,
  "version": {
    "rowVersion": 0
  }
}

Parameters

Name

In

Type

Required

Description

id

query

integer(int32)

false

none

body

body

RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentDTO

false

none

» planDocumentId

body

integer(int32)¦null

false

none

» name

body

string¦null

false

none

» workflowId

body

integer(int32)

false

none

» metadata

body

RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentMetadataDTO

false

none

»» additionalProperties

body

any

false

none

» distributionStatus

body

string

false

none

» agreementVisited

body

boolean

false

none

» workflowVisited

body

boolean

false

none

» payeeCount

body

integer(int32)

false

none

» payeeStatusCount

body

object¦null

false

none

»» additionalProperties

body

integer(int32)¦null

false

none

» reportId

body

integer(int32)

false

none

» isWorkflowRunning

body

boolean

false

none

» description

body

string¦null

false

none

» workflowState

body

string

false

none

» errors

body

object¦null

false

none

»» NoError

body

string

false

none

»» CannotBeEmpty

body

string

false

none

»» LessThan100Char

body

string

false

none

»» NoTrailingSpaces

body

string

false

none

»» NameAlreadyExists

body

string

false

none

»» PresenterAdaptiveSpecificError

body

string

false

none

» hasAdminSwimlane

body

boolean

false

none

» adminActionsCount

body

integer(int32)

false

none

» nodeErrorsCount

body

integer(int32)

false

none

» showDuplicateCallout

body

boolean

false

none

» pdfGenerationFails

body

integer(int32)

false

none

» version

body

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

»» rowVersion

body

integer(int64)

false

none

Enumerated Values

Parameter

Value

» distributionStatus

Draft

» distributionStatus

Ready

» distributionStatus

DistributionInProgress

» distributionStatus

Distributed

» workflowState

NotStarted

» workflowState

InProgress

» workflowState

Ended

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/internal/plandocument", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plandocument");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "planDocumentId": 0,
  "name": "string",
  "workflowId": 0,
  "metadata": {
    "property1": null,
    "property2": null
  },
  "distributionStatus": "Draft",
  "agreementVisited": true,
  "workflowVisited": true,
  "payeeCount": 0,
  "payeeStatusCount": {
    "property1": 0,
    "property2": 0
  },
  "reportId": 0,
  "isWorkflowRunning": true,
  "description": "string",
  "workflowState": "NotStarted",
  "errors": {
    "NoError": "string",
    "CannotBeEmpty": "string",
    "LessThan100Char": "string",
    "NoTrailingSpaces": "string",
    "NameAlreadyExists": "string",
    "PresenterAdaptiveSpecificError": "string"
  },
  "hasAdminSwimlane": true,
  "adminActionsCount": 0,
  "nodeErrorsCount": 0,
  "showDuplicateCallout": true,
  "pdfGenerationFails": 0,
  "version": {
    "rowVersion": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plandocument',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('http://localhost:8080/api/internal/plandocument', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch 'http://localhost:8080/api/internal/plandocument',
  params: {
  }, headers: headers

p JSON.parse(result)

Get all plan documents as a tree structure.

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.TreeNodeDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/internal/plandocumenttree", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plandocumenttree");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plandocumenttree',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/internal/plandocumenttree', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/internal/plandocumenttree',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "node": null,
  "children": []
}
{"node":null,"children":[]}

Get all the payees in plan document.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

limit

query

integer(int32)

false

none

offset

query

integer(int32)

false

none

orderBy

query

string

false

none

orderDirection

query

string

false

none

filterBy

query

string

false

none

Enumerated Values

Parameter

Value

orderDirection

Ascending

orderDirection

Descending

orderDirection

AscendingNullsFirst

orderDirection

DescendingNullsLast

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentPayeeDTO]

false

none

none

» name

string¦null

false

none

none

» payeeId

string¦null

false

none

none

» title

string¦null

false

none

none

» reportsTo

any

false

none

none

» status

string¦null

false

none

none

» nodeEndDate

string(date-time)¦null

false

none

none

» nodeStartDate

string(date-time)¦null

false

none

none

» nodeUpdatedDate

string(date-time)¦null

false

none

none

» isPDFGenerated

boolean

false

none

none

» isAdmin

boolean

false

none

none

» nodeId

integer(int32)¦null

false

none

none

» tokenId

integer(int32)¦null

false

none

none

» assignees

[string]¦null

false

none

none

» isRestarted

boolean

false

none

none

» pdfGenerationFailed

boolean

false

none

none

» pdfGenerationFailureDate

string(date-time)¦null

false

none

none

Enumerated Values

Property

Value

status

InProgress

status

Complete

status

Cancelled

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/internal/plandocument/{id}/cancelledpayees", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plandocument/{id}/cancelledpayees");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plandocument/{id}/cancelledpayees',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/internal/plandocument/{id}/cancelledpayees', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/internal/plandocument/{id}/cancelledpayees',
  params: {
  }, headers: headers

p JSON.parse(result)

Add payee to an in-progress plan document

Body parameter

[
  "string"
]

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

array[string]

false

none

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/internal/plandocument/{id}/payees", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plandocument/{id}/payees");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  "string"
]';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/internal/plandocument/{id}/payees',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.put('http://localhost:8080/api/internal/plandocument/{id}/payees', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/internal/plandocument/{id}/payees',
  params: {
  }, headers: headers

p JSON.parse(result)

Remove payee from an in-progress plan document

Body parameter

[
  "string"
]

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

body

body

array[string]

false

none

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "http://localhost:8080/api/internal/plandocument/{id}/payees", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plandocument/{id}/payees");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '[
  "string"
]';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/internal/plandocument/{id}/payees',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.delete('http://localhost:8080/api/internal/plandocument/{id}/payees', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.delete 'http://localhost:8080/api/internal/plandocument/{id}/payees',
  params: {
  }, headers: headers

p JSON.parse(result)

Cleans up all Plan Dcoument Dependencies

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/internal/plandocument/cleanup", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plandocument/cleanup");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/internal/plandocument/cleanup',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/internal/plandocument/cleanup')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/internal/plandocument/cleanup',
  params: {
  }

p JSON.parse(result)

Distribute the plan document.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

The plan approval template ID

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/internal/plandocument/{id}/distribute", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plandocument/{id}/distribute");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/internal/plandocument/{id}/distribute',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/internal/plandocument/{id}/distribute')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/internal/plandocument/{id}/distribute',
  params: {
  }

p JSON.parse(result)

Stop the plan document workflow.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

The plan approval template ID

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/internal/plandocument/{id}/stop", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plandocument/{id}/stop");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/internal/plandocument/{id}/stop',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/internal/plandocument/{id}/stop')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/internal/plandocument/{id}/stop',
  params: {
  }

p JSON.parse(result)

Regenerate PDFs for the plan doc.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

The plan approval template ID

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/internal/plandocument/{id}/regeneratepdfs", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plandocument/{id}/regeneratepdfs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/internal/plandocument/{id}/regeneratepdfs',
{
  method: 'PUT'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.put('http://localhost:8080/api/internal/plandocument/{id}/regeneratepdfs')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.put 'http://localhost:8080/api/internal/plandocument/{id}/regeneratepdfs',
  params: {
  }

p JSON.parse(result)

Regenerate PDF for a given payee in a given plan doc.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

The plan approval template ID

payeeId

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/internal/plandocument/{id}/regeneratepdf/{payeeId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plandocument/{id}/regeneratepdf/{payeeId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/internal/plandocument/{id}/regeneratepdf/{payeeId}',
{
  method: 'PUT'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.put('http://localhost:8080/api/internal/plandocument/{id}/regeneratepdf/{payeeId}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.put 'http://localhost:8080/api/internal/plandocument/{id}/regeneratepdf/{payeeId}',
  params: {
  }

p JSON.parse(result)

Get the PDF document base64 string for payee.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

payeeId

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

string

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/internal/plandocument/{id}/document/payee/{payeeId}/pdf", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plandocument/{id}/document/payee/{payeeId}/pdf");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plandocument/{id}/document/payee/{payeeId}/pdf',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/internal/plandocument/{id}/document/payee/{payeeId}/pdf', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/internal/plandocument/{id}/document/payee/{payeeId}/pdf',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
"string"
"string"

Get a list of Action and Sign Nodes in the Plan Document Workflow.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Varicent.RESTAPI.v1.DTOs.BPMNodeDTO]

false

none

none

» id

integer(int32)

false

none

none

» swimLaneId

integer(int32)

false

none

none

» name

string¦null

false

none

none

» description

string¦null

false

none

none

» order

integer(int32)

false

none

none

» paths

[RESTAPI.v1.DTOs.BPM.BPMPathDTO]¦null

false

none

none

»» pathID

integer(int32)

false

none

none

»» name

string¦null

false

none

none

»» originNodeID

integer(int32)

false

none

none

»» destinationNodeID

integer(int32)¦null

false

none

none

»» allMember

boolean

false

none

none

»» allSubmit

boolean

false

none

none

»» saveAndSubmit

boolean

false

none

none

»» reviewResult

string

false

none

none

»» position

integer(int32)

false

none

none

»» condition

string¦null

false

none

none

»» isDefault

boolean

false

none

none

»» isSign

boolean

false

none

none

» nodeType

string

false

none

none

» schedulerFolderId

integer(int32)¦null

false

none

none

» layoutAssignment

object¦null

false

none

none

»» additionalProperties

[RESTAPI.v1.DTOs.PairDTO2[System.Boolean,System.Boolean]](#schemarestapi.v1.dtos.pairdto2[system.boolean,system.boolean])

false

none

none

»»» first

boolean

false

none

none

»»» second

boolean

false

none

none

» expiryType

string

false

none

none

» screenshotType

string¦null

false

none

none

» useVaricentLogo

boolean¦null

false

none

none

» expiryDateTime

string(date-time)¦null

false

none

none

» expiryTimeLength

integer(int64)¦null

false

none

none

» expiryPathID

integer(int32)¦null

false

none

none

» sendNotification

boolean¦null

false

none

none

» inquiryStatus

string¦null

false

none

none

» alertType

string¦null

false

none

none

» subject

string¦null

false

none

none

» body

string¦null

false

none

none

» externalEmails

[Varicent.RESTAPI.v1.DTOs.ExternalEmailDTO]¦null

false

none

none

»» email

string¦null

false

none

none

»» isCC

boolean

false

none

none

» autoAdjust

RESTAPI.v1.DTOs.BPM.BPMAutoAdjustNodeFieldDTO

false

none

none

»» sourceTableName

string¦null

false

none

none

»» columnMappings

array¦null

false

none

none

»»» anonymous

any

false

none

none

» isAdmin

boolean

false

none

none

» swimLaneName

string¦null

false

none

none

» version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

»» rowVersion

integer(int64)

false

none

none

» objectRestrictions

object¦null

false

none

none

»» additionalProperties

RESTAPI.v1.DTOs.BPM.BPMVisibilityEditabilityDTO

false

none

none

»»» visible

boolean

false

none

none

»»» editable

boolean

false

none

none

» workflowId

integer(int32)¦null

false

none

none

» reportId

integer(int32)¦null

false

none

none

» isAppendPdf

boolean¦null

false

none

none

» uploadedPdfName

string¦null

false

none

none

» uploadedPdf

string¦null

false

none

none

» pdfAppendOrder

string¦null

false

none

none

» isUploadedExistingPdf

boolean¦null

false

none

none

Enumerated Values

Property

Value

reviewResult

Rejected

reviewResult

Approved

reviewResult

None

nodeType

Start

nodeType

End

nodeType

Action

nodeType

Alert

nodeType

Process

nodeType

Conditional

nodeType

AutoAdjust

nodeType

GeneratePdf

nodeType

Sign

expiryType

None

expiryType

DateTime

expiryType

TimeLength

screenshotType

Unkown

screenshotType

Full

screenshotType

Preview

screenshotType

None

inquiryStatus

Entered

inquiryStatus

Investigating

inquiryStatus

Escalated

inquiryStatus

WaitingForApproval

inquiryStatus

MoreInfoRequired

inquiryStatus

Resolved

inquiryStatus

Closed

alertType

Email

alertType

InternalAndEmail

alertType

Internal

pdfAppendOrder

Unknown

pdfAppendOrder

AfterAgreement

pdfAppendOrder

BeforeAgreement

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/internal/plandocument/{id}/pendingactions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plandocument/{id}/pendingactions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plandocument/{id}/pendingactions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/internal/plandocument/{id}/pendingactions', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/internal/plandocument/{id}/pendingactions',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
[
  {
    "id": 0,
    "swimLaneId": 0,
    "name": "string",
    "description": "string",
    "order": 0,
    "paths": [
      {}
    ],
    "nodeType": "Start",
    "schedulerFolderId": 0,
    "layoutAssignment": {
      "property1": {},
      "property2": {}
    },
    "expiryType": "None",
    "screenshotType": "Unkown",
    "useVaricentLogo": true,
    "expiryDateTime": "2019-08-24T14:15:22Z",
    "expiryTimeLength": 0,
    "expiryPathID": 0,
    "sendNotification": true,
    "inquiryStatus": "Entered",
    "alertType": "Email",
    "subject": "string",
    "body": "string",
    "externalEmails": [
      {}
    ],
    "autoAdjust": {
      "sourceTableName": "string",
      "columnMappings": []
    },
    "isAdmin": true,
    "swimLaneName": "string",
    "version": {
      "rowVersion": 0
    },
    "objectRestrictions": {
      "property1": {},
      "property2": {}
    },
    "workflowId": 0,
    "reportId": 0,
    "isAppendPdf": true,
    "uploadedPdfName": "string",
    "uploadedPdf": "string",
    "pdfAppendOrder": "Unknown",
    "isUploadedExistingPdf": true
  }
]
[{"id":0,"swimLaneId":0,"name":"string","description":"string","order":0,"paths":[{}],"nodeType":"Start","schedulerFolderId":0,"layoutAssignment":{"property1":{},"property2":{}},"expiryType":"None","screenshotType":"Unkown","useVaricentLogo":true,"expiryDateTime":"2019-08-24T14:15:22Z","expiryTimeLength":0,"expiryPathID":0,"sendNotification":true,"inquiryStatus":"Entered","alertType":"Email","subject":"string","body":"string","externalEmails":[{}],"autoAdjust":{"sourceTableName":"string","columnMappings":[]},"isAdmin":true,"swimLaneName":"string","version":{"rowVersion":0},"objectRestrictions":{"property1":{},"property2":{}},"workflowId":0,"reportId":0,"isAppendPdf":true,"uploadedPdfName":"string","uploadedPdf":"string","pdfAppendOrder":"Unknown","isUploadedExistingPdf":true}]

Publish plan documents for mass download.

Body parameter

{
  "planDocumentId": 0,
  "payeeWorkflowStatus": "InProgress"
}

Parameters

Name

In

Type

Required

Description

body

body

RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentMassDownloadDTO

false

none

» planDocumentId

body

integer(int32)

false

none

» payeeWorkflowStatus

body

string

false

none

Enumerated Values

Parameter

Value

» payeeWorkflowStatus

InProgress

» payeeWorkflowStatus

Complete

» payeeWorkflowStatus

Cancelled

Responses

Status

Meaning

Description

Schema

201

Created

Publish plan documents for mass download.

Inline

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/internal/plandocument/publish-plan-documents", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plandocument/publish-plan-documents");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "planDocumentId": 0,
  "payeeWorkflowStatus": "InProgress"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plandocument/publish-plan-documents',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/internal/plandocument/publish-plan-documents', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/internal/plandocument/publish-plan-documents',
  params: {
  }, headers: headers

p JSON.parse(result)

Get the summary of the last download for the plan document.

Parameters

Name

In

Type

Required

Description

id

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentDownloadSummaryDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/internal/plandocument/{id}/last-download-summary", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plandocument/{id}/last-download-summary");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plandocument/{id}/last-download-summary',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/internal/plandocument/{id}/last-download-summary', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/internal/plandocument/{id}/last-download-summary',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "planDocumentId": 0,
  "summary": {
    "InProgress": {
      "currentFilesCount": 0,
      "lastDownloadFilesCount": 0,
      "lastDownloadAt": "2019-08-24T14:15:22Z",
      "lastDownloadUserId": "string"
    },
    "Complete": {
      "currentFilesCount": 0,
      "lastDownloadFilesCount": 0,
      "lastDownloadAt": "2019-08-24T14:15:22Z",
      "lastDownloadUserId": "string"
    },
    "Cancelled": {
      "currentFilesCount": 0,
      "lastDownloadFilesCount": 0,
      "lastDownloadAt": "2019-08-24T14:15:22Z",
      "lastDownloadUserId": "string"
    }
  }
}
{"planDocumentId":0,"summary":{"InProgress":{"currentFilesCount":0,"lastDownloadFilesCount":0,"lastDownloadAt":"2019-08-24T14:15:22Z","lastDownloadUserId":"string"},"Complete":{"currentFilesCount":0,"lastDownloadFilesCount":0,"lastDownloadAt":"2019-08-24T14:15:22Z","lastDownloadUserId":"string"},"Cancelled":{"currentFilesCount":0,"lastDownloadFilesCount":0,"lastDownloadAt":"2019-08-24T14:15:22Z","lastDownloadUserId":"string"}}}

Get all plan documents associated with a Payee

Parameters

Name

In

Type

Required

Description

workflowId

query

string

false

none

orderBy

query

string

false

none

offset

query

integer(int32)

false

none

limit

query

integer(int32)

false

none

actionOnMe

query

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

RESTAPI.v1.DTOs.BPM.PlanDocumentWorkflowSignsAndActionsDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/internal/plandocument/payee/allplandocuments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plandocument/payee/allplandocuments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plandocument/payee/allplandocuments',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/internal/plandocument/payee/allplandocuments', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/internal/plandocument/payee/allplandocuments',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "planDocumentWorkflowForPayee": [
    {
      "workflowID": 0,
      "planDocumentName": "string",
      "documentsCount": 0,
      "filteredDocumentsCount": 0,
      "planDocumentWorkflowForPayeeItem": []
    }
  ],
  "unsignedDocumentsCount": 0,
  "signedDocumentsCount": 0
}
{"planDocumentWorkflowForPayee":[{"workflowID":0,"planDocumentName":"string","documentsCount":0,"filteredDocumentsCount":0,"planDocumentWorkflowForPayeeItem":[]}],"unsignedDocumentsCount":0,"signedDocumentsCount":0}

Sign the plan document by the given assigned payee

Parameters

Name

In

Type

Required

Description

tokenId

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

string

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/internal/plandocument/payee/{tokenId}/pdfPayee", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plandocument/payee/{tokenId}/pdfPayee");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plandocument/payee/{tokenId}/pdfPayee',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.put('http://localhost:8080/api/internal/plandocument/payee/{tokenId}/pdfPayee', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/internal/plandocument/payee/{tokenId}/pdfPayee',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
"string"
"string"

Get latest generated/signed PDF document for the payee

Parameters

Name

In

Type

Required

Description

tokenId

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

string

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/internal/plandocument/payee/{tokenId}/pdfPayee", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plandocument/payee/{tokenId}/pdfPayee");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plandocument/payee/{tokenId}/pdfPayee',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/internal/plandocument/payee/{tokenId}/pdfPayee', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/internal/plandocument/payee/{tokenId}/pdfPayee',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
"string"
"string"

Download the completed document for the given tokenId

Parameters

Name

In

Type

Required

Description

tokenId

path

integer(int32)

true

none

payeeId

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

Varicent.RESTAPI.v1.DTOs.FileContentDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/internal/plandocument/payee/{tokenId}/download/{payeeId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/plandocument/payee/{tokenId}/download/{payeeId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/internal/plandocument/payee/{tokenId}/download/{payeeId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/internal/plandocument/payee/{tokenId}/download/{payeeId}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/internal/plandocument/payee/{tokenId}/download/{payeeId}',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "filename": "string",
  "data64": "string"
}
{"filename":"string","data64":"string"}

PlansControllerV1

PlansControllerV1_PatchEnableScale

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/plans/enableScale", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/enableScale");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/plans/enableScale',
{
  method: 'PATCH'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.patch('http://localhost:8080/api/v1/plans/enableScale')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.patch 'http://localhost:8080/api/v1/plans/enableScale',
  params: {
  }

p JSON.parse(result)

PlansControllerV1_PatchDisableScale

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "http://localhost:8080/api/v1/plans/disableScale", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/plans/disableScale");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/plans/disableScale',
{
  method: 'PATCH'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.patch('http://localhost:8080/api/v1/plans/disableScale')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.patch 'http://localhost:8080/api/v1/plans/disableScale',
  params: {
  }

p JSON.parse(result)

PublicationsControllerV2

Run Export to Cos

Body parameter

{
  "cosLocation": {
    "bucket": "string",
    "key": "string"
  },
  "cosCredentials": {
    "endpoint": "string",
    "accessKey": "string",
    "secretKey": "string",
    "sessionToken": "string",
    "taskAuthToken": "string",
    "taskAuthEndpoint": "string",
    "taskAuthExpiration": "string"
  },
  "columnMappings": [
    {
      "source": "string",
      "destination": "string",
      "type": "String"
    }
  ],
  "useCSV": true
}

Parameters

Name

In

Type

Required

Description

table

path

string

true

none

body

body

RESTAPI.v2.DTOs.Symon.CosPublishDTO

false

none

» cosLocation

body

RESTAPI.v1.DTOs.Symon.CosLocationDTO

false

none

»» bucket

body

string¦null

false

none

»» key

body

string¦null

false

none

» cosCredentials

body

RESTAPI.v1.DTOs.Composer.DataImport.CosCredentialsDTO

false

none

»» endpoint

body

string¦null

false

none

»» accessKey

body

string¦null

false

none

»» secretKey

body

string¦null

false

none

»» sessionToken

body

string¦null

false

none

»» taskAuthToken

body

string¦null

false

none

»» taskAuthEndpoint

body

string¦null

false

none

»» taskAuthExpiration

body

string¦null

false

none

» columnMappings

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»» source

body

string¦null

false

none

»» destination

body

string¦null

false

none

»» type

body

string

false

none

» useCSV

body

boolean

false

none

Enumerated Values

Parameter

Value

»» type

String

»» type

Number

»» type

Boolean

»» type

Date

Responses

Status

Meaning

Description

Schema

200

OK

Run Cos publish

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v2/rpc/publish/cos/{table}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v2/rpc/publish/cos/{table}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "cosLocation": {
    "bucket": "string",
    "key": "string"
  },
  "cosCredentials": {
    "endpoint": "string",
    "accessKey": "string",
    "secretKey": "string",
    "sessionToken": "string",
    "taskAuthToken": "string",
    "taskAuthEndpoint": "string",
    "taskAuthExpiration": "string"
  },
  "columnMappings": [
    {
      "source": "string",
      "destination": "string",
      "type": "String"
    }
  ],
  "useCSV": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v2/rpc/publish/cos/{table}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v2/rpc/publish/cos/{table}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v2/rpc/publish/cos/{table}',
  params: {
  }, headers: headers

p JSON.parse(result)

Run CustomTable Export to Cos

Body parameter

{
  "cosLocation": {
    "bucket": "string",
    "key": "string"
  },
  "cosCredentials": {
    "endpoint": "string",
    "accessKey": "string",
    "secretKey": "string",
    "sessionToken": "string",
    "taskAuthToken": "string",
    "taskAuthEndpoint": "string",
    "taskAuthExpiration": "string"
  },
  "columnMappings": [
    {
      "source": "string",
      "destination": "string",
      "type": "String"
    }
  ],
  "useCSV": true
}

Parameters

Name

In

Type

Required

Description

table

path

string

true

none

body

body

RESTAPI.v2.DTOs.Symon.CosPublishDTO

false

none

» cosLocation

body

RESTAPI.v1.DTOs.Symon.CosLocationDTO

false

none

»» bucket

body

string¦null

false

none

»» key

body

string¦null

false

none

» cosCredentials

body

RESTAPI.v1.DTOs.Composer.DataImport.CosCredentialsDTO

false

none

»» endpoint

body

string¦null

false

none

»» accessKey

body

string¦null

false

none

»» secretKey

body

string¦null

false

none

»» sessionToken

body

string¦null

false

none

»» taskAuthToken

body

string¦null

false

none

»» taskAuthEndpoint

body

string¦null

false

none

»» taskAuthExpiration

body

string¦null

false

none

» columnMappings

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»» source

body

string¦null

false

none

»» destination

body

string¦null

false

none

»» type

body

string

false

none

» useCSV

body

boolean

false

none

Enumerated Values

Parameter

Value

»» type

String

»» type

Number

»» type

Boolean

»» type

Date

Responses

Status

Meaning

Description

Schema

200

OK

Run CustomTable Cos publish

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v2/rpc/publish/cos/customtable/{table}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v2/rpc/publish/cos/customtable/{table}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "cosLocation": {
    "bucket": "string",
    "key": "string"
  },
  "cosCredentials": {
    "endpoint": "string",
    "accessKey": "string",
    "secretKey": "string",
    "sessionToken": "string",
    "taskAuthToken": "string",
    "taskAuthEndpoint": "string",
    "taskAuthExpiration": "string"
  },
  "columnMappings": [
    {
      "source": "string",
      "destination": "string",
      "type": "String"
    }
  ],
  "useCSV": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v2/rpc/publish/cos/customtable/{table}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v2/rpc/publish/cos/customtable/{table}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v2/rpc/publish/cos/customtable/{table}',
  params: {
  }, headers: headers

p JSON.parse(result)

Run DataStore Export to Cos

Body parameter

{
  "cosLocation": {
    "bucket": "string",
    "key": "string"
  },
  "cosCredentials": {
    "endpoint": "string",
    "accessKey": "string",
    "secretKey": "string",
    "sessionToken": "string",
    "taskAuthToken": "string",
    "taskAuthEndpoint": "string",
    "taskAuthExpiration": "string"
  },
  "columnMappings": [
    {
      "source": "string",
      "destination": "string",
      "type": "String"
    }
  ],
  "useCSV": true
}

Parameters

Name

In

Type

Required

Description

dataStoreId

path

integer(int32)

true

none

body

body

RESTAPI.v2.DTOs.Symon.CosPublishDTO

false

none

» cosLocation

body

RESTAPI.v1.DTOs.Symon.CosLocationDTO

false

none

»» bucket

body

string¦null

false

none

»» key

body

string¦null

false

none

» cosCredentials

body

RESTAPI.v1.DTOs.Composer.DataImport.CosCredentialsDTO

false

none

»» endpoint

body

string¦null

false

none

»» accessKey

body

string¦null

false

none

»» secretKey

body

string¦null

false

none

»» sessionToken

body

string¦null

false

none

»» taskAuthToken

body

string¦null

false

none

»» taskAuthEndpoint

body

string¦null

false

none

»» taskAuthExpiration

body

string¦null

false

none

» columnMappings

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»» source

body

string¦null

false

none

»» destination

body

string¦null

false

none

»» type

body

string

false

none

» useCSV

body

boolean

false

none

Enumerated Values

Parameter

Value

»» type

String

»» type

Number

»» type

Boolean

»» type

Date

Responses

Status

Meaning

Description

Schema

200

OK

Run DataStore Cos publish

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v2/rpc/publish/cos/datastore/{dataStoreId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v2/rpc/publish/cos/datastore/{dataStoreId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "cosLocation": {
    "bucket": "string",
    "key": "string"
  },
  "cosCredentials": {
    "endpoint": "string",
    "accessKey": "string",
    "secretKey": "string",
    "sessionToken": "string",
    "taskAuthToken": "string",
    "taskAuthEndpoint": "string",
    "taskAuthExpiration": "string"
  },
  "columnMappings": [
    {
      "source": "string",
      "destination": "string",
      "type": "String"
    }
  ],
  "useCSV": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v2/rpc/publish/cos/datastore/{dataStoreId}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v2/rpc/publish/cos/datastore/{dataStoreId}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v2/rpc/publish/cos/datastore/{dataStoreId}',
  params: {
  }, headers: headers

p JSON.parse(result)

Run Calculation Export to Cos

Body parameter

{
  "cosLocation": {
    "bucket": "string",
    "key": "string"
  },
  "cosCredentials": {
    "endpoint": "string",
    "accessKey": "string",
    "secretKey": "string",
    "sessionToken": "string",
    "taskAuthToken": "string",
    "taskAuthEndpoint": "string",
    "taskAuthExpiration": "string"
  },
  "columnMappings": [
    {
      "source": "string",
      "destination": "string",
      "type": "String"
    }
  ],
  "useCSV": true
}

Parameters

Name

In

Type

Required

Description

calculationId

path

integer(int32)

true

none

body

body

RESTAPI.v2.DTOs.Symon.CosPublishDTO

false

none

» cosLocation

body

RESTAPI.v1.DTOs.Symon.CosLocationDTO

false

none

»» bucket

body

string¦null

false

none

»» key

body

string¦null

false

none

» cosCredentials

body

RESTAPI.v1.DTOs.Composer.DataImport.CosCredentialsDTO

false

none

»» endpoint

body

string¦null

false

none

»» accessKey

body

string¦null

false

none

»» secretKey

body

string¦null

false

none

»» sessionToken

body

string¦null

false

none

»» taskAuthToken

body

string¦null

false

none

»» taskAuthEndpoint

body

string¦null

false

none

»» taskAuthExpiration

body

string¦null

false

none

» columnMappings

body

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

»» source

body

string¦null

false

none

»» destination

body

string¦null

false

none

»» type

body

string

false

none

» useCSV

body

boolean

false

none

Enumerated Values

Parameter

Value

»» type

String

»» type

Number

»» type

Boolean

»» type

Date

Responses

Status

Meaning

Description

Schema

200

OK

Run Calculation Cos publish

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v2/rpc/publish/cos/calculation/{calculationId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v2/rpc/publish/cos/calculation/{calculationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "cosLocation": {
    "bucket": "string",
    "key": "string"
  },
  "cosCredentials": {
    "endpoint": "string",
    "accessKey": "string",
    "secretKey": "string",
    "sessionToken": "string",
    "taskAuthToken": "string",
    "taskAuthEndpoint": "string",
    "taskAuthExpiration": "string"
  },
  "columnMappings": [
    {
      "source": "string",
      "destination": "string",
      "type": "String"
    }
  ],
  "useCSV": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v2/rpc/publish/cos/calculation/{calculationId}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v2/rpc/publish/cos/calculation/{calculationId}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v2/rpc/publish/cos/calculation/{calculationId}',
  params: {
  }, headers: headers

p JSON.parse(result)

PulsePlansControllerV1

Return true if the taggable can be tagged to that tag type.

Body parameter

{
  "name": "string",
  "displayName": "string",
  "columns": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "frequencyColumns": [
    "string"
  ],
  "payeeColumns": [
    "string"
  ],
  "objectType": "Undefined"
}

Parameters

Name

In

Type

Required

Description

tagType

path

integer(int32)

true

none

body

body

RESTAPI.v1.DTOs.Pulse.TaggableDTO

false

none

» name

body

string¦null

false

none

» displayName

body

string¦null

false

none

» columns

body

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

»» name

body

string¦null

false

none

»» type

body

string

false

none

»» isKey

body

boolean

false

none

»» nullable

body

boolean

false

none

»» values

body

string¦null

false

none

»» lockedPeriod

body

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

»»» start

body

string(date-time)

false

none

»»» end

body

string(date-time)

false

none

»» referencedCol

body

string¦null

false

none

»» picklistFilter

body

string¦null

false

none

»» displayName

body

string¦null

false

none

»» isELTPeriod

body

boolean¦null

false

none

» frequencyColumns

body

[string]¦null

false

none

» payeeColumns

body

[string]¦null

false

none

» objectType

body

string

false

none

Enumerated Values

Parameter

Value

»» type

String

»» type

LongString

»» type

MaxString

»» type

Date

»» type

DateTime

»» type

Decimal

»» type

Int

»» type

Long

»» type

Float

»» type

BLOB

»» type

Identity

»» type

CLOB

»» type

RowVersion

»» type

UID

»» type

VarCharMax

»» type

Boolean

» objectType

Undefined

» objectType

Calculation

» objectType

Table

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/pulsetaggable/{tagType}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/pulsetaggable/{tagType}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "name": "string",
  "displayName": "string",
  "columns": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "frequencyColumns": [
    "string"
  ],
  "payeeColumns": [
    "string"
  ],
  "objectType": "Undefined"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/v1/pulsetaggable/{tagType}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.put('http://localhost:8080/api/v1/pulsetaggable/{tagType}', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.put 'http://localhost:8080/api/v1/pulsetaggable/{tagType}',
  params: {
  }, headers: headers

p JSON.parse(result)

ReplicationControllerV1

Initialize replication schema and publication

Body parameter

{
  "tenantSecretArn": "string",
  "proxyName": "string"
}

Parameters

Name

In

Type

Required

Description

replicationSystemVersion

query

string

false

none

includeSyncBack

query

boolean

false

none

body

body

RESTAPI.v1.DTOs.Replication.ChangeReplicationDTO

false

none

» tenantSecretArn

body

string¦null

false

none

» proxyName

body

string¦null

false

none

Enumerated Values

Parameter

Value

replicationSystemVersion

ROW_TRIGGER

replicationSystemVersion

STATEMENT_TRIGGER

Responses

Status

Meaning

Description

Schema

202

Accepted

Replication schema initialization triggered

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/internal/rpc/replication", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/rpc/replication");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "tenantSecretArn": "string",
  "proxyName": "string"
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/internal/rpc/replication',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/internal/rpc/replication', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/internal/rpc/replication',
  params: {
  }, headers: headers

p JSON.parse(result)

SlackControllerV2

Endpoint for Slack interactions

Body parameter

{
  "payload": null
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.Domain.Slack.InteractionObject

false

none

» payload

body

any

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Endpoint for Slack interactions

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/internal/slack/gateway/interaction", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/slack/gateway/interaction");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "payload": null
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/internal/slack/gateway/interaction',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/internal/slack/gateway/interaction', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/internal/slack/gateway/interaction',
  params: {
  }, headers: headers

p JSON.parse(result)

Endpoint for Slack to fetch external data

Body parameter

{
  "payload": null
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.Domain.Slack.InteractionObject

false

none

» payload

body

any

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Endpoint for Slack to fetch external data

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/internal/slack/gateway/external_data", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/slack/gateway/external_data");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "payload": null
}';
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:8080/api/internal/slack/gateway/external_data',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('http://localhost:8080/api/internal/slack/gateway/external_data', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/internal/slack/gateway/external_data',
  params: {
  }, headers: headers

p JSON.parse(result)

Endpoint used for Payee Registration by the Slack Gateway

Parameters

Name

In

Type

Required

Description

registrationId

path

string

true

none

viewId

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Endpoint used for Payee Registration by the Slack Gateway

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/internal/slack/gateway/payee/registration/{registrationId}/view/{viewId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/slack/gateway/payee/registration/{registrationId}/view/{viewId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/internal/slack/gateway/payee/registration/{registrationId}/view/{viewId}',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/internal/slack/gateway/payee/registration/{registrationId}/view/{viewId}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/internal/slack/gateway/payee/registration/{registrationId}/view/{viewId}',
  params: {
  }

p JSON.parse(result)

Endpoint used for cleaning previous message and posting greeting message when new account registered, account switched, or account deleted

Parameters

Name

In

Type

Required

Description

registrationId

path

string

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Endpoint used for cleaning previous message and posting greeting message when new account registered, account switched, or account deleted

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/internal/slack/gateway/payee/registration/{registrationId}/new", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/slack/gateway/payee/registration/{registrationId}/new");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/internal/slack/gateway/payee/registration/{registrationId}/new',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/internal/slack/gateway/payee/registration/{registrationId}/new')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/internal/slack/gateway/payee/registration/{registrationId}/new',
  params: {
  }

p JSON.parse(result)

Endpoint used for cleaning previous message

Responses

Status

Meaning

Description

Schema

200

OK

Endpoint used for cleaning previous message

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/internal/slack/gateway/payee/registration/clean", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/internal/slack/gateway/payee/registration/clean");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/internal/slack/gateway/payee/registration/clean',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/internal/slack/gateway/payee/registration/clean')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/internal/slack/gateway/payee/registration/clean',
  params: {
  }

p JSON.parse(result)

UpgraderApiControllerV1

Resave all the webreports in a model to force the xml to recompile

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/upgraderapi/presenterflex/all/generatethumbnails", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/upgraderapi/presenterflex/all/generatethumbnails");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/upgraderapi/presenterflex/all/generatethumbnails',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.post('http://localhost:8080/api/v1/upgraderapi/presenterflex/all/generatethumbnails')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.post 'http://localhost:8080/api/v1/upgraderapi/presenterflex/all/generatethumbnails',
  params: {
  }

p JSON.parse(result)

UpgraderApiControllerV1_ConvertAllPresenterFlexConstraintCaseSensitivity

Parameters

Name

In

Type

Required

Description

caseSensitive

query

boolean

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "http://localhost:8080/api/v1/upgraderapi/presenterflex/all/convertcasesensitivity", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/upgraderapi/presenterflex/all/convertcasesensitivity");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/upgraderapi/presenterflex/all/convertcasesensitivity',
{
  method: 'PUT'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.put('http://localhost:8080/api/v1/upgraderapi/presenterflex/all/convertcasesensitivity')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.put 'http://localhost:8080/api/v1/upgraderapi/presenterflex/all/convertcasesensitivity',
  params: {
  }

p JSON.parse(result)

Version

Version_Get

Responses

Status

Meaning

Description

Schema

200

OK

Success

string

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/version", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/version");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/version',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/version', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/version',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
"string"
"string"

WatsonAssistantControllerV1

WatsonAssistantControllerV1_AdminQuestion

Body parameter

{
  "messageJson": "string",
  "messageText": "string",
  "sessionContext": "string",
  "messageContext": "string",
  "history": []
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.WatsonAssistantQuestionDTO

false

none

» messageJson

body

string¦null

false

none

» messageText

body

string¦null

false

none

» sessionContext

body

string¦null

false

none

» messageContext

body

string¦null

false

none

» history

body

array¦null

false

none

»» anonymous

body

any

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Ask Assistant an admin question

Varicent.RESTAPI.v1.DTOs.WatsonAssistantQuestionDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/watsonassistant/admin/question", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/watsonassistant/admin/question");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "messageJson": "string",
  "messageText": "string",
  "sessionContext": "string",
  "messageContext": "string",
  "history": []
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/watsonassistant/admin/question',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/watsonassistant/admin/question', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/watsonassistant/admin/question',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "messageJson": "string",
  "messageText": "string",
  "sessionContext": "string",
  "messageContext": "string",
  "history": []
}
{"messageJson":"string","messageText":"string","sessionContext":"string","messageContext":"string","history":[]}

WatsonAssistantControllerV1_PayeeQuestion

Body parameter

{
  "messageJson": "string",
  "messageText": "string",
  "sessionContext": "string",
  "messageContext": "string",
  "history": []
}

Parameters

Name

In

Type

Required

Description

body

body

Varicent.RESTAPI.v1.DTOs.WatsonAssistantQuestionDTO

false

none

» messageJson

body

string¦null

false

none

» messageText

body

string¦null

false

none

» sessionContext

body

string¦null

false

none

» messageContext

body

string¦null

false

none

» history

body

array¦null

false

none

»» anonymous

body

any

false

none

Responses

Status

Meaning

Description

Schema

200

OK

Ask Assistant a question

Varicent.RESTAPI.v1.DTOs.WatsonAssistantQuestionDTO

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "http://localhost:8080/api/v1/watsonassistant/question", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/watsonassistant/question");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const inputBody = '{
  "messageJson": "string",
  "messageText": "string",
  "sessionContext": "string",
  "messageContext": "string",
  "history": []
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/watsonassistant/question',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('http://localhost:8080/api/v1/watsonassistant/question', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'http://localhost:8080/api/v1/watsonassistant/question',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
{
  "messageJson": "string",
  "messageText": "string",
  "sessionContext": "string",
  "messageContext": "string",
  "history": []
}
{"messageJson":"string","messageText":"string","sessionContext":"string","messageContext":"string","history":[]}

WatsonAssistantControllerV1_GetCustomName

Responses

Status

Meaning

Description

Schema

200

OK

Get Custom Name

string

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/watsonassistant/customName", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/watsonassistant/customName");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:8080/api/v1/watsonassistant/customName',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:8080/api/v1/watsonassistant/customName', headers = headers)

print(r.json())
Request
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'http://localhost:8080/api/v1/watsonassistant/customName',
  params: {
  }, headers: headers

p JSON.parse(result)
Response
json
"string"
"string"

WebTabsControllerV1

WebTabsControllerV1_GetReportObjectId

Parameters

Name

In

Type

Required

Description

objectId

path

integer(int32)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

Success

None

This operation does not require authentication

Request
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "http://localhost:8080/api/v1/payee/directlink/{objectId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
Request
URL obj = new URL("http://localhost:8080/api/v1/payee/directlink/{objectId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Request
fetch('http://localhost:8080/api/v1/payee/directlink/{objectId}',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
Request
import requests

r = requests.get('http://localhost:8080/api/v1/payee/directlink/{objectId}')

print(r.json())
Request
require 'rest-client'
require 'json'

result = RestClient.get 'http://localhost:8080/api/v1/payee/directlink/{objectId}',
  params: {
  }

p JSON.parse(result)

Schemas

RESTAPI.v1.DTOs.Administration.EffectiveDateConvertPropertiesDTO

Properties

Name

Type

Required

Restrictions

Description

tableName

string¦null

false

none

none

startCol

string¦null

false

none

none

endCol

string¦null

false

none

none

removeMapped

boolean

false

none

none

json
{
  "tableName": "string",
  "startCol": "string",
  "endCol": "string",
  "removeMapped": true
}

RESTAPI.v1.DTOs.Administration.PurgeHistoryDTO

Properties

Name

Type

Required

Restrictions

Description

tables

[string]¦null

false

none

none

endDate

string(date-time)¦null

false

none

none

json
{
  "tables": [
    "string"
  ],
  "endDate": "2019-08-24T14:15:22Z"
}

RESTAPI.v1.DTOs.Administration.PurgePeriodsDTO

Properties

Name

Type

Required

Restrictions

Description

timeID

string¦null

false

none

none

period

string¦null

false

none

none

mode

string

false

none

none

includeDownstream

boolean

false

none

none

selectedTables

[string]¦null

false

none

none

selectedCalculations

[integer]¦null

false

none

none

Enumerated Values

Property

Value

mode

CalcOnly

mode

TableOnly

mode

CalcAndTable

mode

SelectedTables

mode

SelectedCalculations

json
{
  "timeID": "string",
  "period": "string",
  "mode": "CalcOnly",
  "includeDownstream": true,
  "selectedTables": [
    "string"
  ],
  "selectedCalculations": [
    0
  ]
}

RESTAPI.v1.DTOs.BPM.BPMAutoAdjustComponentMappingDTO

Properties

Name

Type

Required

Restrictions

Description

nodeID

integer(int32)

false

none

none

nodeName

string¦null

false

none

none

tableName

string¦null

false

none

none

columnName

string¦null

false

none

none

dataType

string¦null

false

none

none

isPrimaryKey

boolean

false

none

none

json
{
  "nodeID": 0,
  "nodeName": "string",
  "tableName": "string",
  "columnName": "string",
  "dataType": "string",
  "isPrimaryKey": true
}

RESTAPI.v1.DTOs.BPM.BPMAutoAdjustNodeFieldDTO

Properties

Name

Type

Required

Restrictions

Description

sourceTableName

string¦null

false

none

none

columnMappings

[RESTAPI.v1.DTOs.BPM.BPMAutoAdjustNodeFieldDTO+ColumnMapping]¦null

false

none

none

json
{
  "sourceTableName": "string",
  "columnMappings": []
}

RESTAPI.v1.DTOs.BPM.BPMAutoAdjustNodeFieldDTO+ColumnMapping

Properties

Name

Type

Required

Restrictions

Description

parameterName

string¦null

false

none

none

columnName

string¦null

false

none

none

isPrimaryKey

boolean

false

none

none

index

integer(int32)

false

none

none

json
{
  "parameterName": "string",
  "columnName": "string",
  "isPrimaryKey": true,
  "index": 0
}

RESTAPI.v1.DTOs.BPM.BPMComponentConfigDTO

Properties

Name

Type

Required

Restrictions

Description

pickList

RESTAPI.v1.DTOs.BPM.BPMComponentPickListDTO

false

none

none

title

RESTAPI.v1.DTOs.BPM.BPMComponentTitleDTO

false

none

none

subject

RESTAPI.v1.DTOs.BPM.BPMComponentSubjectDTO

false

none

none

description

RESTAPI.v1.DTOs.BPM.BPMComponentDescriptionDTO

false

none

none

text

RESTAPI.v1.DTOs.BPM.BPMComponentTextDTO

false

none

none

numeric

RESTAPI.v1.DTOs.BPM.BPMComponentNumericDTO

false

none

none

sourcePickList

RESTAPI.v1.DTOs.BPM.BPMComponentSourcePickListDTO RESTAPI.v1.DTOs.BPM.BPMComponentSourcePickListDTO

false

none

none

json
{
  "pickList": {
    "placeholder": "string",
    "sort": "string",
    "parameterName": "string",
    "userGenerated": true,
    "hasError": true,
    "required": true,
    "enabled": true,
    "visible": true,
    "defaultValue": "string",
    "property1": null,
    "property2": null
  },
  "title": {
    "content": "string",
    "userGenerated": true,
    "hasError": true,
    "required": true,
    "enabled": true,
    "visible": true,
    "defaultValue": "string",
    "property1": null,
    "property2": null
  },
  "subject": {
    "placeholder": "string",
    "parameterName": "string",
    "userGenerated": true,
    "hasError": true,
    "required": true,
    "enabled": true,
    "visible": true,
    "defaultValue": "string",
    "property1": null,
    "property2": null
  },
  "description": {
    "placeholder": "string",
    "parameterName": "string",
    "charLimit": 0,
    "userGenerated": true,
    "hasError": true,
    "required": true,
    "enabled": true,
    "visible": true,
    "defaultValue": "string",
    "property1": null,
    "property2": null
  },
  "text": {
    "placeholder": "string",
    "charLimit": 0,
    "content": "string",
    "parameterName": "string",
    "userGenerated": true,
    "hasError": true,
    "required": true,
    "templateList": [
      {}
    ],
    "enabled": true,
    "visible": true,
    "defaultValue": "string",
    "property1": null,
    "property2": null
  },
  "numeric": {
    "placeholder": "string",
    "charLimit": 0,
    "content": "string",
    "parameterName": "string",
    "userGenerated": true,
    "hasError": true,
    "required": true,
    "enabled": true,
    "visible": true,
    "defaultValue": 0,
    "property1": null,
    "property2": null
  },
  "sourcePickList": {
    "displayName": "string",
    "displayColumn": "string",
    "displayColumnDBType": "String",
    "idColumn": "string",
    "idColumnDBType": "String",
    "placeholder": "string",
    "sort": "string",
    "sortOrder": "Ascending",
    "parameterName": "string",
    "hasError": true,
    "required": true,
    "userGenerated": true,
    "hideIDColumn": true,
    "enabled": true,
    "visible": true,
    "defaultValue": "string",
    "property1": null,
    "property2": null
  }
}

RESTAPI.v1.DTOs.BPM.BPMComponentDTO

Properties

Name

Type

Required

Restrictions

Description

workflowID

integer(int32)

false

none

none

componentID

integer(int32)

false

none

none

name

string¦null

false

none

none

type

string

false

none

none

order

integer(int32)

false

none

none

categories

[RESTAPI.v1.DTOs.BPMInquiryCategoryDTO]¦null

false

none

none

source

RESTAPI.v1.DTOs.BPM.BPMComponentSourceDTO

false

none

none

config

RESTAPI.v1.DTOs.BPM.BPMComponentConfigDTO

false

none

none

componentMappings

[RESTAPI.v1.DTOs.BPM.BPMAutoAdjustComponentMappingDTO]¦null

false

none

none

rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

type

pickList

type

title

type

subject

type

description

type

text

type

numeric

type

sourcePickList

json
{
  "workflowID": 0,
  "componentID": 0,
  "name": "string",
  "type": "pickList",
  "order": 0,
  "categories": [
    {
      "categoryID": 0,
      "value": "string"
    }
  ],
  "source": {
    "sourceID": 0,
    "sourceReference": {
      "tableName": "string",
      "calculationID": 0,
      "dataStoreID": 0,
      "planBuilderCalculationID": "string"
    },
    "sourceFilters": {
      "filters": []
    },
    "columns": [
      {}
    ],
    "rowVersion": {
      "rowVersion": 0
    }
  },
  "config": {
    "pickList": {
      "placeholder": "string",
      "sort": "string",
      "parameterName": "string",
      "userGenerated": true,
      "hasError": true,
      "required": true,
      "enabled": true,
      "visible": true,
      "defaultValue": "string",
      "property1": null,
      "property2": null
    },
    "title": {
      "content": "string",
      "userGenerated": true,
      "hasError": true,
      "required": true,
      "enabled": true,
      "visible": true,
      "defaultValue": "string",
      "property1": null,
      "property2": null
    },
    "subject": {
      "placeholder": "string",
      "parameterName": "string",
      "userGenerated": true,
      "hasError": true,
      "required": true,
      "enabled": true,
      "visible": true,
      "defaultValue": "string",
      "property1": null,
      "property2": null
    },
    "description": {
      "placeholder": "string",
      "parameterName": "string",
      "charLimit": 0,
      "userGenerated": true,
      "hasError": true,
      "required": true,
      "enabled": true,
      "visible": true,
      "defaultValue": "string",
      "property1": null,
      "property2": null
    },
    "text": {
      "placeholder": "string",
      "charLimit": 0,
      "content": "string",
      "parameterName": "string",
      "userGenerated": true,
      "hasError": true,
      "required": true,
      "templateList": [],
      "enabled": true,
      "visible": true,
      "defaultValue": "string",
      "property1": null,
      "property2": null
    },
    "numeric": {
      "placeholder": "string",
      "charLimit": 0,
      "content": "string",
      "parameterName": "string",
      "userGenerated": true,
      "hasError": true,
      "required": true,
      "enabled": true,
      "visible": true,
      "defaultValue": 0,
      "property1": null,
      "property2": null
    },
    "sourcePickList": {
      "displayName": "string",
      "displayColumn": "string",
      "displayColumnDBType": "String",
      "idColumn": "string",
      "idColumnDBType": "String",
      "placeholder": "string",
      "sort": "string",
      "sortOrder": "Ascending",
      "parameterName": "string",
      "hasError": true,
      "required": true,
      "userGenerated": true,
      "hideIDColumn": true,
      "enabled": true,
      "visible": true,
      "defaultValue": "string",
      "property1": null,
      "property2": null
    }
  },
  "componentMappings": [
    {
      "nodeID": 0,
      "nodeName": "string",
      "tableName": "string",
      "columnName": "string",
      "dataType": "string",
      "isPrimaryKey": true
    }
  ],
  "rowVersion": {
    "rowVersion": 0
  }
}

RESTAPI.v1.DTOs.BPM.BPMComponentDTO_PatchConfig

Properties

Name

Type

Required

Restrictions

Description

workflowID

integer(int32)

false

none

none

componentID

integer(int32)

false

none

none

type

string

false

none

none

config

RESTAPI.v1.DTOs.BPM.BPMComponentConfigDTO

false

none

none

rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

type

pickList

type

title

type

subject

type

description

type

text

type

numeric

type

sourcePickList

json
{
  "workflowID": 0,
  "componentID": 0,
  "type": "pickList",
  "config": {
    "pickList": {
      "placeholder": "string",
      "sort": "string",
      "parameterName": "string",
      "userGenerated": true,
      "hasError": true,
      "required": true,
      "enabled": true,
      "visible": true,
      "defaultValue": "string",
      "property1": null,
      "property2": null
    },
    "title": {
      "content": "string",
      "userGenerated": true,
      "hasError": true,
      "required": true,
      "enabled": true,
      "visible": true,
      "defaultValue": "string",
      "property1": null,
      "property2": null
    },
    "subject": {
      "placeholder": "string",
      "parameterName": "string",
      "userGenerated": true,
      "hasError": true,
      "required": true,
      "enabled": true,
      "visible": true,
      "defaultValue": "string",
      "property1": null,
      "property2": null
    },
    "description": {
      "placeholder": "string",
      "parameterName": "string",
      "charLimit": 0,
      "userGenerated": true,
      "hasError": true,
      "required": true,
      "enabled": true,
      "visible": true,
      "defaultValue": "string",
      "property1": null,
      "property2": null
    },
    "text": {
      "placeholder": "string",
      "charLimit": 0,
      "content": "string",
      "parameterName": "string",
      "userGenerated": true,
      "hasError": true,
      "required": true,
      "templateList": [],
      "enabled": true,
      "visible": true,
      "defaultValue": "string",
      "property1": null,
      "property2": null
    },
    "numeric": {
      "placeholder": "string",
      "charLimit": 0,
      "content": "string",
      "parameterName": "string",
      "userGenerated": true,
      "hasError": true,
      "required": true,
      "enabled": true,
      "visible": true,
      "defaultValue": 0,
      "property1": null,
      "property2": null
    },
    "sourcePickList": {
      "displayName": "string",
      "displayColumn": "string",
      "displayColumnDBType": "String",
      "idColumn": "string",
      "idColumnDBType": "String",
      "placeholder": "string",
      "sort": "string",
      "sortOrder": "Ascending",
      "parameterName": "string",
      "hasError": true,
      "required": true,
      "userGenerated": true,
      "hideIDColumn": true,
      "enabled": true,
      "visible": true,
      "defaultValue": "string",
      "property1": null,
      "property2": null
    }
  },
  "rowVersion": {
    "rowVersion": 0
  }
}

RESTAPI.v1.DTOs.BPM.BPMComponentDescriptionDTO

Properties

Name

Type

Required

Restrictions

Description

additionalProperties

any

false

none

none

placeholder

string¦null

false

none

none

parameterName

string¦null

false

none

none

charLimit

integer(int32)

false

none

none

userGenerated

boolean

false

none

none

hasError

boolean

false

none

none

required

boolean

false

none

none

enabled

boolean

false

none

none

visible

boolean

false

none

none

defaultValue

string¦null

false

none

none

json
{
  "placeholder": "string",
  "parameterName": "string",
  "charLimit": 0,
  "userGenerated": true,
  "hasError": true,
  "required": true,
  "enabled": true,
  "visible": true,
  "defaultValue": "string",
  "property1": null,
  "property2": null
}

RESTAPI.v1.DTOs.BPM.BPMComponentNumericDTO

Properties

Name

Type

Required

Restrictions

Description

additionalProperties

any

false

none

none

placeholder

string¦null

false

none

none

charLimit

integer(int32)

false

none

none

content

string¦null

false

none

none

parameterName

string¦null

false

none

none

userGenerated

boolean

false

none

none

hasError

boolean

false

none

none

required

boolean

false

none

none

enabled

boolean

false

none

none

visible

boolean

false

none

none

defaultValue

integer(int32)

false

none

none

json
{
  "placeholder": "string",
  "charLimit": 0,
  "content": "string",
  "parameterName": "string",
  "userGenerated": true,
  "hasError": true,
  "required": true,
  "enabled": true,
  "visible": true,
  "defaultValue": 0,
  "property1": null,
  "property2": null
}

RESTAPI.v1.DTOs.BPM.BPMComponentPickListDTO

Properties

Name

Type

Required

Restrictions

Description

additionalProperties

any

false

none

none

placeholder

string¦null

false

none

none

sort

string¦null

false

none

none

parameterName

string¦null

false

none

none

userGenerated

boolean

false

none

none

hasError

boolean

false

none

none

required

boolean

false

none

none

enabled

boolean

false

none

none

visible

boolean

false

none

none

defaultValue

string¦null

false

none

none

json
{
  "placeholder": "string",
  "sort": "string",
  "parameterName": "string",
  "userGenerated": true,
  "hasError": true,
  "required": true,
  "enabled": true,
  "visible": true,
  "defaultValue": "string",
  "property1": null,
  "property2": null
}

RESTAPI.v1.DTOs.BPM.BPMComponentSourceColumnDTO

Properties

Name

Type

Required

Restrictions

Description

columnName

string¦null

false

none

none

json
{
  "columnName": "string"
}

RESTAPI.v1.DTOs.BPM.BPMComponentSourceDTO

Properties

Name

Type

Required

Restrictions

Description

sourceID

integer(int32)¦null

false

none

none

sourceReference

RESTAPI.v1.DTOs.BPM.BPMComponentSourceReferenceDTO

false

none

none

sourceFilters

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFiltersDTO

false

none

none

columns

[RESTAPI.v1.DTOs.BPM.BPMComponentSourceColumnDTO]¦null

false

none

none

rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "sourceID": 0,
  "sourceReference": {
    "tableName": "string",
    "calculationID": 0,
    "dataStoreID": 0,
    "planBuilderCalculationID": "string"
  },
  "sourceFilters": {
    "filters": [
      {}
    ]
  },
  "columns": [
    {
      "columnName": "string"
    }
  ],
  "rowVersion": {
    "rowVersion": 0
  }
}

RESTAPI.v1.DTOs.BPM.BPMComponentSourcePickListDTO

Properties

Name

Type

Required

Restrictions

Description

additionalProperties

any

false

none

none

displayName

string¦null

false

none

none

displayColumn

string¦null

false

none

none

displayColumnDBType

string

false

none

none

idColumn

string¦null

false

none

none

idColumnDBType

string

false

none

none

placeholder

string¦null

false

none

none

sort

string¦null

false

none

none

sortOrder

string

false

none

none

parameterName

string¦null

false

none

none

hasError

boolean

false

none

none

required

boolean

false

none

none

userGenerated

boolean

false

none

none

hideIDColumn

boolean¦null

false

none

none

enabled

boolean

false

none

none

visible

boolean

false

none

none

defaultValue

string¦null

false

none

none

Enumerated Values

Property

Value

displayColumnDBType

String

displayColumnDBType

LongString

displayColumnDBType

MaxString

displayColumnDBType

Date

displayColumnDBType

DateTime

displayColumnDBType

Decimal

displayColumnDBType

Int

displayColumnDBType

Long

displayColumnDBType

Float

displayColumnDBType

BLOB

displayColumnDBType

Identity

displayColumnDBType

CLOB

displayColumnDBType

RowVersion

displayColumnDBType

UID

displayColumnDBType

VarCharMax

displayColumnDBType

Boolean

idColumnDBType

String

idColumnDBType

LongString

idColumnDBType

MaxString

idColumnDBType

Date

idColumnDBType

DateTime

idColumnDBType

Decimal

idColumnDBType

Int

idColumnDBType

Long

idColumnDBType

Float

idColumnDBType

BLOB

idColumnDBType

Identity

idColumnDBType

CLOB

idColumnDBType

RowVersion

idColumnDBType

UID

idColumnDBType

VarCharMax

idColumnDBType

Boolean

sortOrder

Ascending

sortOrder

Descending

sortOrder

AscendingNullsFirst

sortOrder

DescendingNullsLast

json
{
  "displayName": "string",
  "displayColumn": "string",
  "displayColumnDBType": "String",
  "idColumn": "string",
  "idColumnDBType": "String",
  "placeholder": "string",
  "sort": "string",
  "sortOrder": "Ascending",
  "parameterName": "string",
  "hasError": true,
  "required": true,
  "userGenerated": true,
  "hideIDColumn": true,
  "enabled": true,
  "visible": true,
  "defaultValue": "string",
  "property1": null,
  "property2": null
}

RESTAPI.v1.DTOs.BPM.BPMComponentSourceReferenceDTO

Properties

Name

Type

Required

Restrictions

Description

tableName

string¦null

false

none

none

calculationID

integer(int32)¦null

false

none

none

dataStoreID

integer(int32)¦null

false

none

none

planBuilderCalculationID

string¦null

false

none

none

json
{
  "tableName": "string",
  "calculationID": 0,
  "dataStoreID": 0,
  "planBuilderCalculationID": "string"
}

RESTAPI.v1.DTOs.BPM.BPMComponentSubjectDTO

Properties

Name

Type

Required

Restrictions

Description

additionalProperties

any

false

none

none

placeholder

string¦null

false

none

none

parameterName

string¦null

false

none

none

userGenerated

boolean

false

none

none

hasError

boolean

false

none

none

required

boolean

false

none

none

enabled

boolean

false

none

none

visible

boolean

false

none

none

defaultValue

string¦null

false

none

none

json
{
  "placeholder": "string",
  "parameterName": "string",
  "userGenerated": true,
  "hasError": true,
  "required": true,
  "enabled": true,
  "visible": true,
  "defaultValue": "string",
  "property1": null,
  "property2": null
}

RESTAPI.v1.DTOs.BPM.BPMComponentTextDTO

Properties

Name

Type

Required

Restrictions

Description

additionalProperties

any

false

none

none

placeholder

string¦null

false

none

none

charLimit

integer(int32)

false

none

none

content

string¦null

false

none

none

parameterName

string¦null

false

none

none

userGenerated

boolean

false

none

none

hasError

boolean

false

none

none

required

boolean

false

none

none

templateList

[RESTAPI.v1.DTOs.BPM.CommentTemplateDTO]¦null

false

none

none

enabled

boolean

false

none

none

visible

boolean

false

none

none

defaultValue

string¦null

false

none

none

json
{
  "placeholder": "string",
  "charLimit": 0,
  "content": "string",
  "parameterName": "string",
  "userGenerated": true,
  "hasError": true,
  "required": true,
  "templateList": [
    {
      "value": "string"
    }
  ],
  "enabled": true,
  "visible": true,
  "defaultValue": "string",
  "property1": null,
  "property2": null
}

RESTAPI.v1.DTOs.BPM.BPMComponentTitleDTO

Properties

Name

Type

Required

Restrictions

Description

additionalProperties

any

false

none

none

content

string¦null

false

none

none

userGenerated

boolean

false

none

none

hasError

boolean

false

none

none

required

boolean

false

none

none

enabled

boolean

false

none

none

visible

boolean

false

none

none

defaultValue

string¦null

false

none

none

json
{
  "content": "string",
  "userGenerated": true,
  "hasError": true,
  "required": true,
  "enabled": true,
  "visible": true,
  "defaultValue": "string",
  "property1": null,
  "property2": null
}

RESTAPI.v1.DTOs.BPM.BPMDocumentDTO

Properties

Name

Type

Required

Restrictions

Description

documentID

integer(int32)

false

none

none

tokenID

integer(int32)

false

none

none

name

string¦null

false

none

none

type

string

false

none

none

Enumerated Values

Property

Value

type

Attachment

type

GeneratedPdf

type

SignedPdf

json
{
  "documentID": 0,
  "tokenID": 0,
  "name": "string",
  "type": "Attachment"
}

RESTAPI.v1.DTOs.BPM.BPMForcePendingActionDTO

Properties

Name

Type

Required

Restrictions

Description

tokenID

integer(int32)

false

none

none

assignee

string¦null

false

none

none

pathID

integer(int32)

false

none

none

updateReportParams

RESTAPI.v1.DTOs.BPM.BPMUpdateReportParametersDTO

false

none

none

json
{
  "tokenID": 0,
  "assignee": "string",
  "pathID": 0,
  "updateReportParams": {
    "reportID": 0,
    "parameters": {
      "property1": "string",
      "property2": "string"
    }
  }
}

RESTAPI.v1.DTOs.BPM.BPMForcePendingActionInquiryDTO

Properties

Name

Type

Required

Restrictions

Description

tokenID

integer(int32)

false

none

none

pathID

integer(int32)

false

none

none

inquiryID

integer(int32)

false

none

none

json
{
  "tokenID": 0,
  "pathID": 0,
  "inquiryID": 0
}

RESTAPI.v1.DTOs.BPM.BPMGetSelectedPayeesDTO

Properties

Name

Type

Required

Restrictions

Description

swimlaneId

integer(int32)¦null

false

none

none

queryDTO

Varicent.RESTAPI.v1.DTOs.RunQueryDefinitionDTO

false

none

none

restrictQuery

boolean

false

none

none

json
{
  "swimlaneId": 0,
  "queryDTO": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "limit": 0,
    "offset": 0,
    "timeout": 0,
    "retrieveFromDataServer": "QUERY_SQL",
    "exportFileFormat": "Excel"
  },
  "restrictQuery": true
}

RESTAPI.v1.DTOs.BPM.BPMInquiryCommentDTO

Properties

Name

Type

Required

Restrictions

Description

commentID

integer(int32)

false

none

none

author

string¦null

false

none

none

authorName

string¦null

false

none

none

admin

string¦null

false

none

none

adminName

string¦null

false

none

none

created

string(date-time)

false

none

none

text

string¦null

false

none

none

commentType

string

false

none

none

componentName

string¦null

false

none

none

prevComponentValue

string¦null

false

none

none

newComponentValue

string¦null

false

none

none

Enumerated Values

Property

Value

commentType

Comment

commentType

Action

commentType

Description

commentType

Edit

commentType

AttachmentUpload

commentType

AttachmentDelete

commentType

Assign

commentType

Status

commentType

Other

commentType

Closed

commentType

Reopened

commentType

AutoAdjustStarted

commentType

AutoAdjustSucceeded

commentType

AutoAdjustFailed

commentType

ActionRequired

json
{
  "commentID": 0,
  "author": "string",
  "authorName": "string",
  "admin": "string",
  "adminName": "string",
  "created": "2019-08-24T14:15:22Z",
  "text": "string",
  "commentType": "Comment",
  "componentName": "string",
  "prevComponentValue": "string",
  "newComponentValue": "string"
}

RESTAPI.v1.DTOs.BPM.BPMInquiryFormDTO

Properties

Name

Type

Required

Restrictions

Description

components

[RESTAPI.v1.DTOs.BPM.BPMComponentDTO]¦nullRESTAPI.v1.DTOs.BPM.BPMComponentDTO

false

none

none

rules

[RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleDTO]¦null

false

none

none

json
{
  "components": [
    {
      "workflowID": 0,
      "componentID": 0,
      "name": "string",
      "type": "pickList",
      "order": 0,
      "categories": [],
      "source": {},
      "config": {},
      "componentMappings": [],
      "rowVersion": {}
    }
  ],
  "rules": [
    {
      "id": 0,
      "ruleName": "string",
      "outcomeComponentID": 0,
      "workflowID": 0,
      "sortOrder": 0,
      "description": "string",
      "metadata": {},
      "outcome": {},
      "conditions": {},
      "rowVersion": {}
    }
  ]
}

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleConditionDTO

Properties

Name

Type

Required

Restrictions

Description

id

string¦null

false

none

none

type

string¦null

false

none

none

componentID

integer(int32)

false

none

none

operation

string¦null

false

none

none

value

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleValueDTO

false

none

none

children

[RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleConditionDTO]¦null

false

none

none

json
{
  "id": "string",
  "type": "string",
  "componentID": 0,
  "operation": "string",
  "value": {
    "text": "string",
    "numeric": "string",
    "picklistValue": "string",
    "sourceBasedId": "string",
    "rangeValue": {
      "min": null,
      "max": null
    }
  },
  "children": []
}

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

ruleName

string¦null

false

none

none

outcomeComponentID

integer(int32)

false

none

none

workflowID

integer(int32)

false

none

none

sortOrder

integer(int32)

false

none

none

description

string¦null

false

none

none

metadata

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleMetadataDTO

false

none

none

outcome

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleOutcomeDTO

false

none

none

conditions

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleConditionDTO

false

none

none

rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "id": 0,
  "ruleName": "string",
  "outcomeComponentID": 0,
  "workflowID": 0,
  "sortOrder": 0,
  "description": "string",
  "metadata": {
    "conditionComponentIDs": [
      0
    ],
    "outcomeComponentID": 0
  },
  "outcome": {
    "componentID": 0,
    "defaultValue": {
      "text": "string",
      "numeric": "string",
      "picklistValue": "string",
      "sourceBasedId": "string",
      "rangeValue": {}
    },
    "enabled": true,
    "visible": true
  },
  "conditions": {
    "id": "string",
    "type": "string",
    "componentID": 0,
    "operation": "string",
    "value": {
      "text": "string",
      "numeric": "string",
      "picklistValue": "string",
      "sourceBasedId": "string",
      "rangeValue": {}
    },
    "children": []
  },
  "rowVersion": {
    "rowVersion": 0
  }
}

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleDTO_Create

Properties

Name

Type

Required

Restrictions

Description

ruleName

string¦null

false

none

none

outcomeComponentID

integer(int32)

false

none

none

workflowID

integer(int32)

false

none

none

sortOrder

integer(int32)

false

none

none

description

string¦null

false

none

none

outcome

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleOutcomeDTO

false

none

none

conditions

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleConditionDTO

false

none

none

json
{
  "ruleName": "string",
  "outcomeComponentID": 0,
  "workflowID": 0,
  "sortOrder": 0,
  "description": "string",
  "outcome": {
    "componentID": 0,
    "defaultValue": {
      "text": "string",
      "numeric": "string",
      "picklistValue": "string",
      "sourceBasedId": "string",
      "rangeValue": {}
    },
    "enabled": true,
    "visible": true
  },
  "conditions": {
    "id": "string",
    "type": "string",
    "componentID": 0,
    "operation": "string",
    "value": {
      "text": "string",
      "numeric": "string",
      "picklistValue": "string",
      "sourceBasedId": "string",
      "rangeValue": {}
    },
    "children": []
  }
}

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleDTO_Reorder

Properties

Name

Type

Required

Restrictions

Description

workflowID

integer(int32)

false

none

none

ruleID

integer(int32)

false

none

none

sortOrder

integer(int32)

false

none

none

rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "workflowID": 0,
  "ruleID": 0,
  "sortOrder": 0,
  "rowVersion": {
    "rowVersion": 0
  }
}

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleMetadataDTO

Properties

Name

Type

Required

Restrictions

Description

conditionComponentIDs

[integer]¦null

false

none

none

outcomeComponentID

integer(int32)

false

none

none

json
{
  "conditionComponentIDs": [
    0
  ],
  "outcomeComponentID": 0
}

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleOutcomeDTO

Properties

Name

Type

Required

Restrictions

Description

componentID

integer(int32)

false

none

none

defaultValue

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleValueDTO

false

none

none

enabled

boolean¦null

false

none

none

visible

boolean¦null

false

none

none

json
{
  "componentID": 0,
  "defaultValue": {
    "text": "string",
    "numeric": "string",
    "picklistValue": "string",
    "sourceBasedId": "string",
    "rangeValue": {
      "min": null,
      "max": null
    }
  },
  "enabled": true,
  "visible": true
}

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleRangeValueDTO

Properties

Name

Type

Required

Restrictions

Description

min

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleValueDTO

false

none

none

max

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleValueDTO

false

none

none

json
{
  "min": null,
  "max": null
}

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleValueDTO

Properties

Name

Type

Required

Restrictions

Description

text

string¦null

false

none

none

numeric

string¦null

false

none

none

picklistValue

string¦null

false

none

none

sourceBasedId

string¦null

false

none

none

rangeValue

RESTAPI.v1.DTOs.BPM.BPMInquiryFormRuleRangeValueDTO

false

none

none

json
{
  "text": "string",
  "numeric": "string",
  "picklistValue": "string",
  "sourceBasedId": "string",
  "rangeValue": {
    "min": null,
    "max": null
  }
}

RESTAPI.v1.DTOs.BPM.BPMPathDTO

Properties

Name

Type

Required

Restrictions

Description

pathID

integer(int32)

false

none

none

name

string¦null

false

none

none

originNodeID

integer(int32)

false

none

none

destinationNodeID

integer(int32)¦null

false

none

none

allMember

boolean

false

none

none

allSubmit

boolean

false

none

none

saveAndSubmit

boolean

false

none

none

reviewResult

string

false

none

none

position

integer(int32)

false

none

none

condition

string¦null

false

none

none

isDefault

boolean

false

none

none

isSign

boolean

false

none

none

Enumerated Values

Property

Value

reviewResult

Rejected

reviewResult

Approved

reviewResult

None

json
{
  "pathID": 0,
  "name": "string",
  "originNodeID": 0,
  "destinationNodeID": 0,
  "allMember": true,
  "allSubmit": true,
  "saveAndSubmit": true,
  "reviewResult": "Rejected",
  "position": 0,
  "condition": "string",
  "isDefault": true,
  "isSign": true
}

RESTAPI.v1.DTOs.BPM.BPMPendingActionStatusDTO

Properties

Name

Type

Required

Restrictions

Description

tokenID

integer(int32)

false

none

none

nodeName

string¦null

false

none

none

assignee

string¦null

false

none

none

assigneeName

string¦null

false

none

none

assignedAt

string(date-time)

false

none

none

initiator

string¦null

false

none

none

initiatorName

string¦null

false

none

none

createdAt

string(date-time)

false

none

none

nodeType

string

false

none

none

paths

[RESTAPI.v1.DTOs.BPM.BPMPathDTO]¦null

false

none

none

Enumerated Values

Property

Value

nodeType

Start

nodeType

End

nodeType

Action

nodeType

Alert

nodeType

Process

nodeType

Conditional

nodeType

AutoAdjust

nodeType

GeneratePdf

nodeType

Sign

json
{
  "tokenID": 0,
  "nodeName": "string",
  "assignee": "string",
  "assigneeName": "string",
  "assignedAt": "2019-08-24T14:15:22Z",
  "initiator": "string",
  "initiatorName": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "nodeType": "Start",
  "paths": [
    {
      "pathID": 0,
      "name": "string",
      "originNodeID": 0,
      "destinationNodeID": 0,
      "allMember": true,
      "allSubmit": true,
      "saveAndSubmit": true,
      "reviewResult": "Rejected",
      "position": 0,
      "condition": "string",
      "isDefault": true,
      "isSign": true
    }
  ]
}

RESTAPI.v1.DTOs.BPM.BPMUpdateReportParametersDTO

Properties

Name

Type

Required

Restrictions

Description

reportID

integer(int32)

false

none

none

parameters

object¦null

false

none

none

» additionalProperties

string¦null

false

none

none

json
{
  "reportID": 0,
  "parameters": {
    "property1": "string",
    "property2": "string"
  }
}

RESTAPI.v1.DTOs.BPM.BPMVisibilityEditabilityDTO

Properties

Name

Type

Required

Restrictions

Description

visible

boolean

false

none

none

editable

boolean

false

none

none

json
{
  "visible": true,
  "editable": true
}

RESTAPI.v1.DTOs.BPM.CommentTemplateDTO

Properties

Name

Type

Required

Restrictions

Description

value

string¦null

false

none

none

json
{
  "value": "string"
}

RESTAPI.v1.DTOs.BPM.Errors.BPMActionNodeErrorStatusDTO

Properties

Name

Type

Required

Restrictions

Description

tokenID

integer(int32)

false

none

none

nodeName

string¦null

false

none

none

assignedAt

string(date-time)

false

none

none

initiator

string¦null

false

none

none

initiatorName

string¦null

false

none

none

createdAt

string(date-time)

false

none

none

error

string¦null

false

none

none

json
{
  "tokenID": 0,
  "nodeName": "string",
  "assignedAt": "2019-08-24T14:15:22Z",
  "initiator": "string",
  "initiatorName": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "error": "string"
}

RESTAPI.v1.DTOs.BPM.Errors.BPMAlertNodeErrorStatusDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

tokenId

integer(int32)

false

none

none

nodeId

integer(int32)

false

none

none

_nodeName

string¦null

false

none

none

initiator

string¦null

false

none

none

initiatorName

string¦null

false

none

none

date

string(date-time)

false

none

none

error

string¦null

false

none

none

json
{
  "id": 0,
  "tokenId": 0,
  "nodeId": 0,
  "_nodeName": "string",
  "initiator": "string",
  "initiatorName": "string",
  "date": "2019-08-24T14:15:22Z",
  "error": "string"
}

RESTAPI.v1.DTOs.BPM.Errors.BPMNodeHistoryStatusDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

workflowID

integer(int32)

false

none

none

nodeName

string¦null

false

none

none

initiator

string¦null

false

none

none

initiatorName

string¦null

false

none

none

actor

string¦null

false

none

none

actorName

string¦null

false

none

none

isForcedBy

string¦null

false

none

none

action

string¦null

false

none

none

dateActioned

string(date-time)

false

none

none

webReportName

string¦null

false

none

none

attachments

string¦null

false

none

none

documentID

integer(int32)

false

none

none

tokenID

string¦null

false

none

none

json
{
  "id": 0,
  "workflowID": 0,
  "nodeName": "string",
  "initiator": "string",
  "initiatorName": "string",
  "actor": "string",
  "actorName": "string",
  "isForcedBy": "string",
  "action": "string",
  "dateActioned": "2019-08-24T14:15:22Z",
  "webReportName": "string",
  "attachments": "string",
  "documentID": 0,
  "tokenID": "string"
}

RESTAPI.v1.DTOs.BPM.Errors.BPMServiceNodeErrorStatusDTO

Properties

Name

Type

Required

Restrictions

Description

node

string¦null

false

none

none

error

string¦null

false

none

none

time

string(date-time)

false

none

none

json
{
  "node": "string",
  "error": "string",
  "time": "2019-08-24T14:15:22Z"
}

RESTAPI.v1.DTOs.BPM.PlanDocumentWorkflowForPayeeDTO

Properties

Name

Type

Required

Restrictions

Description

workflowID

integer(int32)

false

none

none

planDocumentName

string¦null

false

none

none

documentsCount

integer(int32)¦null

false

none

none

filteredDocumentsCount

integer(int32)¦null

false

none

none

planDocumentWorkflowForPayeeItem

[RESTAPI.v1.DTOs.BPM.PlanDocumentWorkflowForPayeeItemDTO]¦null

false

none

none

json
{
  "workflowID": 0,
  "planDocumentName": "string",
  "documentsCount": 0,
  "filteredDocumentsCount": 0,
  "planDocumentWorkflowForPayeeItem": [
    {
      "workflowId": 0,
      "tokenId": 0,
      "ownerId": "string",
      "ownerName": "string",
      "ownerProfilePicture": "string",
      "nodeType": "Start",
      "lastModified": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "canAction": true,
      "isOwnerSigned": true,
      "planDocumentWorkflowForPayeeSignedInfo": [],
      "title": "string"
    }
  ]
}

RESTAPI.v1.DTOs.BPM.PlanDocumentWorkflowForPayeeItemDTO

Properties

Name

Type

Required

Restrictions

Description

workflowId

integer(int32)

false

none

none

tokenId

integer(int32)

false

none

none

ownerId

string¦null

false

none

none

ownerName

string¦null

false

none

none

ownerProfilePicture

string(byte)¦null

false

none

none

nodeType

string¦null

false

none

none

lastModified

string(date-time)¦null

false

none

none

createdAt

string(date-time)¦null

false

none

none

canAction

boolean¦null

false

none

none

isOwnerSigned

boolean¦null

false

none

none

planDocumentWorkflowForPayeeSignedInfo

[RESTAPI.v1.DTOs.BPM.PlanDocumentWorkflowForPayeeSignedInfoDTO]¦null

false

none

none

title

string¦null

false

none

none

Enumerated Values

Property

Value

nodeType

Start

nodeType

End

nodeType

Action

nodeType

Alert

nodeType

Process

nodeType

Conditional

nodeType

AutoAdjust

nodeType

GeneratePdf

nodeType

Sign

json
{
  "workflowId": 0,
  "tokenId": 0,
  "ownerId": "string",
  "ownerName": "string",
  "ownerProfilePicture": "string",
  "nodeType": "Start",
  "lastModified": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "canAction": true,
  "isOwnerSigned": true,
  "planDocumentWorkflowForPayeeSignedInfo": [
    {
      "signerId": "string",
      "signerName": "string",
      "signedDate": "2019-08-24T14:15:22Z"
    }
  ],
  "title": "string"
}

RESTAPI.v1.DTOs.BPM.PlanDocumentWorkflowForPayeeSignedInfoDTO

Properties

Name

Type

Required

Restrictions

Description

signerId

string¦null

false

none

none

signerName

string¦null

false

none

none

signedDate

string(date-time)¦null

false

none

none

json
{
  "signerId": "string",
  "signerName": "string",
  "signedDate": "2019-08-24T14:15:22Z"
}

RESTAPI.v1.DTOs.BPM.PlanDocumentWorkflowSignsAndActionsDTO

Properties

Name

Type

Required

Restrictions

Description

planDocumentWorkflowForPayee

[RESTAPI.v1.DTOs.BPM.PlanDocumentWorkflowForPayeeDTO]¦null

false

none

none

unsignedDocumentsCount

integer(int32)

false

none

none

signedDocumentsCount

integer(int32)

false

none

none

json
{
  "planDocumentWorkflowForPayee": [
    {
      "workflowID": 0,
      "planDocumentName": "string",
      "documentsCount": 0,
      "filteredDocumentsCount": 0,
      "planDocumentWorkflowForPayeeItem": []
    }
  ],
  "unsignedDocumentsCount": 0,
  "signedDocumentsCount": 0
}

RESTAPI.v1.DTOs.BPM.UpdateBPMColumn

Properties

Name

Type

Required

Restrictions

Description

index

integer(int32)

false

none

none

type

string

false

none

none

Enumerated Values

Property

Value

type

Remove

type

Add

json
{
  "index": 0,
  "type": "Remove"
}

RESTAPI.v1.DTOs.BPMInquiryCategoryDTO

Properties

Name

Type

Required

Restrictions

Description

categoryID

integer(int32)

false

none

none

value

string¦null

false

none

none

json
{
  "categoryID": 0,
  "value": "string"
}

RESTAPI.v1.DTOs.BPMWorkflowConfigDTO

Properties

Name

Type

Required

Restrictions

Description

pendingWorkflowEnabled

boolean

false

none

none

json
{
  "pendingWorkflowEnabled": true
}

RESTAPI.v1.DTOs.Calculations.CalculationHistoryDTO

Properties

Name

Type

Required

Restrictions

Description

revisionID

integer(int32)

false

none

none

version

integer(int32)

false

none

none

editor

string¦null

false

none

none

editAt

string(date-time)

false

none

none

name

string¦null

false

none

none

changes

[string]¦null

false

none

none

json
{
  "revisionID": 0,
  "version": 0,
  "editor": "string",
  "editAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "changes": [
    "Formula"
  ]
}

RESTAPI.v1.DTOs.ColumnMatchingsDTO

Properties

Name

Type

Required

Restrictions

Description

columns

[string]¦null

false

none

none

matched

[string]¦null

false

none

none

json
{
  "columns": [
    "string"
  ],
  "matched": [
    "string"
  ]
}

RESTAPI.v1.DTOs.ComparisonItemDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)¦null

false

none

none

name

string¦null

false

none

none

baseDuration

number(double)¦null

false

none

none

targetDuration

number(double)¦null

false

none

none

delta

number(double)¦null

false

none

none

baseMethod

string¦null

false

none

none

targetMethod

string¦null

false

none

none

planBuilderCalculationId

string¦null

false

none

none

planBuilderParentFolderName

string¦null

false

none

none

json
{
  "id": 0,
  "name": "string",
  "baseDuration": 0.1,
  "targetDuration": 0.1,
  "delta": 0.1,
  "baseMethod": "string",
  "targetMethod": "string",
  "planBuilderCalculationId": "string",
  "planBuilderParentFolderName": "string"
}

RESTAPI.v1.DTOs.Composer.ComponentPatchDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

autoArrange

boolean¦null

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "name": "string",
  "autoArrange": true,
  "version": {
    "rowVersion": 0
  }
}

RESTAPI.v1.DTOs.Composer.DataImport.CosCredentialsDTO

Properties

Name

Type

Required

Restrictions

Description

endpoint

string¦null

false

none

none

accessKey

string¦null

false

none

none

secretKey

string¦null

false

none

none

sessionToken

string¦null

false

none

none

taskAuthToken

string¦null

false

none

none

taskAuthEndpoint

string¦null

false

none

none

taskAuthExpiration

string¦null

false

none

none

json
{
  "endpoint": "string",
  "accessKey": "string",
  "secretKey": "string",
  "sessionToken": "string",
  "taskAuthToken": "string",
  "taskAuthEndpoint": "string",
  "taskAuthExpiration": "string"
}

RESTAPI.v1.DTOs.Composer.DataImport.EBCDICFieldDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

offset

integer(int32)

false

none

none

length

integer(int32)

false

none

none

dataType

string

false

none

none

Enumerated Values

Property

Value

dataType

String

dataType

Decimal

json
{
  "name": "string",
  "offset": 0,
  "length": 0,
  "dataType": "String"
}

RESTAPI.v1.DTOs.Composer.DataImport.ExcelInfoDTO

Properties

Name

Type

Required

Restrictions

Description

sheetRanges

object¦null

false

none

none

» additionalProperties

string¦null

false

none

none

json
{
  "sheetRanges": {
    "property1": "string",
    "property2": "string"
  }
}

RESTAPI.v1.DTOs.Composer.DataImport.ImportParamsDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

importType

string

false

none

none

hasHeader

boolean

false

none

none

table

string¦null

false

none

none

columnMatchings

RESTAPI.v1.DTOs.ColumnMatchingsDTO

false

none

none

dateFormat

string

false

none

none

listSubitems

[string]¦null

false

none

none

subitemMap

object¦null

false

none

none

» additionalProperties

RESTAPI.v1.DTOs.Composer.DataImport.SubitemDTO

false

none

none

addMember

boolean

false

none

none

updateExistingRows

boolean

false

none

none

tableType

string

false

none

none

isLocal

boolean

false

none

none

localCulture

System.IFormatProvider

false

none

none

useIncrementalImport

boolean

false

none

none

culture

string¦null

false

none

none

tableEffectiveDated

boolean

false

none

none

isODBCTextDriver

boolean

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

fileOverwrite

boolean

false

none

none

importId

integer(int32)

false

none

none

filename

string¦null

false

none

none

localPath

string¦null

false

none

none

username

string¦null

false

none

none

password

string¦null

false

none

none

delimiter

string

false

none

none

sheetName

string¦null

false

none

none

cellRange

string¦null

false

none

none

query

string¦null

false

none

none

queryTimeout

integer(int32)

false

none

none

connectionString

string¦null

false

none

none

useAdvanced

boolean

false

none

none

model

string¦null

false

none

none

importMethod

integer(int32)

false

none

none

sourceTableName

string¦null

false

none

none

securityToken

string¦null

false

none

none

customColumns

[string]¦null

false

none

none

userSelected

boolean

false

none

none

sandbox

boolean

false

none

none

fileLocation

string¦null

false

none

none

codePage

integer(int32)

false

none

none

ignoreFirst

boolean

false

none

none

ignoreLast

boolean

false

none

none

recordLength

integer(int32)

false

none

none

fields

[RESTAPI.v1.DTOs.Composer.DataImport.EBCDICFieldDTO]¦null

false

none

none

selectRowNode

string¦null

false

none

none

pipeConnection

Varicent.RESTAPI.v1.DTOs.Symon.PipeConnectionDTO

false

none

none

inputTable

string¦null

false

none

none

uploadStage

boolean

false

none

none

predictStage

boolean

false

none

none

downloadStage

boolean

false

none

none

symonImportType

string

false

none

none

refreshAllPipeDatasources

boolean

false

none

none

connectorID

string¦null

false

none

none

streamID

string¦null

false

none

none

importConfig

any

false

none

none

outputMapping

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

none

cosLocations

[RESTAPI.v1.DTOs.Symon.CosLocationDTO]¦null

false

none

none

cosCredentials

RESTAPI.v1.DTOs.Composer.DataImport.CosCredentialsDTO

false

none

none

Enumerated Values

Property

Value

importType

None

importType

Text

importType

Excel

importType

DBImport

importType

Salesforce

importType

MSCRM

importType

EBCDICText

importType

TerrAlign

importType

XML

importType

ODBCImport

importType

SymonImport

importType

SymonConnectorImport

importType

Cos

importType

SQLServer

importType

Dynamics

importType

GoogleSheets

importType

MySql

importType

AmazonAurora

importType

AmazonS3

importType

Snowflake

importType

Shopify

importType

Hubspot

importType

Oracle

importType

AmazonRedshift

importType

Workday

dateFormat

Default

dateFormat

DayFirst

dateFormat

MonthFirst

tableType

System

tableType

Dimension

tableType

Structural

tableType

Lookup

tableType

Data

tableType

View

tableType

Custom

tableType

StarSchema

tableType

ExportTable

tableType

CreditingRule

tableType

AssignTable

tableType

PlcmCustomTable

tableType

PlcmStructuralTable

tableType

PlcmTable

tableType

DataSource

tableType

Cached

tableType

MaterializedView

symonImportType

None

symonImportType

Text

symonImportType

Excel

symonImportType

DBImport

symonImportType

Salesforce

symonImportType

MSCRM

symonImportType

EBCDICText

symonImportType

TerrAlign

symonImportType

XML

symonImportType

ODBCImport

symonImportType

SymonImport

symonImportType

SymonConnectorImport

symonImportType

Cos

symonImportType

SQLServer

symonImportType

Dynamics

symonImportType

GoogleSheets

symonImportType

MySql

symonImportType

AmazonAurora

symonImportType

AmazonS3

symonImportType

Snowflake

symonImportType

Shopify

symonImportType

Hubspot

symonImportType

Oracle

symonImportType

AmazonRedshift

symonImportType

Workday

json
{
  "name": "string",
  "importType": "None",
  "hasHeader": true,
  "table": "string",
  "columnMatchings": {
    "columns": [
      "string"
    ],
    "matched": [
      "string"
    ]
  },
  "dateFormat": "Default",
  "listSubitems": [
    "string"
  ],
  "subitemMap": {
    "property1": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    },
    "property2": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    }
  },
  "addMember": true,
  "updateExistingRows": true,
  "tableType": "System",
  "isLocal": true,
  "localCulture": {},
  "useIncrementalImport": true,
  "culture": "string",
  "tableEffectiveDated": true,
  "isODBCTextDriver": true,
  "version": {
    "rowVersion": 0
  },
  "fileOverwrite": true,
  "importId": 0,
  "filename": "string",
  "localPath": "string",
  "username": "string",
  "password": "string",
  "delimiter": "string",
  "sheetName": "string",
  "cellRange": "string",
  "query": "string",
  "queryTimeout": 0,
  "connectionString": "string",
  "useAdvanced": true,
  "model": "string",
  "importMethod": 0,
  "sourceTableName": "string",
  "securityToken": "string",
  "customColumns": [
    "string"
  ],
  "userSelected": true,
  "sandbox": true,
  "fileLocation": "string",
  "codePage": 0,
  "ignoreFirst": true,
  "ignoreLast": true,
  "recordLength": 0,
  "fields": [
    {
      "name": "string",
      "offset": 0,
      "length": 0,
      "dataType": "String"
    }
  ],
  "selectRowNode": "string",
  "pipeConnection": {
    "pipeID": "string",
    "inputID": "string",
    "outputID": "string",
    "outputName": "string",
    "lastValidated": "2019-08-24T14:15:22Z",
    "inputMapping": [
      {}
    ],
    "outputMapping": [
      {}
    ]
  },
  "inputTable": "string",
  "uploadStage": true,
  "predictStage": true,
  "downloadStage": true,
  "symonImportType": "None",
  "refreshAllPipeDatasources": true,
  "connectorID": "string",
  "streamID": "string",
  "importConfig": null,
  "outputMapping": [
    {
      "source": "string",
      "destination": "string",
      "type": "String"
    }
  ],
  "cosLocations": [
    {
      "bucket": "string",
      "key": "string"
    }
  ],
  "cosCredentials": {
    "endpoint": "string",
    "accessKey": "string",
    "secretKey": "string",
    "sessionToken": "string",
    "taskAuthToken": "string",
    "taskAuthEndpoint": "string",
    "taskAuthExpiration": "string"
  }
}

RESTAPI.v1.DTOs.Composer.DataImport.ImportPreviewDTO

Properties

Name

Type

Required

Restrictions

Description

importParams

RESTAPI.v1.DTOs.Composer.DataImport.ImportParamsDTO

false

none

none

numLines

integer(int32)

false

none

none

json
{
  "importParams": {
    "name": "string",
    "importType": "None",
    "hasHeader": true,
    "table": "string",
    "columnMatchings": {
      "columns": [],
      "matched": []
    },
    "dateFormat": "Default",
    "listSubitems": [
      "string"
    ],
    "subitemMap": {
      "property1": {},
      "property2": {}
    },
    "addMember": true,
    "updateExistingRows": true,
    "tableType": "System",
    "isLocal": true,
    "localCulture": {},
    "useIncrementalImport": true,
    "culture": "string",
    "tableEffectiveDated": true,
    "isODBCTextDriver": true,
    "version": {
      "rowVersion": 0
    },
    "fileOverwrite": true,
    "importId": 0,
    "filename": "string",
    "localPath": "string",
    "username": "string",
    "password": "string",
    "delimiter": "string",
    "sheetName": "string",
    "cellRange": "string",
    "query": "string",
    "queryTimeout": 0,
    "connectionString": "string",
    "useAdvanced": true,
    "model": "string",
    "importMethod": 0,
    "sourceTableName": "string",
    "securityToken": "string",
    "customColumns": [
      "string"
    ],
    "userSelected": true,
    "sandbox": true,
    "fileLocation": "string",
    "codePage": 0,
    "ignoreFirst": true,
    "ignoreLast": true,
    "recordLength": 0,
    "fields": [
      {}
    ],
    "selectRowNode": "string",
    "pipeConnection": {
      "pipeID": "string",
      "inputID": "string",
      "outputID": "string",
      "outputName": "string",
      "lastValidated": "2019-08-24T14:15:22Z",
      "inputMapping": [],
      "outputMapping": []
    },
    "inputTable": "string",
    "uploadStage": true,
    "predictStage": true,
    "downloadStage": true,
    "symonImportType": "None",
    "refreshAllPipeDatasources": true,
    "connectorID": "string",
    "streamID": "string",
    "importConfig": null,
    "outputMapping": [
      {}
    ],
    "cosLocations": [
      {}
    ],
    "cosCredentials": {
      "endpoint": "string",
      "accessKey": "string",
      "secretKey": "string",
      "sessionToken": "string",
      "taskAuthToken": "string",
      "taskAuthEndpoint": "string",
      "taskAuthExpiration": "string"
    }
  },
  "numLines": 0
}

RESTAPI.v1.DTOs.Composer.DataImport.SalesforceColumnSchemaDTO

Properties

Name

Type

Required

Restrictions

Description

field

Salesforce.partner.Field

false

none

none

json
{
  "field": {
    "aggregatable": true,
    "aiPredictionField": true,
    "autoNumber": true,
    "byteLength": 0,
    "calculated": true,
    "calculatedFormula": "string",
    "cascadeDelete": true,
    "cascadeDeleteSpecified": true,
    "caseSensitive": true,
    "compoundFieldName": "string",
    "controllerName": "string",
    "createable": true,
    "custom": true,
    "dataTranslationEnabled": true,
    "dataTranslationEnabledSpecified": true,
    "defaultValue": null,
    "defaultValueFormula": "string",
    "defaultedOnCreate": true,
    "dependentPicklist": true,
    "dependentPicklistSpecified": true,
    "deprecatedAndHidden": true,
    "digits": 0,
    "displayLocationInDecimal": true,
    "displayLocationInDecimalSpecified": true,
    "encrypted": true,
    "encryptedSpecified": true,
    "externalId": true,
    "externalIdSpecified": true,
    "extraTypeInfo": "string",
    "filterable": true,
    "filteredLookupInfo": {
      "controllingFields": [],
      "dependent": true,
      "optionalFilter": true
    },
    "formulaTreatNullNumberAsZero": true,
    "formulaTreatNullNumberAsZeroSpecified": true,
    "groupable": true,
    "highScaleNumber": true,
    "highScaleNumberSpecified": true,
    "htmlFormatted": true,
    "htmlFormattedSpecified": true,
    "idLookup": true,
    "inlineHelpText": "string",
    "label": "string",
    "length": 0,
    "mask": "string",
    "maskType": "string",
    "name": "string",
    "nameField": true,
    "namePointing": true,
    "namePointingSpecified": true,
    "nillable": true,
    "permissionable": true,
    "picklistValues": [
      {}
    ],
    "polymorphicForeignKey": true,
    "precision": 0,
    "queryByDistance": true,
    "referenceTargetField": "string",
    "referenceTo": [
      "string"
    ],
    "relationshipName": "string",
    "relationshipOrder": 0,
    "relationshipOrderSpecified": true,
    "restrictedDelete": true,
    "restrictedDeleteSpecified": true,
    "restrictedPicklist": true,
    "scale": 0,
    "searchPrefilterable": true,
    "soapType": "tnsID",
    "sortable": true,
    "sortableSpecified": true,
    "type": "string",
    "unique": true,
    "updateable": true,
    "writeRequiresMasterRead": true,
    "writeRequiresMasterReadSpecified": true
  }
}

RESTAPI.v1.DTOs.Composer.DataImport.SalesforceConfigDTO

Properties

Name

Type

Required

Restrictions

Description

username

string¦null

false

none

none

password

string¦null

false

none

none

token

string¦null

false

none

none

sandbox

boolean

false

none

none

json
{
  "username": "string",
  "password": "string",
  "token": "string",
  "sandbox": true
}

RESTAPI.v1.DTOs.Composer.DataImport.SalesforceTableSchemaDTO

Properties

Name

Type

Required

Restrictions

Description

dsr

Salesforce.partner.DescribeSObjectResult

false

none

none

columns

object¦null

false

none

none

» additionalProperties

RESTAPI.v1.DTOs.Composer.DataImport.SalesforceColumnSchemaDTO

false

none

none

json
{
  "dsr": {
    "actionOverrides": [
      {}
    ],
    "activateable": true,
    "childRelationships": [
      {}
    ],
    "compactLayoutable": true,
    "createable": true,
    "custom": true,
    "customSetting": true,
    "dataTranslationEnabled": true,
    "dataTranslationEnabledSpecified": true,
    "deepCloneable": true,
    "defaultImplementation": "string",
    "deletable": true,
    "deprecatedAndHidden": true,
    "feedEnabled": true,
    "fields": [
      {}
    ],
    "hasSubtypes": true,
    "idEnabled": true,
    "implementedBy": "string",
    "implementsInterfaces": "string",
    "isInterface": true,
    "isSubtype": true,
    "keyPrefix": "string",
    "label": "string",
    "labelPlural": "string",
    "layoutable": true,
    "mergeable": true,
    "mruEnabled": true,
    "name": "string",
    "namedLayoutInfos": [
      {}
    ],
    "networkScopeFieldName": "string",
    "queryable": true,
    "recordTypeInfos": [
      {}
    ],
    "replicateable": true,
    "retrieveable": true,
    "searchLayoutable": true,
    "searchLayoutableSpecified": true,
    "searchable": true,
    "supportedScopes": [
      {}
    ],
    "triggerable": true,
    "triggerableSpecified": true,
    "undeletable": true,
    "updateable": true,
    "urlDetail": "string",
    "urlEdit": "string",
    "urlNew": "string"
  },
  "columns": {
    "property1": {
      "field": {}
    },
    "property2": {
      "field": {}
    }
  }
}

RESTAPI.v1.DTOs.Composer.DataImport.SubitemDTO

Properties

Name

Type

Required

Restrictions

Description

name

[string]¦null

false

none

none

fieldName

[string]¦null

false

none

none

type

string

false

none

none

delimiter

string¦null

false

none

none

segment

integer(int32)

false

none

none

selection

[string]¦null

false

none

none

fieldIndices

[integer]¦null

false

none

none

Enumerated Values

Property

Value

type

Delimited

type

Selection

type

Merged

json
{
  "name": [
    "string"
  ],
  "fieldName": [
    "string"
  ],
  "type": "Delimited",
  "delimiter": "string",
  "segment": 0,
  "selection": [
    "string"
  ],
  "fieldIndices": [
    0
  ]
}

RESTAPI.v1.DTOs.Composer.ElementPasteDTO

Properties

Name

Type

Required

Restrictions

Description

elementIDs

[integer]¦null

false

none

none

currentBlockID

integer(int32)

false

none

none

targetBlockID

integer(int32)

false

none

none

location

System.Drawing.PointF

false

none

none

suffix

string¦null

false

none

none

sourceMapping

[array]¦null

false

none

none

json
{
  "elementIDs": [
    0
  ],
  "currentBlockID": 0,
  "targetBlockID": 0,
  "location": {
    "isEmpty": true,
    "x": 0.1,
    "y": 0.1
  },
  "suffix": "string",
  "sourceMapping": [
    [
      "string"
    ]
  ]
}

RESTAPI.v1.DTOs.Composer.ElementPasteSourceDTO

Properties

Name

Type

Required

Restrictions

Description

elementID

integer(int32)

false

none

none

source

string¦null

false

none

none

outputTable

string¦null

false

none

none

json
{
  "elementID": 0,
  "source": "string",
  "outputTable": "string"
}

RESTAPI.v1.DTOs.Composer.ElementUnwrapDTO

Properties

Name

Type

Required

Restrictions

Description

blockIDs

[integer]¦null

false

none

none

parentBlockID

integer(int32)

false

none

none

location

System.Drawing.PointF

false

none

none

json
{
  "blockIDs": [
    0
  ],
  "parentBlockID": 0,
  "location": {
    "isEmpty": true,
    "x": 0.1,
    "y": 0.1
  }
}

RESTAPI.v1.DTOs.Composer.ElementWrapDTO

Properties

Name

Type

Required

Restrictions

Description

newBlockName

string¦null

false

none

none

elementIDs

[integer]¦null

false

none

none

parentBlockID

integer(int32)

false

none

none

location

System.Drawing.PointF

false

none

none

elementSubType

string

false

none

none

Enumerated Values

Property

Value

elementSubType

None

elementSubType

InsertionPoint

elementSubType

Waypoint

json
{
  "newBlockName": "string",
  "elementIDs": [
    0
  ],
  "parentBlockID": 0,
  "location": {
    "isEmpty": true,
    "x": 0.1,
    "y": 0.1
  },
  "elementSubType": "None"
}

RESTAPI.v1.DTOs.Composer.ResponseCsvDTO

Properties

Name

Type

Required

Restrictions

Description

content

string¦null

false

none

none

sheetName

string¦null

false

none

none

json
{
  "content": "string",
  "sheetName": "string"
}

RESTAPI.v1.DTOs.Composer.SalesforceTableNameDTO

Properties

Name

Type

Required

Restrictions

Description

filename

string¦null

false

none

none

json
{
  "filename": "string"
}

RESTAPI.v1.DTOs.Composer.TransferToCsvDTO

Properties

Name

Type

Required

Restrictions

Description

fileName

string¦null

false

none

none

data64

string¦null

false

none

none

json
{
  "fileName": "string",
  "data64": "string"
}

RESTAPI.v1.DTOs.Composer.TransferToExcelDTO

Properties

Name

Type

Required

Restrictions

Description

categoryName

string¦null

false

none

none

categoryRestriction

string¦null

false

none

none

json
{
  "categoryName": "string",
  "categoryRestriction": "string"
}

RESTAPI.v1.DTOs.Composer.WebDataEditPermissionDTO

Properties

Name

Type

Required

Restrictions

Description

column

string¦null

false

none

none

payeeID

string¦null

false

none

none

isEnabled

boolean

false

none

none

json
{
  "column": "string",
  "payeeID": "string",
  "isEnabled": true
}

RESTAPI.v1.DTOs.Composer.WebDataEditRestrictionsDTO

Properties

Name

Type

Required

Restrictions

Description

source

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

tableSchema

Varicent.RESTAPI.v1.DTOs.FullTableSchemaDTO Varicent.RESTAPI.v1.DTOs.FullTableSchemaDTO

false

none

none

json
{
  "source": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "tableSchema": {
    "columns": [
      {}
    ],
    "table": "string",
    "name": "string",
    "referencedSources": [
      "string"
    ],
    "referencedTimes": [
      {}
    ],
    "referencedSourcesDictionary": {
      "property1": "string",
      "property2": "string"
    },
    "referencedTimesDictionary": {
      "property1": {},
      "property2": {}
    }
  }
}

RESTAPI.v1.DTOs.ConfigValueDTO

Properties

Name

Type

Required

Restrictions

Description

key

string¦null

false

none

none

value

any

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "key": "string",
  "value": null,
  "version": {
    "rowVersion": 0
  }
}

RESTAPI.v1.DTOs.DDE.DDENameDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

json
{
  "name": "string"
}

RESTAPI.v1.DTOs.DDE.DDEReportContextDTO

Properties

Name

Type

Required

Restrictions

Description

specification

any

false

none

none

sessionCode

string¦null

false

none

none

ddeAPIURL

string¦null

false

none

none

json
{
  "specification": null,
  "sessionCode": "string",
  "ddeAPIURL": "string"
}

RESTAPI.v1.DTOs.DDE.DDEReportDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

name

string¦null

false

none

none

specification

any

false

none

none

author

string¦null

false

none

none

isAdmin

boolean

false

none

none

sources

[RESTAPI.v1.DTOs.DDE.DDESourceDTO]¦null

false

none

none

workflowObjectID

integer(int32)

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "id": 0,
  "name": "string",
  "specification": null,
  "author": "string",
  "isAdmin": true,
  "sources": [
    {
      "sourceName": "string",
      "reportID": 0,
      "sourceFilter": 0,
      "payeeFilterColumnMapping": "string",
      "hierarchyID": 0,
      "periodFilterColumnMapping": "string"
    }
  ],
  "workflowObjectID": 0,
  "version": {
    "rowVersion": 0
  }
}

RESTAPI.v1.DTOs.DDE.DDESessionDTO

Properties

Name

Type

Required

Restrictions

Description

userID

string¦null

false

none

none

sessionID

string¦null

false

none

none

sessionCode

string¦null

false

none

none

isAdmin

boolean

false

none

none

expiryTime

string(date-time)

false

none

none

ddeAPIURL

string¦null

false

none

none

json
{
  "userID": "string",
  "sessionID": "string",
  "sessionCode": "string",
  "isAdmin": true,
  "expiryTime": "2019-08-24T14:15:22Z",
  "ddeAPIURL": "string"
}

RESTAPI.v1.DTOs.DDE.DDESourceDTO

Properties

Name

Type

Required

Restrictions

Description

sourceName

string¦null

false

none

none

reportID

integer(int32)

false

none

none

sourceFilter

integer(int32)

false

none

none

payeeFilterColumnMapping

string¦null

false

none

none

hierarchyID

integer(int32)

false

none

none

periodFilterColumnMapping

string¦null

false

none

none

json
{
  "sourceName": "string",
  "reportID": 0,
  "sourceFilter": 0,
  "payeeFilterColumnMapping": "string",
  "hierarchyID": 0,
  "periodFilterColumnMapping": "string"
}

RESTAPI.v1.DTOs.DataAnaltyics.BenchmarkDTO

Properties

Name

Type

Required

Restrictions

Description

planId

integer(int32)

false

none

none

planName

string¦null

false

none

none

attainmentPercentile

integer(int32)

false

none

none

revenueRank

integer(int32)

false

none

none

comparables

integer(int32)

false

none

none

payoutPerRevenue

number(double)

false

none

none

churnRate

integer(int32)

false

none

none

level

string

false

none

none

Enumerated Values

Property

Value

level

Global

level

Industry

level

Company

json
{
  "planId": 0,
  "planName": "string",
  "attainmentPercentile": 0,
  "revenueRank": 0,
  "comparables": 0,
  "payoutPerRevenue": 0.1,
  "churnRate": 0,
  "level": "Global"
}

RESTAPI.v1.DTOs.DataAnaltyics.PlanAnalysisDTO

Properties

Name

Type

Required

Restrictions

Description

planId

integer(int32)

false

none

none

highlights

[string]¦null

false

none

none

needsImprovement

[string]¦null

false

none

none

grade

string¦null

false

none

none

json
{
  "planId": 0,
  "highlights": [
    "string"
  ],
  "needsImprovement": [
    "string"
  ],
  "grade": "string"
}

RESTAPI.v1.DTOs.DataEventDTO

Properties

Name

Type

Required

Restrictions

Description

type

string

false

none

none

current

any

false

none

none

original

any

false

none

none

Enumerated Values

Property

Value

type

Added

type

Deleted

type

Modified

type

Unchanged

json
{
  "type": "Added",
  "current": null,
  "original": null
}

RESTAPI.v1.DTOs.DataPathDTO

Properties

Name

Type

Required

Restrictions

Description

path

[string]¦null

false

none

none

json
{
  "path": [
    "string"
  ]
}

RESTAPI.v1.DTOs.DependencyInfoDTO

Properties

Name

Type

Required

Restrictions

Description

dependencies

object¦null

false

none

none

» Calendars

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» StarSchemas

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» Calculations

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» SavedImports

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» InputForms

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» TaskGroup

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» Plans

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» TailoredReports

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» Publications

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» PayeeGroups

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» Payees

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» Blocks

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» Ports

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» WebForms

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» WebFormFilters

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» WorkflowGroups

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» WebTab

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» Transformations

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» WebFormValidationRules

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» DataStores

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» BPMWorkflow

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» BPMSwimLane

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» BPMNode

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» BPMComponent

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» Views

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» Tables

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» PresenterReports

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» PickList

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» WebEditRestriction

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» PresenterReportDataSources

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» PresenterReportValueSources

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» PresenterReportRowFormSources

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» ScenarioWorkspace

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» Scheduler

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» RapidReport

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» DDE

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» Hierarchy

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» PresenterFlex

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» AdaptiveForms

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» ReportDataModelSource

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» PlanComponentSource

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» PlanBuilderCalculation

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

» PlanBuilderItem

[RESTAPI.v1.DTOs.DependencyItemDTO]

false

none

none

json
{
  "dependencies": {
    "Calendars": [
      {}
    ],
    "StarSchemas": [
      {}
    ],
    "Calculations": [
      {}
    ],
    "SavedImports": [
      {}
    ],
    "InputForms": [
      {}
    ],
    "TaskGroup": [
      {}
    ],
    "Plans": [
      {}
    ],
    "TailoredReports": [
      {}
    ],
    "Publications": [
      {}
    ],
    "PayeeGroups": [
      {}
    ],
    "Payees": [
      {}
    ],
    "Blocks": [
      {}
    ],
    "Ports": [
      {}
    ],
    "WebForms": [
      {}
    ],
    "WebFormFilters": [
      {}
    ],
    "WorkflowGroups": [
      {}
    ],
    "WebTab": [
      {}
    ],
    "Transformations": [
      {}
    ],
    "WebFormValidationRules": [
      {}
    ],
    "DataStores": [
      {}
    ],
    "BPMWorkflow": [
      {}
    ],
    "BPMSwimLane": [
      {}
    ],
    "BPMNode": [
      {}
    ],
    "BPMComponent": [
      {}
    ],
    "Views": [
      {}
    ],
    "Tables": [
      {}
    ],
    "PresenterReports": [
      {}
    ],
    "PickList": [
      {}
    ],
    "WebEditRestriction": [
      {}
    ],
    "PresenterReportDataSources": [
      {}
    ],
    "PresenterReportValueSources": [
      {}
    ],
    "PresenterReportRowFormSources": [
      {}
    ],
    "ScenarioWorkspace": [
      {}
    ],
    "Scheduler": [
      {}
    ],
    "RapidReport": [
      {}
    ],
    "DDE": [
      {}
    ],
    "Hierarchy": [
      {}
    ],
    "PresenterFlex": [
      {}
    ],
    "AdaptiveForms": [
      {}
    ],
    "ReportDataModelSource": [
      {}
    ],
    "PlanComponentSource": [
      {}
    ],
    "PlanBuilderCalculation": [
      {}
    ],
    "PlanBuilderItem": [
      {}
    ]
  }
}

RESTAPI.v1.DTOs.DependencyItemDTO

Properties

Name

Type

Required

Restrictions

Description

category

string

false

none

none

id

string¦null

false

none

none

name

string¦null

false

none

none

elementId

integer(int32)¦null

false

none

none

parentBlockId

integer(int32)¦null

false

none

none

displayName

string¦null

false

none

none

sources

[RESTAPI.v1.DTOs.WebReportSourceDependencyItemDTO]¦null

false

none

none

Enumerated Values

Property

Value

category

Calendars

category

StarSchemas

category

Calculations

category

SavedImports

category

InputForms

category

TaskGroup

category

Plans

category

TailoredReports

category

Publications

category

PayeeGroups

category

Payees

category

Blocks

category

Ports

category

WebForms

category

WebFormFilters

category

WorkflowGroups

category

WebTab

category

Transformations

category

WebFormValidationRules

category

DataStores

category

BPMWorkflow

category

BPMSwimLane

category

BPMNode

category

BPMComponent

category

Views

category

Tables

category

PresenterReports

category

PickList

category

WebEditRestriction

category

PresenterReportDataSources

category

PresenterReportValueSources

category

PresenterReportRowFormSources

category

ScenarioWorkspace

category

Scheduler

category

RapidReport

category

DDE

category

Hierarchy

category

PresenterFlex

category

AdaptiveForms

category

ReportDataModelSource

category

PlanComponentSource

category

PlanBuilderCalculation

category

PlanBuilderItem

json
{
  "category": "Calendars",
  "id": "string",
  "name": "string",
  "elementId": 0,
  "parentBlockId": 0,
  "displayName": "string",
  "sources": [
    {
      "type": "Query",
      "name": "string"
    }
  ]
}

RESTAPI.v1.DTOs.ELearningLoginDTO

Properties

Name

Type

Required

Restrictions

Description

username

string¦null

false

none

none

password

string¦null

false

none

none

json
{
  "username": "string",
  "password": "string"
}

RESTAPI.v1.DTOs.ExportToExcelDTO

Properties

Name

Type

Required

Restrictions

Description

headerRow

[string]¦null

false

none

none

rows

[string]¦null

false

none

none

columnTypes

[string]¦null

false

none

none

json
{
  "headerRow": [
    "string"
  ],
  "rows": [
    "string"
  ],
  "columnTypes": [
    "Number"
  ]
}

RESTAPI.v1.DTOs.FileDTO

Properties

Name

Type

Required

Restrictions

Description

fileId

integer(int32)

false

none

none

data64

string¦null

false

none

none

chunkNo

integer(int32)

false

none

none

tempFileName

string¦null

false

none

none

json
{
  "fileId": 0,
  "data64": "string",
  "chunkNo": 0,
  "tempFileName": "string"
}

RESTAPI.v1.DTOs.FillParametersDTO

Properties

Name

Type

Required

Restrictions

Description

sources

[Varicent.RESTAPI.v1.DTOs.ReportSourceDTO]¦null

false

none

none

pickLists

[Varicent.RESTAPI.v1.DTOs.PickListControlDTO]¦null

false

none

none

json
{
  "sources": [
    {
      "dependencies": [],
      "name": "string",
      "type": "AggregateTransformation",
      "scalarType": "string",
      "value": null,
      "column": "string",
      "keyValues": {},
      "table": "string",
      "expression": "string",
      "variables": [],
      "required": true,
      "useWebUser": true,
      "isParameterValueScalar": true,
      "parameterValue": {},
      "parameterId": 0,
      "columnNames": [],
      "source": {},
      "formula": "string",
      "partitionColumns": [],
      "timeEnd": "2019-08-24T14:15:22Z",
      "timeFrequency": {},
      "timePartition": "string",
      "timeStart": "2019-08-24T14:15:22Z",
      "newColumnName": "string",
      "keyColumns": [],
      "newColumns": [],
      "transposeColumn": "string"
    }
  ],
  "pickLists": [
    {
      "displayBorders": {},
      "displayPadding": {},
      "displayTypeLabel": "string",
      "fontstyle": {},
      "gridtype": "string",
      "hideIdValues": true,
      "hideValueForExport": true,
      "idColumn": "string",
      "name": "string",
      "nameColumn": "string",
      "refParameter": "string",
      "sortascending": true,
      "sortById": true,
      "source": {},
      "style": {}
    }
  ]
}

RESTAPI.v1.DTOs.Hierarchy.HierarchyCompactDTOV1

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

name

string¦null

false

none

none

json
{
  "id": 0,
  "name": "string"
}

RESTAPI.v1.DTOs.Hierarchy.HierarchyDTOV1

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

name

string¦null

false

none

none

description

string¦null

false

none

none

sourceName

string¦null

false

none

none

sourceLabel

string¦null

false

none

none

payeeColumnName

string¦null

false

none

none

reportsToColumnName

string¦null

false

none

none

periodColumnName

string¦null

false

none

none

sourceData

RESTAPI.v1.DTOs.Hierarchy.HierarchySourceDTOV1 RESTAPI.v1.DTOs.Hierarchy.HierarchySourceDTOV1

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "id": 0,
  "name": "string",
  "description": "string",
  "sourceName": "string",
  "sourceLabel": "string",
  "payeeColumnName": "string",
  "reportsToColumnName": "string",
  "periodColumnName": "string",
  "sourceData": {
    "name": "string",
    "label": "string",
    "type": "string",
    "columns": [
      {}
    ]
  },
  "version": {
    "rowVersion": 0
  }
}

RESTAPI.v1.DTOs.Hierarchy.HierarchyMetadataDTO

Properties

Name

Type

Required

Restrictions

Description

tableName

string¦null

false

none

none

idColumnName

string¦null

false

none

none

parentColumnName

string¦null

false

none

none

json
{
  "tableName": "string",
  "idColumnName": "string",
  "parentColumnName": "string"
}

RESTAPI.v1.DTOs.Hierarchy.HierarchyPayeeDTOV1

Properties

Name

Type

Required

Restrictions

Description

currentPayee

string¦null

false

none

none

visiblePayees

[string]¦null

false

none

none

json
{
  "currentPayee": "string",
  "visiblePayees": [
    "string"
  ]
}

RESTAPI.v1.DTOs.Hierarchy.HierarchyPeriodDTOV1

Properties

Name

Type

Required

Restrictions

Description

periods

[string]¦null

false

none

none

json
{
  "periods": [
    "string"
  ]
}

RESTAPI.v1.DTOs.Hierarchy.HierarchySourceDTOV1

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

label

string¦null

false

none

none

type

string¦null

false

none

none

columns

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

none

json
{
  "name": "string",
  "label": "string",
  "type": "string",
  "columns": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ]
}

RESTAPI.v1.DTOs.ImportFileDTO

Properties

Name

Type

Required

Restrictions

Description

fileId

integer(int32)

false

none

none

fileName

string¦null

false

none

none

fileType

string

false

none

none

chunkSize

integer(int32)

false

none

none

size

integer(int64)

false

none

none

currSize

integer(int64)

false

none

none

adminId

string¦null

false

none

none

time

string(date-time)

false

none

none

tempFileName

string¦null

false

none

none

isComplete

boolean

false

read-only

none

Enumerated Values

Property

Value

fileType

None

fileType

Data

fileType

Script

fileType

Image

fileType

Document

fileType

Publication

json
{
  "fileId": 0,
  "fileName": "string",
  "fileType": "None",
  "chunkSize": 0,
  "size": 0,
  "currSize": 0,
  "adminId": "string",
  "time": "2019-08-24T14:15:22Z",
  "tempFileName": "string",
  "isComplete": true
}

RESTAPI.v1.DTOs.Intercom.RequestContactEmailDTO

Properties

Name

Type

Required

Restrictions

Description

contactEmail

string¦null

false

none

none

json
{
  "contactEmail": "string"
}

RESTAPI.v1.DTOs.Intercom.RequestContactEmailResponseDTO

Properties

Name

Type

Required

Restrictions

Description

message

string¦null

false

none

none

preview

string¦null

false

none

none

expiry

integer(int32)

false

none

none

resolved

boolean

false

none

none

json
{
  "message": "string",
  "preview": "string",
  "expiry": 0,
  "resolved": true
}

RESTAPI.v1.DTOs.LastCalculationInfoDTO

Properties

Name

Type

Required

Restrictions

Description

lastCalculationDate

string¦null

false

none

none

lastFullCalculationDate

string¦null

false

none

none

lastCalculationDuration

string¦null

false

none

none

json
{
  "lastCalculationDate": "string",
  "lastFullCalculationDate": "string",
  "lastCalculationDuration": "string"
}

RESTAPI.v1.DTOs.Logs.ExportExceptionLogDTO

Properties

Name

Type

Required

Restrictions

Description

logID

integer(int32)

false

read-only

none

table

string¦null

false

read-only

none

summary

string¦null

false

read-only

none

importName

string¦null

false

read-only

none

timestamp

string(date-time)

false

none

none

error

string¦null

false

none

none

json
{
  "logID": 0,
  "table": "string",
  "summary": "string",
  "importName": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "error": "string"
}

RESTAPI.v1.DTOs.Logs.ImportExceptionLogDTO

Properties

Name

Type

Required

Restrictions

Description

logID

integer(int32)

false

read-only

none

table

string¦null

false

read-only

none

summary

string¦null

false

read-only

none

importName

string¦null

false

read-only

none

timestamp

string(date-time)

false

none

none

error

string¦null

false

none

none

json
{
  "logID": 0,
  "table": "string",
  "summary": "string",
  "importName": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "error": "string"
}

RESTAPI.v1.DTOs.Mail.EmailAttachmentDTO

Properties

Name

Type

Required

Restrictions

Description

fileName

string¦null

false

none

none

content

string¦null

false

none

none

json
{
  "fileName": "string",
  "content": "string"
}

RESTAPI.v1.DTOs.Mail.MailDTO

Properties

Name

Type

Required

Restrictions

Description

subject

string¦null

false

none

none

to

[string]¦null

false

none

none

useHtml

boolean

false

none

none

body

string¦null

false

none

none

cc

[string]¦null

false

none

none

bcc

[string]¦null

false

none

none

attachments

[RESTAPI.v1.DTOs.Mail.EmailAttachmentDTO]¦null

false

none

none

json
{
  "subject": "string",
  "to": [
    "string"
  ],
  "useHtml": true,
  "body": "string",
  "cc": [
    "string"
  ],
  "bcc": [
    "string"
  ],
  "attachments": [
    {
      "fileName": "string",
      "content": "string"
    }
  ]
}

RESTAPI.v1.DTOs.MaterializedViewDTO

Properties

Name

Type

Required

Restrictions

Description

viewName

string¦null

false

none

none

lastRefreshed

string(date-time)

false

none

none

json
{
  "viewName": "string",
  "lastRefreshed": "2019-08-24T14:15:22Z"
}

RESTAPI.v1.DTOs.ModelStatsDTO

Properties

Name

Type

Required

Restrictions

Description

numberOfCalculations

integer(int32)

false

none

none

numberOfDraws

integer(int32)

false

none

none

numberOfDataStores

integer(int32)

false

none

none

numberOfWebForms

integer(int32)

false

none

none

numberOfPresenterReports

integer(int32)

false

none

none

numberOfUsersWithWebAccess

integer(int32)

false

none

none

numberOfCalculationsRanMoreThanIdealTime

integer(int32)

false

none

none

numberOfUsersWithClientAccess

integer(int32)

false

none

none

numberOfRapidReports

integer(int32)

false

none

none

numberOfDiscoveryDashboards

integer(int32)

false

none

none

numberOfPresenterFlexReports

integer(int32)

false

none

none

numberOfSavedImports

integer(int32)

false

none

none

lastImportDate

string¦null

false

none

none

numberOfCalendars

integer(int32)

false

none

none

lastLockedCalenderId

string¦null

false

none

none

lastLockedCalenderPeriod

string¦null

false

none

none

lastLockedCalenderEnding

string¦null

false

none

none

numberOfTables

integer(int32)

false

none

none

hasPendingWebDataEdits

boolean

false

none

none

payeesTransactional

integer(int32)

false

none

none

payeesNonTransactional

integer(int32)

false

none

none

payeesInactive

integer(int32)

false

none

none

payeesUnmapped

integer(int32)

false

none

none

modelSize

number(double)

false

none

none

lastCalculationDate

string¦null

false

none

none

lastFullCalculationDate

string¦null

false

none

none

lastCalculationDuration

string¦null

false

none

none

json
{
  "numberOfCalculations": 0,
  "numberOfDraws": 0,
  "numberOfDataStores": 0,
  "numberOfWebForms": 0,
  "numberOfPresenterReports": 0,
  "numberOfUsersWithWebAccess": 0,
  "numberOfCalculationsRanMoreThanIdealTime": 0,
  "numberOfUsersWithClientAccess": 0,
  "numberOfRapidReports": 0,
  "numberOfDiscoveryDashboards": 0,
  "numberOfPresenterFlexReports": 0,
  "numberOfSavedImports": 0,
  "lastImportDate": "string",
  "numberOfCalendars": 0,
  "lastLockedCalenderId": "string",
  "lastLockedCalenderPeriod": "string",
  "lastLockedCalenderEnding": "string",
  "numberOfTables": 0,
  "hasPendingWebDataEdits": true,
  "payeesTransactional": 0,
  "payeesNonTransactional": 0,
  "payeesInactive": 0,
  "payeesUnmapped": 0,
  "modelSize": 0.1,
  "lastCalculationDate": "string",
  "lastFullCalculationDate": "string",
  "lastCalculationDuration": "string"
}

RESTAPI.v1.DTOs.NewFileDTO

Properties

Name

Type

Required

Restrictions

Description

fileId

integer(int32)

false

none

none

fileName

string¦null

false

none

none

fileType

string

false

none

none

size

integer(int64)

false

none

none

currSize

integer(int64)

false

none

none

chunkSize

integer(int32)

false

none

none

overwrite

boolean

false

none

none

Enumerated Values

Property

Value

fileType

None

fileType

Data

fileType

Script

fileType

Image

fileType

Document

fileType

Publication

json
{
  "fileId": 0,
  "fileName": "string",
  "fileType": "None",
  "size": 0,
  "currSize": 0,
  "chunkSize": 0,
  "overwrite": true
}

RESTAPI.v1.DTOs.Notification.AffiliatedInquiryDTO

Properties

Name

Type

Required

Restrictions

Description

anAdminIsAssigned

boolean

false

none

none

formValueChange

boolean

false

none

none

commentOnInquiry

boolean

false

none

none

takeAction

boolean

false

none

none

json
{
  "anAdminIsAssigned": true,
  "formValueChange": true,
  "commentOnInquiry": true,
  "takeAction": true
}

RESTAPI.v1.DTOs.Notification.CreatedInquiryDTO

Properties

Name

Type

Required

Restrictions

Description

anAdminIsAssigned

boolean

false

none

none

formValueChange

boolean

false

none

none

commentOnInquiry

boolean

false

none

none

takeAction

boolean

false

none

none

json
{
  "anAdminIsAssigned": true,
  "formValueChange": true,
  "commentOnInquiry": true,
  "takeAction": true
}

RESTAPI.v1.DTOs.Notification.Notification_WFSettingTypes_AdminDTO

Properties

json
{
  "myAssignedInquiry": null,
  "myAffiliatedInquiry": null,
  "myUnAssignedInquiry": null
}

RESTAPI.v1.DTOs.Notification.Notification_WFSettingTypes_AdminDTO+AffiliatedInquiryDTO

Properties

Name

Type

Required

Restrictions

Description

formValueChange

boolean

false

none

none

userComments

boolean

false

none

none

takeAction

boolean

false

none

none

json
{
  "formValueChange": true,
  "userComments": true,
  "takeAction": true
}

RESTAPI.v1.DTOs.Notification.Notification_WFSettingTypes_AdminDTO+AssignedInquiryDTO

Properties

Name

Type

Required

Restrictions

Description

imAssigned

boolean

false

none

none

imUnassigned

boolean

false

none

none

formValueChange

boolean

false

none

none

userComments

boolean

false

none

none

takeAction

boolean

false

none

none

json
{
  "imAssigned": true,
  "imUnassigned": true,
  "formValueChange": true,
  "userComments": true,
  "takeAction": true
}

RESTAPI.v1.DTOs.Notification.Notification_WFSettingTypes_AdminDTO+UnAssignedInquiryDTO

Properties

Name

Type

Required

Restrictions

Description

createNewInquiry

boolean

false

none

none

noAdminAssignedToInquiry

boolean

false

none

none

formValueChange

boolean

false

none

none

userComments

boolean

false

none

none

takeAction

boolean

false

none

none

json
{
  "createNewInquiry": true,
  "noAdminAssignedToInquiry": true,
  "formValueChange": true,
  "userComments": true,
  "takeAction": true
}

RESTAPI.v1.DTOs.Notification.Notification_WFSettingTypes_PayeeDTO

Properties

Name

Type

Required

Restrictions

Description

myCreatedInquiry

RESTAPI.v1.DTOs.Notification.CreatedInquiryDTO

false

none

none

myAffiliatedInquiry

RESTAPI.v1.DTOs.Notification.AffiliatedInquiryDTO

false

none

none

json
{
  "myCreatedInquiry": {
    "anAdminIsAssigned": true,
    "formValueChange": true,
    "commentOnInquiry": true,
    "takeAction": true
  },
  "myAffiliatedInquiry": {
    "anAdminIsAssigned": true,
    "formValueChange": true,
    "commentOnInquiry": true,
    "takeAction": true
  }
}

RESTAPI.v1.DTOs.Notification.Notification_WFSetting_AdminDTO

Properties

Name

Type

Required

Restrictions

Description

adminId

string¦null

false

none

none

wfSettings

RESTAPI.v1.DTOs.Notification.Notification_WFSettingTypes_AdminDTO

false

none

none

json
{
  "adminId": "string",
  "wfSettings": {
    "myAssignedInquiry": null,
    "myAffiliatedInquiry": null,
    "myUnAssignedInquiry": null
  }
}

RESTAPI.v1.DTOs.Notification.Notification_WFSetting_PayeeDTO

Properties

Name

Type

Required

Restrictions

Description

payeeid

string¦null

false

none

none

wfsettings

RESTAPI.v1.DTOs.Notification.Notification_WFSettingTypes_PayeeDTO

false

none

none

json
{
  "payeeid": "string",
  "wfsettings": {
    "myCreatedInquiry": {
      "anAdminIsAssigned": true,
      "formValueChange": true,
      "commentOnInquiry": true,
      "takeAction": true
    },
    "myAffiliatedInquiry": {
      "anAdminIsAssigned": true,
      "formValueChange": true,
      "commentOnInquiry": true,
      "takeAction": true
    }
  }
}

Properties

Name

Type

Required

Restrictions

Description

first

boolean

false

none

none

second

boolean

false

none

none

json
{
  "first": true,
  "second": true
}

RESTAPI.v1.DTOs.Payee.PayeeIDDTO

Properties

Name

Type

Required

Restrictions

Description

payeeID

string¦null

false

none

none

json
{
  "payeeID": "string"
}

RESTAPI.v1.DTOs.Payee.ResetWebPasswordDTO

Properties

Name

Type

Required

Restrictions

Description

passCode

string¦null

false

none

none

payeeID

string¦null

false

none

none

newPassword

string¦null

false

none

none

email

string¦null

false

none

none

json
{
  "passCode": "string",
  "payeeID": "string",
  "newPassword": "string",
  "email": "string"
}

RESTAPI.v1.DTOs.PayeeTypeTransferDTO

Properties

Name

Type

Required

Restrictions

Description

from

string¦null

false

none

none

to

string¦null

false

none

none

query

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

deltaAdd

[string]¦null

false

none

none

deltaDelete

[string]¦null

false

none

none

json
{
  "from": "string",
  "to": "string",
  "query": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "deltaAdd": [
    "string"
  ],
  "deltaDelete": [
    "string"
  ]
}

RESTAPI.v1.DTOs.People.ImportInfoDTO

Properties

Name

Type

Required

Restrictions

Description

tableName

string¦null

false

none

none

recordCount

integer(int32)

false

none

none

importCount

integer(int32)

false

none

none

json
{
  "tableName": "string",
  "recordCount": 0,
  "importCount": 0
}

RESTAPI.v1.DTOs.People.PayeeLookupFieldsDTO

Properties

Name

Type

Required

Restrictions

Description

data

object¦null

false

none

none

» additionalProperties

string¦null

false

none

none

json
{
  "data": {
    "property1": "string",
    "property2": "string"
  }
}

RESTAPI.v1.DTOs.PerformanceBatchComparisonDTO

Properties

Name

Type

Required

Restrictions

Description

baseComputation

Varicent.RESTAPI.v1.DTOs.BatchItemDTO

false

none

none

targetComputation

Varicent.RESTAPI.v1.DTOs.BatchItemDTO

false

none

none

comparisonItems

[RESTAPI.v1.DTOs.ComparisonItemDTO]¦null

false

none

none

json
{
  "baseComputation": {
    "batchId": 0,
    "status": "Started",
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z",
    "duration": "string",
    "computationEvents": [
      {}
    ],
    "type": "All",
    "clientVersion": "string",
    "databaseVersion": 0,
    "incremental": "No",
    "calculationsCount": 0
  },
  "targetComputation": {
    "batchId": 0,
    "status": "Started",
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z",
    "duration": "string",
    "computationEvents": [
      {}
    ],
    "type": "All",
    "clientVersion": "string",
    "databaseVersion": 0,
    "incremental": "No",
    "calculationsCount": 0
  },
  "comparisonItems": [
    {
      "id": 0,
      "name": "string",
      "baseDuration": 0.1,
      "targetDuration": 0.1,
      "delta": 0.1,
      "baseMethod": "string",
      "targetMethod": "string",
      "planBuilderCalculationId": "string",
      "planBuilderParentFolderName": "string"
    }
  ]
}

RESTAPI.v1.DTOs.PlanDocsMigration.MigratedPlanDocsDTO

Properties

Name

Type

Required

Restrictions

Description

migratedPlanDocsMap

object¦null

false

none

none

» additionalProperties

integer(int32)

false

none

none

json
{
  "migratedPlanDocsMap": {
    "property1": 0,
    "property2": 0
  }
}

RESTAPI.v1.DTOs.PlanDocuments.CreatePlanDocumentDTO

Properties

Name

Type

Required

Restrictions

Description

planDocumentId

integer(int32)¦null

false

none

none

name

string¦null

false

none

none

description

string¦null

false

none

none

workflowId

integer(int32)¦null

false

none

none

templateType

string¦null

false

none

none

metadataPlanDocument

RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentMetadataDTO

false

none

none

parentFolderId

integer(int32)¦null

false

none

none

order

integer(int32)¦null

false

none

none

Enumerated Values

Property

Value

templateType

Payee

templateType

ManagerPayee

templateType

Custom

json
{
  "planDocumentId": 0,
  "name": "string",
  "description": "string",
  "workflowId": 0,
  "templateType": "Payee",
  "metadataPlanDocument": {
    "property1": null,
    "property2": null
  },
  "parentFolderId": 0,
  "order": 0
}

RESTAPI.v1.DTOs.PlanDocuments.DuplicatePlanDocumentDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

planDocumentId

integer(int32)

false

none

none

description

string¦null

false

none

none

metadataPlanDocument

RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentMetadataDTO

false

none

none

copyPayees

boolean¦null

false

none

none

json
{
  "name": "string",
  "planDocumentId": 0,
  "description": "string",
  "metadataPlanDocument": {
    "property1": null,
    "property2": null
  },
  "copyPayees": true
}

RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentChildNodeDTO

Properties

Name

Type

Required

Restrictions

Description

planDocument

RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentDTO

false

none

none

parentFolderId

integer(int32)

false

none

none

json
{
  "planDocument": {
    "planDocumentId": 0,
    "name": "string",
    "workflowId": 0,
    "metadata": {
      "property1": null,
      "property2": null
    },
    "distributionStatus": "Draft",
    "agreementVisited": true,
    "workflowVisited": true,
    "payeeCount": 0,
    "payeeStatusCount": {
      "property1": 0,
      "property2": 0
    },
    "reportId": 0,
    "isWorkflowRunning": true,
    "description": "string",
    "workflowState": "NotStarted",
    "errors": {
      "NoError": "string",
      "CannotBeEmpty": "string",
      "LessThan100Char": "string",
      "NoTrailingSpaces": "string",
      "NameAlreadyExists": "string",
      "PresenterAdaptiveSpecificError": "string"
    },
    "hasAdminSwimlane": true,
    "adminActionsCount": 0,
    "nodeErrorsCount": 0,
    "showDuplicateCallout": true,
    "pdfGenerationFails": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "parentFolderId": 0
}

RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentDTO

Properties

Name

Type

Required

Restrictions

Description

planDocumentId

integer(int32)¦null

false

none

none

name

string¦null

false

none

none

workflowId

integer(int32)

false

none

none

metadata

RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentMetadataDTO

false

none

none

distributionStatus

string

false

none

none

agreementVisited

boolean

false

none

none

workflowVisited

boolean

false

none

none

payeeCount

integer(int32)

false

none

none

payeeStatusCount

object¦null

false

none

none

» additionalProperties

integer(int32)¦null

false

none

none

reportId

integer(int32)

false

none

none

isWorkflowRunning

boolean

false

none

none

description

string¦null

false

none

none

workflowState

string

false

none

none

errors

object¦null

false

none

none

» NoError

string

false

none

none

» CannotBeEmpty

string

false

none

none

» LessThan100Char

string

false

none

none

» NoTrailingSpaces

string

false

none

none

» NameAlreadyExists

string

false

none

none

» PresenterAdaptiveSpecificError

string

false

none

none

hasAdminSwimlane

boolean

false

none

none

adminActionsCount

integer(int32)

false

none

none

nodeErrorsCount

integer(int32)

false

none

none

showDuplicateCallout

boolean

false

none

none

pdfGenerationFails

integer(int32)

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

distributionStatus

Draft

distributionStatus

Ready

distributionStatus

DistributionInProgress

distributionStatus

Distributed

workflowState

NotStarted

workflowState

InProgress

workflowState

Ended

json
{
  "planDocumentId": 0,
  "name": "string",
  "workflowId": 0,
  "metadata": {
    "property1": null,
    "property2": null
  },
  "distributionStatus": "Draft",
  "agreementVisited": true,
  "workflowVisited": true,
  "payeeCount": 0,
  "payeeStatusCount": {
    "property1": 0,
    "property2": 0
  },
  "reportId": 0,
  "isWorkflowRunning": true,
  "description": "string",
  "workflowState": "NotStarted",
  "errors": {
    "NoError": "string",
    "CannotBeEmpty": "string",
    "LessThan100Char": "string",
    "NoTrailingSpaces": "string",
    "NameAlreadyExists": "string",
    "PresenterAdaptiveSpecificError": "string"
  },
  "hasAdminSwimlane": true,
  "adminActionsCount": 0,
  "nodeErrorsCount": 0,
  "showDuplicateCallout": true,
  "pdfGenerationFails": 0,
  "version": {
    "rowVersion": 0
  }
}

RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentDownloadInfoDTO

Properties

Name

Type

Required

Restrictions

Description

currentFilesCount

integer(int32)

false

none

none

lastDownloadFilesCount

integer(int32)¦null

false

none

none

lastDownloadAt

string(date-time)¦null

false

none

none

lastDownloadUserId

string¦null

false

none

none

json
{
  "currentFilesCount": 0,
  "lastDownloadFilesCount": 0,
  "lastDownloadAt": "2019-08-24T14:15:22Z",
  "lastDownloadUserId": "string"
}

RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentDownloadSummaryDTO

Properties

Name

Type

Required

Restrictions

Description

planDocumentId

integer(int32)

false

none

none

summary

object¦null

false

none

none

» InProgress

RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentDownloadInfoDTO

false

none

none

» Complete

RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentDownloadInfoDTO

false

none

none

» Cancelled

RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentDownloadInfoDTO

false

none

none

json
{
  "planDocumentId": 0,
  "summary": {
    "InProgress": {
      "currentFilesCount": 0,
      "lastDownloadFilesCount": 0,
      "lastDownloadAt": "2019-08-24T14:15:22Z",
      "lastDownloadUserId": "string"
    },
    "Complete": {
      "currentFilesCount": 0,
      "lastDownloadFilesCount": 0,
      "lastDownloadAt": "2019-08-24T14:15:22Z",
      "lastDownloadUserId": "string"
    },
    "Cancelled": {
      "currentFilesCount": 0,
      "lastDownloadFilesCount": 0,
      "lastDownloadAt": "2019-08-24T14:15:22Z",
      "lastDownloadUserId": "string"
    }
  }
}

RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentMassDownloadDTO

Properties

Name

Type

Required

Restrictions

Description

planDocumentId

integer(int32)

false

none

none

payeeWorkflowStatus

string

false

none

none

Enumerated Values

Property

Value

payeeWorkflowStatus

InProgress

payeeWorkflowStatus

Complete

payeeWorkflowStatus

Cancelled

json
{
  "planDocumentId": 0,
  "payeeWorkflowStatus": "InProgress"
}

RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentMetadataDTO

Properties

Name

Type

Required

Restrictions

Description

additionalProperties

any

false

none

none

json
{
  "property1": null,
  "property2": null
}

RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentPayeeDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

payeeId

string¦null

false

none

none

title

string¦null

false

none

none

reportsTo

RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentPayeeDTO+ReportsToDetailDTO

false

none

none

status

string¦null

false

none

none

nodeEndDate

string(date-time)¦null

false

none

none

nodeStartDate

string(date-time)¦null

false

none

none

nodeUpdatedDate

string(date-time)¦null

false

none

none

isPDFGenerated

boolean

false

none

none

isAdmin

boolean

false

none

none

nodeId

integer(int32)¦null

false

none

none

tokenId

integer(int32)¦null

false

none

none

assignees

[string]¦null

false

none

none

isRestarted

boolean

false

none

none

pdfGenerationFailed

boolean

false

none

none

pdfGenerationFailureDate

string(date-time)¦null

false

none

none

Enumerated Values

Property

Value

status

InProgress

status

Complete

status

Cancelled

json
{
  "name": "string",
  "payeeId": "string",
  "title": "string",
  "reportsTo": null,
  "status": "InProgress",
  "nodeEndDate": "2019-08-24T14:15:22Z",
  "nodeStartDate": "2019-08-24T14:15:22Z",
  "nodeUpdatedDate": "2019-08-24T14:15:22Z",
  "isPDFGenerated": true,
  "isAdmin": true,
  "nodeId": 0,
  "tokenId": 0,
  "assignees": [
    "string"
  ],
  "isRestarted": true,
  "pdfGenerationFailed": true,
  "pdfGenerationFailureDate": "2019-08-24T14:15:22Z"
}

RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentPayeeDTO+ReportsToDetailDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

payeeId

string¦null

false

none

none

title

string¦null

false

none

none

json
{
  "name": "string",
  "payeeId": "string",
  "title": "string"
}

RESTAPI.v1.DTOs.PlanDocuments.UpdatePlanDocumentDTO

Properties

Name

Type

Required

Restrictions

Description

planDocument

RESTAPI.v1.DTOs.PlanDocuments.PlanDocumentChildNodeDTO

false

none

none

oldOrder

integer(int32)

false

none

none

newOrder

integer(int32)¦null

false

none

none

oldParentFolderRowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

newParentFolderRowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "planDocument": {
    "planDocument": {
      "planDocumentId": 0,
      "name": "string",
      "workflowId": 0,
      "metadata": {},
      "distributionStatus": "Draft",
      "agreementVisited": true,
      "workflowVisited": true,
      "payeeCount": 0,
      "payeeStatusCount": {},
      "reportId": 0,
      "isWorkflowRunning": true,
      "description": "string",
      "workflowState": "NotStarted",
      "errors": {},
      "hasAdminSwimlane": true,
      "adminActionsCount": 0,
      "nodeErrorsCount": 0,
      "showDuplicateCallout": true,
      "pdfGenerationFails": 0,
      "version": {}
    },
    "parentFolderId": 0
  },
  "oldOrder": 0,
  "newOrder": 0,
  "oldParentFolderRowVersion": {
    "rowVersion": 0
  },
  "newParentFolderRowVersion": {
    "rowVersion": 0
  }
}

RESTAPI.v1.DTOs.Plans.PayeePlanTargetIncentiveDTO

Properties

Name

Type

Required

Restrictions

Description

payeeId

string¦null

false

none

none

planId

integer(int32)

false

none

none

targetIncentiveAmount

number(double)

false

none

none

startDate

string(date-time)

false

none

none

endDate

string(date-time)¦null

false

none

none

json
{
  "payeeId": "string",
  "planId": 0,
  "targetIncentiveAmount": 0.1,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z"
}

RESTAPI.v1.DTOs.Plans.PayeePortalAccessGroupDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

name

string¦null

false

none

none

json
{
  "id": 0,
  "name": "string"
}

RESTAPI.v1.DTOs.Plans.PlanApprovalBulkDownloadDTO

Properties

Name

Type

Required

Restrictions

Description

templateId

integer(int32)

false

none

none

planApprovalStatuses

[string]¦null

false

none

none

json
{
  "templateId": 0,
  "planApprovalStatuses": [
    "Selected"
  ]
}

RESTAPI.v1.DTOs.Plans.PlanApprovalDetailsDTO

Properties

Name

Type

Required

Restrictions

Description

planApprovalTemplateId

integer(int32)

false

none

none

name

string¦null

false

none

none

documents

[RESTAPI.v1.DTOs.Plans.PlanApprovalDocumentDTO]¦null

false

none

none

workflowType

string

false

none

none

documentsCount

integer(int32)

false

none

none

filteredDocumentsCount

integer(int32)¦null

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

workflowType

Payee

workflowType

ManagerPayee

json
{
  "planApprovalTemplateId": 0,
  "name": "string",
  "documents": [
    {
      "planApprovalTemplateId": 0,
      "payeeDetails": {},
      "tokenId": 0,
      "status": "Selected",
      "createdAt": "2019-08-24T14:15:22Z",
      "lastModified": "2019-08-24T14:15:22Z",
      "signatureInfos": [],
      "documentDistributionStatus": "NotProcessed",
      "distributionLiveActivityId": 0,
      "version": {},
      "migratedPlanDocumentId": 0
    }
  ],
  "workflowType": "Payee",
  "documentsCount": 0,
  "filteredDocumentsCount": 0,
  "version": {
    "rowVersion": 0
  }
}

RESTAPI.v1.DTOs.Plans.PlanApprovalDistributeTemplateDTO

Properties

Name

Type

Required

Restrictions

Description

completedactivities

string¦null

false

none

none

liveactivities

string¦null

false

none

none

planTemplate

RESTAPI.v1.DTOs.Plans.PlanApprovalTemplateDTO

false

none

none

json
{
  "completedactivities": "string",
  "liveactivities": "string",
  "planTemplate": {
    "planApprovalTemplateId": 0,
    "name": "string",
    "reportId": 0,
    "workflowId": 0,
    "workflowType": "Payee",
    "recipientCount": 0,
    "recipientStatusCount": {
      "Selected": 0,
      "PreManagerApproval": 0,
      "PayeeSign": 0,
      "Complete": 0
    },
    "metadata": {
      "property1": null,
      "property2": null
    },
    "distributionStatus": "Draft",
    "version": {
      "rowVersion": 0
    },
    "migratedPlanDocumentId": 0
  }
}

RESTAPI.v1.DTOs.Plans.PlanApprovalDocumentBulkDownloadDTO

Properties

Name

Type

Required

Restrictions

Description

publisherID

integer(int32)

false

none

none

downloadAt

string(date-time)

false

none

none

userID

string¦null

false

none

none

targetFilesCount

integer(int32)

false

none

none

actualFilesCount

integer(int32)

false

none

none

targetFilenames

string¦null

false

none

none

actualFilenames

string¦null

false

none

none

errorMessage

string¦null

false

none

none

json
{
  "publisherID": 0,
  "downloadAt": "2019-08-24T14:15:22Z",
  "userID": "string",
  "targetFilesCount": 0,
  "actualFilesCount": 0,
  "targetFilenames": "string",
  "actualFilenames": "string",
  "errorMessage": "string"
}

RESTAPI.v1.DTOs.Plans.PlanApprovalDocumentBulkDownloadInfoDTO

Properties

Name

Type

Required

Restrictions

Description

currentFilesCount

integer(int32)

false

none

none

lastDownloadFilesCount

integer(int32)¦null

false

none

none

lastDownloadAt

string(date-time)¦null

false

none

none

lastDownloadUserId

string¦null

false

none

none

json
{
  "currentFilesCount": 0,
  "lastDownloadFilesCount": 0,
  "lastDownloadAt": "2019-08-24T14:15:22Z",
  "lastDownloadUserId": "string"
}

RESTAPI.v1.DTOs.Plans.PlanApprovalDocumentBulkDownloadSummaryDTO

Properties

Name

Type

Required

Restrictions

Description

templateId

integer(int32)

false

none

none

summary

object¦null

false

none

none

» Selected

RESTAPI.v1.DTOs.Plans.PlanApprovalDocumentBulkDownloadInfoDTO

false

none

none

» PreManagerApproval

RESTAPI.v1.DTOs.Plans.PlanApprovalDocumentBulkDownloadInfoDTO

false

none

none

» PayeeSign

RESTAPI.v1.DTOs.Plans.PlanApprovalDocumentBulkDownloadInfoDTO

false

none

none

» Complete

RESTAPI.v1.DTOs.Plans.PlanApprovalDocumentBulkDownloadInfoDTO

false

none

none

json
{
  "templateId": 0,
  "summary": {
    "Selected": {
      "currentFilesCount": 0,
      "lastDownloadFilesCount": 0,
      "lastDownloadAt": "2019-08-24T14:15:22Z",
      "lastDownloadUserId": "string"
    },
    "PreManagerApproval": {
      "currentFilesCount": 0,
      "lastDownloadFilesCount": 0,
      "lastDownloadAt": "2019-08-24T14:15:22Z",
      "lastDownloadUserId": "string"
    },
    "PayeeSign": {
      "currentFilesCount": 0,
      "lastDownloadFilesCount": 0,
      "lastDownloadAt": "2019-08-24T14:15:22Z",
      "lastDownloadUserId": "string"
    },
    "Complete": {
      "currentFilesCount": 0,
      "lastDownloadFilesCount": 0,
      "lastDownloadAt": "2019-08-24T14:15:22Z",
      "lastDownloadUserId": "string"
    }
  }
}

RESTAPI.v1.DTOs.Plans.PlanApprovalDocumentDTO

Properties

Name

Type

Required

Restrictions

Description

planApprovalTemplateId

integer(int32)

false

none

none

payeeDetails

Varicent.RESTAPI.v1.DTOs.PayeeIndepthDetailsDTO

false

none

none

tokenId

integer(int32)¦null

false

none

none

status

string

false

none

none

createdAt

string(date-time)¦null

false

none

none

lastModified

string(date-time)¦null

false

none

none

signatureInfos

[RESTAPI.v1.DTOs.Plans.PlanApprovalSignatureInfoDTO]¦null

false

none

none

documentDistributionStatus

string

false

none

none

distributionLiveActivityId

integer(int32)¦null

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

migratedPlanDocumentId

integer(int32)¦null

false

none

none

Enumerated Values

Property

Value

status

Selected

status

PreManagerApproval

status

PayeeSign

status

Complete

documentDistributionStatus

NotProcessed

documentDistributionStatus

Sending

documentDistributionStatus

Sent

documentDistributionStatus

Failed

documentDistributionStatus

RestartFailed

json
{
  "planApprovalTemplateId": 0,
  "payeeDetails": {
    "title": "string",
    "reportsToPayee": null,
    "payeeProfilePicture": "string",
    "groupIds": [
      0
    ],
    "groupNames": [
      "string"
    ],
    "name": "string",
    "id": "string"
  },
  "tokenId": 0,
  "status": "Selected",
  "createdAt": "2019-08-24T14:15:22Z",
  "lastModified": "2019-08-24T14:15:22Z",
  "signatureInfos": [
    {
      "signerId": "string",
      "signerName": "string",
      "signAt": "2019-08-24T14:15:22Z"
    }
  ],
  "documentDistributionStatus": "NotProcessed",
  "distributionLiveActivityId": 0,
  "version": {
    "rowVersion": 0
  },
  "migratedPlanDocumentId": 0
}

RESTAPI.v1.DTOs.Plans.PlanApprovalFetchTemplatesDTO

Properties

Name

Type

Required

Restrictions

Description

planTemplates

[RESTAPI.v1.DTOs.Plans.PlanApprovalTemplateDTO]¦null

false

none

none

totalRowCount

integer(int32)

false

none

none

json
{
  "planTemplates": [
    {
      "planApprovalTemplateId": 0,
      "name": "string",
      "reportId": 0,
      "workflowId": 0,
      "workflowType": "Payee",
      "recipientCount": 0,
      "recipientStatusCount": {},
      "metadata": {},
      "distributionStatus": "Draft",
      "version": {},
      "migratedPlanDocumentId": 0
    }
  ],
  "totalRowCount": 0
}

RESTAPI.v1.DTOs.Plans.PlanApprovalMetadataDTO

Properties

Name

Type

Required

Restrictions

Description

additionalProperties

any

false

none

none

json
{
  "property1": null,
  "property2": null
}

RESTAPI.v1.DTOs.Plans.PlanApprovalPayeeDTO

Properties

Name

Type

Required

Restrictions

Description

payeeDetails

Varicent.RESTAPI.v1.DTOs.PayeeIndepthDetailsDTO

false

none

none

selected

boolean

false

none

none

distributed

boolean

false

none

none

json
{
  "payeeDetails": {
    "title": "string",
    "reportsToPayee": null,
    "payeeProfilePicture": "string",
    "groupIds": [
      0
    ],
    "groupNames": [
      "string"
    ],
    "name": "string",
    "id": "string"
  },
  "selected": true,
  "distributed": true
}

RESTAPI.v1.DTOs.Plans.PlanApprovalPayeeDetailsDTO

Properties

Name

Type

Required

Restrictions

Description

payeeId

string¦null

false

none

none

planApprovalDetails

[RESTAPI.v1.DTOs.Plans.PlanApprovalDetailsDTO]¦null

false

none

none

signedDocumentCount

integer(int32)

false

none

none

unsignedDocumentCount

integer(int32)

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "payeeId": "string",
  "planApprovalDetails": [
    {
      "planApprovalTemplateId": 0,
      "name": "string",
      "documents": [],
      "workflowType": "Payee",
      "documentsCount": 0,
      "filteredDocumentsCount": 0,
      "version": {}
    }
  ],
  "signedDocumentCount": 0,
  "unsignedDocumentCount": 0,
  "version": {
    "rowVersion": 0
  }
}

RESTAPI.v1.DTOs.Plans.PlanApprovalPayeeLookupFieldsDTO

Properties

Name

Type

Required

Restrictions

Description

data

object¦null

false

none

none

» additionalProperties

string¦null

false

none

none

json
{
  "data": {
    "property1": "string",
    "property2": "string"
  }
}

RESTAPI.v1.DTOs.Plans.PlanApprovalReportDTO

Properties

Name

Type

Required

Restrictions

Description

planApprovalTemplateId

integer(int32)¦null

false

none

none

name

string¦null

false

none

none

reportId

integer(int32)

false

none

none

workflowId

integer(int32)¦null

false

none

none

workflowType

string

false

none

none

recipientCount

integer(int32)

false

none

none

metadataPlanApproval

RESTAPI.v1.DTOs.Plans.PlanApprovalMetadataDTO

false

none

none

metadataPresenterFlex

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexReportMetadataDTO

false

none

none

type

string¦null

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

workflowType

Payee

workflowType

ManagerPayee

type

Default

type

StandardReport

type

PlanApproval

type

PlanDocument

json
{
  "planApprovalTemplateId": 0,
  "name": "string",
  "reportId": 0,
  "workflowId": 0,
  "workflowType": "Payee",
  "recipientCount": 0,
  "metadataPlanApproval": {
    "property1": null,
    "property2": null
  },
  "metadataPresenterFlex": {
    "property1": null,
    "property2": null
  },
  "type": "Default",
  "version": {
    "rowVersion": 0
  }
}

RESTAPI.v1.DTOs.Plans.PlanApprovalSignatureInfoDTO

Properties

Name

Type

Required

Restrictions

Description

signerId

string¦null

false

none

none

signerName

string¦null

false

none

none

signAt

string(date-time)

false

none

none

json
{
  "signerId": "string",
  "signerName": "string",
  "signAt": "2019-08-24T14:15:22Z"
}

RESTAPI.v1.DTOs.Plans.PlanApprovalTemplateDTO

Properties

Name

Type

Required

Restrictions

Description

planApprovalTemplateId

integer(int32)¦null

false

none

none

name

string¦null

false

none

none

reportId

integer(int32)

false

none

none

workflowId

integer(int32)¦null

false

none

none

workflowType

string

false

none

none

recipientCount

integer(int32)

false

none

none

recipientStatusCount

object¦null

false

none

none

» Selected

integer(int32)

false

none

none

» PreManagerApproval

integer(int32)

false

none

none

» PayeeSign

integer(int32)

false

none

none

» Complete

integer(int32)

false

none

none

metadata

RESTAPI.v1.DTOs.Plans.PlanApprovalMetadataDTO

false

none

none

distributionStatus

string

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

migratedPlanDocumentId

integer(int32)¦null

false

none

none

Enumerated Values

Property

Value

workflowType

Payee

workflowType

ManagerPayee

distributionStatus

Draft

distributionStatus

Ready

distributionStatus

DistributionInProgress

distributionStatus

Distributed

json
{
  "planApprovalTemplateId": 0,
  "name": "string",
  "reportId": 0,
  "workflowId": 0,
  "workflowType": "Payee",
  "recipientCount": 0,
  "recipientStatusCount": {
    "Selected": 0,
    "PreManagerApproval": 0,
    "PayeeSign": 0,
    "Complete": 0
  },
  "metadata": {
    "property1": null,
    "property2": null
  },
  "distributionStatus": "Draft",
  "version": {
    "rowVersion": 0
  },
  "migratedPlanDocumentId": 0
}

RESTAPI.v1.DTOs.Plans.PlanApprovalTemplateDuplicateDTO

Properties

Name

Type

Required

Restrictions

Description

workflowType

string

false

none

none

name

string¦null

false

none

none

includePayees

boolean

false

none

none

Enumerated Values

Property

Value

workflowType

Payee

workflowType

ManagerPayee

json
{
  "workflowType": "Payee",
  "name": "string",
  "includePayees": true
}

RESTAPI.v1.DTOs.Plans.PlanEventDataTableInfoDTO

Properties

Name

Type

Required

Restrictions

Description

tableName

string¦null

false

none

none

keyField

string¦null

false

none

none

numericFields

[RESTAPI.v1.DTOs.Plans.PlanFieldOptionDTO]¦null

false

none

none

dateFields

[RESTAPI.v1.DTOs.Plans.PlanFieldOptionDTO]¦null

false

none

none

textFields

[RESTAPI.v1.DTOs.Plans.PlanFieldOptionDTO]¦null

false

none

none

json
{
  "tableName": "string",
  "keyField": "string",
  "numericFields": [
    {
      "value": "string",
      "label": "string"
    }
  ],
  "dateFields": [
    {
      "value": "string",
      "label": "string"
    }
  ],
  "textFields": [
    {
      "value": "string",
      "label": "string"
    }
  ]
}

RESTAPI.v1.DTOs.Plans.PlanFieldOptionDTO

Properties

Name

Type

Required

Restrictions

Description

value

string¦null

false

none

none

label

string¦null

false

none

none

json
{
  "value": "string",
  "label": "string"
}

RESTAPI.v1.DTOs.Plans.PlanReleaseEventFieldOptionsDTO

Properties

Name

Type

Required

Restrictions

Description

primaryTableName

string¦null

false

none

none

primaryNumericFields

[RESTAPI.v1.DTOs.Plans.PlanFieldOptionDTO]¦null

false

none

none

planEventDataTableInfos

[RESTAPI.v1.DTOs.Plans.PlanEventDataTableInfoDTO]¦null

false

none

none

json
{
  "primaryTableName": "string",
  "primaryNumericFields": [
    {
      "value": "string",
      "label": "string"
    }
  ],
  "planEventDataTableInfos": [
    {
      "tableName": "string",
      "keyField": "string",
      "numericFields": [],
      "dateFields": [],
      "textFields": []
    }
  ]
}

RESTAPI.v1.DTOs.Plans.RateCard.RateCardConditionDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

index

integer(int32)

false

none

none

name

string¦null

false

none

none

multiplier

number(double)

false

none

none

rateCardOperators

[RESTAPI.v1.DTOs.Plans.RateCard.RateCardOperatorDTO]¦null

false

none

none

json
{
  "id": 0,
  "index": 0,
  "name": "string",
  "multiplier": 0.1,
  "rateCardOperators": [
    {
      "id": 0,
      "field": "string",
      "index": 0,
      "operatorValuePairs": [],
      "rateCardConditionId": 0
    }
  ]
}

RESTAPI.v1.DTOs.Plans.RateCard.RateCardOperatorDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

field

string¦null

false

none

none

index

integer(int32)

false

none

none

operatorValuePairs

[RESTAPI.v1.DTOs.Plans.RateCard.RateCardOperatorValueDTO]¦null

false

none

none

rateCardConditionId

integer(int32)

false

none

none

json
{
  "id": 0,
  "field": "string",
  "index": 0,
  "operatorValuePairs": [
    {
      "name": "string",
      "value": "string",
      "index": 0,
      "rateCardOperatorId": 0,
      "type": "Text"
    }
  ],
  "rateCardConditionId": 0
}

RESTAPI.v1.DTOs.Plans.RateCard.RateCardOperatorValueDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

value

string¦null

false

none

none

index

integer(int32)

false

none

none

rateCardOperatorId

integer(int32)

false

none

none

type

string

false

none

none

Enumerated Values

Property

Value

type

Text

type

Numeric

type

Date

json
{
  "name": "string",
  "value": "string",
  "index": 0,
  "rateCardOperatorId": 0,
  "type": "Text"
}

RESTAPI.v1.DTOs.Plans.SelectedPayeesToDistributeDTO

Properties

Name

Type

Required

Restrictions

Description

payeeIds

[string]¦null

false

none

none

statuses

[string]¦null

false

none

none

json
{
  "payeeIds": [
    "string"
  ],
  "statuses": [
    "Selected"
  ]
}

RESTAPI.v1.DTOs.PortalAccess.CreateWorkflowGroupNodeDTO

Properties

Name

Type

Required

Restrictions

Description

workflow

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupNodeDTORESTAPI.v1.DTOs.PortalAccess.WorkflowGroupNodeDTO

false

none

none

maintainGroup

boolean

false

none

none

json
{
  "workflow": {
    "comment": "string",
    "group": {
      "definition": {},
      "isPasswordExpiryEnabled": true
    },
    "name": "string",
    "passwordExpiryEnabled": true,
    "type": "Group",
    "subtreeGroupCount": 0,
    "id": 0,
    "parent": 0,
    "oldParent": 0,
    "prev": 0,
    "oldPrev": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "maintainGroup": true
}

RESTAPI.v1.DTOs.PortalAccess.PortalAccessAssignmentDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

accessTreeID

integer(int32)¦null

false

none

none

signoffTreeID

integer(int32)¦null

false

none

none

inquiryTreeID

integer(int32)¦null

false

none

none

parentID

integer(int32)¦null

false

none

none

prevID

integer(int32)¦null

false

none

none

workflowObjectID

integer(int32)¦null

false

none

none

inquiryWorkflowID

integer(int32)¦null

false

none

none

objectId

string¦null

false

none

none

type

string

false

none

none

Enumerated Values

Property

Value

type

Data

type

CompensationPlan

type

TailoredReport

type

Document

type

WebForm

type

WebReport

type

WebTab

type

CompPlanManager

type

WebTabGroup

type

ExternalURL

type

RapidReport

type

Table

type

DataStore

type

DDE

type

DDEInfographic

type

PayeeDocument

type

PresenterAdaptive

type

DirectLink

type

AdaptiveForm

type

StandardReport

type

SalesPlanningMap

json
{
  "name": "string",
  "accessTreeID": 0,
  "signoffTreeID": 0,
  "inquiryTreeID": 0,
  "parentID": 0,
  "prevID": 0,
  "workflowObjectID": 0,
  "inquiryWorkflowID": 0,
  "objectId": "string",
  "type": "Data"
}

RESTAPI.v1.DTOs.PortalAccess.PortalAccessEmailDTO

Properties

Name

Type

Required

Restrictions

Description

subject

string¦null

false

none

none

message

string¦null

false

none

none

json
{
  "subject": "string",
  "message": "string"
}

RESTAPI.v1.DTOs.PortalAccess.PortalAccessEmailGroupDTO

Properties

Name

Type

Required

Restrictions

Description

groupIDs

[integer]¦null

false

none

none

email

RESTAPI.v1.DTOs.PortalAccess.PortalAccessEmailDTO

false

none

none

isSignoff

boolean

false

none

none

sendAnyway

boolean

false

none

none

pendingChecked

boolean

false

none

none

objectId

string¦null

false

none

none

type

string

false

none

none

Enumerated Values

Property

Value

type

Data

type

CompensationPlan

type

TailoredReport

type

Document

type

WebForm

type

WebReport

type

WebTab

type

CompPlanManager

type

WebTabGroup

type

ExternalURL

type

RapidReport

type

Table

type

DataStore

type

DDE

type

DDEInfographic

type

PayeeDocument

type

PresenterAdaptive

type

DirectLink

type

AdaptiveForm

type

StandardReport

type

SalesPlanningMap

json
{
  "groupIDs": [
    0
  ],
  "email": {
    "subject": "string",
    "message": "string"
  },
  "isSignoff": true,
  "sendAnyway": true,
  "pendingChecked": true,
  "objectId": "string",
  "type": "Data"
}

RESTAPI.v1.DTOs.PortalAccess.PortalAccessSignoffDTO

Properties

Name

Type

Required

Restrictions

Description

signoffId

integer(int32)

false

none

none

signoffName

string¦null

false

none

none

treeId

integer(int32)¦null

false

none

none

startDate

string(date-time)

false

none

none

endRevision

integer(int32)

false

none

none

objectName

string¦null

false

none

none

nodeId

integer(int32)¦null

false

none

none

signoffDate

string(date-time)¦null

false

none

none

from

[string]¦null

false

none

none

objectId

string¦null

false

none

none

type

string

false

none

none

Enumerated Values

Property

Value

type

Data

type

CompensationPlan

type

TailoredReport

type

Document

type

WebForm

type

WebReport

type

WebTab

type

CompPlanManager

type

WebTabGroup

type

ExternalURL

type

RapidReport

type

Table

type

DataStore

type

DDE

type

DDEInfographic

type

PayeeDocument

type

PresenterAdaptive

type

DirectLink

type

AdaptiveForm

type

StandardReport

type

SalesPlanningMap

json
{
  "signoffId": 0,
  "signoffName": "string",
  "treeId": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "endRevision": 0,
  "objectName": "string",
  "nodeId": 0,
  "signoffDate": "2019-08-24T14:15:22Z",
  "from": [
    "string"
  ],
  "objectId": "string",
  "type": "Data"
}

RESTAPI.v1.DTOs.PortalAccess.PortalAccessSignoffTreeDTO

Properties

Name

Type

Required

Restrictions

Description

signoff

RESTAPI.v1.DTOs.PortalAccess.PortalAccessSignoffDTO

false

none

none

tree

Varicent.RESTAPI.v1.DTOs.Workflow.WorkflowTreeDTO

false

none

none

pendingNodes

[integer]¦null

false

none

none

approvedNodes

[integer]¦null

false

none

none

json
{
  "signoff": {
    "signoffId": 0,
    "signoffName": "string",
    "treeId": 0,
    "startDate": "2019-08-24T14:15:22Z",
    "endRevision": 0,
    "objectName": "string",
    "nodeId": 0,
    "signoffDate": "2019-08-24T14:15:22Z",
    "from": [
      "string"
    ],
    "objectId": "string",
    "type": "Data"
  },
  "tree": {
    "id": 0,
    "name": "string",
    "edges": [
      {}
    ],
    "nodes": [
      {}
    ],
    "descendantList": {
      "property1": [],
      "property2": []
    },
    "version": {
      "rowVersion": 0
    }
  },
  "pendingNodes": [
    0
  ],
  "approvedNodes": [
    0
  ]
}

RESTAPI.v1.DTOs.PortalAccess.TreeBuilderDTO

Properties

Name

Type

Required

Restrictions

Description

treeName

string¦null

false

none

none

parentColumn

Varicent.RESTAPI.v1.DTOs.DataItemDTO

false

none

none

groupDefinitionColumn

Varicent.RESTAPI.v1.DTOs.DataItemDTO

false

none

none

maintainGroups

boolean

false

none

none

source

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

json
{
  "treeName": "string",
  "parentColumn": {
    "path": {
      "path": []
    },
    "column": "string",
    "alias": "string"
  },
  "groupDefinitionColumn": {
    "path": {
      "path": []
    },
    "column": "string",
    "alias": "string"
  },
  "maintainGroups": true,
  "source": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  }
}

RESTAPI.v1.DTOs.PortalAccess.UpdateWorkflowGroupNodeDTO

Properties

Name

Type

Required

Restrictions

Description

workflow

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupNodeDTO

false

none

none

deltaAdds

[string]¦null

false

none

none

deltaDeletes

[string]¦null

false

none

none

json
{
  "workflow": {
    "comment": "string",
    "group": {
      "definition": {},
      "isPasswordExpiryEnabled": true
    },
    "name": "string",
    "passwordExpiryEnabled": true,
    "type": "Group",
    "subtreeGroupCount": 0,
    "id": 0,
    "parent": 0,
    "oldParent": 0,
    "prev": 0,
    "oldPrev": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "deltaAdds": [
    "string"
  ],
  "deltaDeletes": [
    "string"
  ]
}

RESTAPI.v1.DTOs.PortalAccess.WebTabDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

tabType

string

false

none

none

externalURL

string¦null

false

none

none

objectId

string¦null

false

none

none

objectName

string¦null

false

none

none

objectType

string¦null

false

none

none

workflowObjectId

integer(int32)

false

none

none

nameEnum

string¦null

false

none

none

mobileEnabled

boolean¦null

false

none

none

mobileWebAccess

string¦null

false

none

none

slackEnabled

boolean¦null

false

none

none

headerEnabled

boolean¦null

false

none

none

footerEnabled

boolean¦null

false

none

none

id

integer(int32)

false

none

none

parent

integer(int32)¦null

false

none

none

oldParent

integer(int32)¦null

false

none

none

prev

integer(int32)¦null

false

none

none

oldPrev

integer(int32)¦null

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

tabType

WebModule

tabType

TabGroup

tabType

CompensationPlan

tabType

TailoredReport

tabType

WebForm

tabType

PresenterReport

tabType

None

tabType

ExternalURL

tabType

CompPlanManager

tabType

RapidReport

tabType

DDE

tabType

DDEInfographic

tabType

PresenterAdaptive

tabType

DirectLink

tabType

AdaptiveForm

tabType

StandardReport

tabType

SalesPlanningMap

nameEnum

PayeeLedger

nameEnum

Inquiries

nameEnum

DataEdit

nameEnum

WebForms

nameEnum

Reporting

nameEnum

CompPlanManager

mobileWebAccess

WebOnly

mobileWebAccess

MobileAndWeb

mobileWebAccess

MobileOnly

mobileWebAccess

None

json
{
  "name": "string",
  "tabType": "WebModule",
  "externalURL": "string",
  "objectId": "string",
  "objectName": "string",
  "objectType": "string",
  "workflowObjectId": 0,
  "nameEnum": "PayeeLedger",
  "mobileEnabled": true,
  "mobileWebAccess": "WebOnly",
  "slackEnabled": true,
  "headerEnabled": true,
  "footerEnabled": true,
  "id": 0,
  "parent": 0,
  "oldParent": 0,
  "prev": 0,
  "oldPrev": 0,
  "version": {
    "rowVersion": 0
  }
}

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupDTO

Properties

Name

Type

Required

Restrictions

Description

definition

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupDefinitionDTORESTAPI.v1.DTOs.PortalAccess.WorkflowGroupDefinitionDTO

false

none

none

isPasswordExpiryEnabled

boolean

false

none

none

json
{
  "definition": {
    "groupId": 0,
    "groupName": "string",
    "source": {
      "query": {},
      "sourceNames": {}
    }
  },
  "isPasswordExpiryEnabled": true
}

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupDefinitionDTO

Properties

Name

Type

Required

Restrictions

Description

groupId

integer(int32)

false

none

none

groupName

string¦null

false

none

none

source

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

json
{
  "groupId": 0,
  "groupName": "string",
  "source": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  }
}

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupNameDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

name

string¦null

false

none

none

json
{
  "id": 0,
  "name": "string"
}

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupNodeDTO

Properties

Name

Type

Required

Restrictions

Description

comment

string¦null

false

none

none

group

RESTAPI.v1.DTOs.PortalAccess.WorkflowGroupDTO

false

none

none

name

string¦null

false

none

none

passwordExpiryEnabled

boolean¦null

false

none

none

type

string

false

none

none

subtreeGroupCount

integer(int32)

false

none

none

id

integer(int32)

false

none

none

parent

integer(int32)¦null

false

none

none

oldParent

integer(int32)¦null

false

none

none

prev

integer(int32)¦null

false

none

none

oldPrev

integer(int32)¦null

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

type

Group

type

Folder

json
{
  "comment": "string",
  "group": {
    "definition": {
      "groupId": 0,
      "groupName": "string",
      "source": {}
    },
    "isPasswordExpiryEnabled": true
  },
  "name": "string",
  "passwordExpiryEnabled": true,
  "type": "Group",
  "subtreeGroupCount": 0,
  "id": 0,
  "parent": 0,
  "oldParent": 0,
  "prev": 0,
  "oldPrev": 0,
  "version": {
    "rowVersion": 0
  }
}

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexRangeValueDTO

Properties

json
{
  "min": null,
  "max": null
}

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexReportMetadataDTO

Properties

Name

Type

Required

Restrictions

Description

additionalProperties

any

false

none

none

json
{
  "property1": null,
  "property2": null
}

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterAndDTO

Properties

Name

Type

Required

Restrictions

Description

filters

[RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterDTO]¦null

false

none

none

json
{
  "filters": []
}

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterConstraintDTO

Properties

Name

Type

Required

Restrictions

Description

columnName

string¦null

false

none

none

operator

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterOperatorDTO RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterOperatorDTO

false

none

none

value

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterValueDTO

false

none

none

caseSensitive

boolean¦null

false

none

none

json
{
  "columnName": "string",
  "operator": {
    "type": "Equals"
  },
  "value": {
    "text": "string",
    "numeric": 0.1,
    "date": "2019-08-24T14:15:22Z",
    "special": "CurrentWebUser",
    "valueId": 0,
    "rangeValue": {
      "min": null,
      "max": null
    }
  },
  "caseSensitive": true
}
json
{
  "constraint": {
    "columnName": "string",
    "operator": {
      "type": "Equals"
    },
    "value": {
      "text": "string",
      "numeric": 0.1,
      "date": "2019-08-24T14:15:22Z",
      "special": "CurrentWebUser",
      "valueId": 0,
      "rangeValue": {}
    },
    "caseSensitive": true
  },
  "and": {
    "filters": []
  },
  "or": {
    "filters": []
  },
  "not": {
    "filter": null
  },
  "metadata": {
    "property1": null,
    "property2": null
  }
}

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterMetaDataDTO

Properties

Name

Type

Required

Restrictions

Description

additionalProperties

any

false

none

none

json
{
  "property1": null,
  "property2": null
}

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterNotDTO

Properties

Name

Type

Required

Restrictions

Description

filter

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterDTO

false

none

none

json
{
  "filter": null
}

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterOperatorDTO

Properties

Name

Type

Required

Restrictions

Description

type

string

false

none

none

Enumerated Values

Property

Value

type

Equals

type

NotEquals

type

LessThan

type

LessThanEquals

type

GreaterThan

type

GreaterThanEquals

type

IsNull

type

IsNotNull

type

Contains

type

NotContains

type

StartWith

type

EndWith

type

InRange

type

InArray

type

NotInArray

json
{
  "type": "Equals"
}

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterOrDTO

Properties

Name

Type

Required

Restrictions

Description

filters

[RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterDTO]¦null

false

none

none

json
{
  "filters": []
}

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterValueDTO

Properties

Name

Type

Required

Restrictions

Description

text

string¦null

false

none

none

numeric

number(double)¦null

false

none

none

date

string(date-time)¦null

false

none

none

special

string¦null

false

none

none

valueId

integer(int32)¦null

false

none

none

rangeValue

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexRangeValueDTO

false

none

none

Enumerated Values

Property

Value

special

CurrentWebUser

special

CurrentDate

special

CurrentRowValue

special

WorkflowFormID

json
{
  "text": "string",
  "numeric": 0.1,
  "date": "2019-08-24T14:15:22Z",
  "special": "CurrentWebUser",
  "valueId": 0,
  "rangeValue": {
    "min": null,
    "max": null
  }
}

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFiltersDTO

Properties

Name

Type

Required

Restrictions

Description

filters

[RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterDTO]¦null

false

none

none

json
{
  "filters": [
    {
      "constraint": {},
      "and": {},
      "or": {},
      "not": {},
      "metadata": {}
    }
  ]
}

RESTAPI.v1.DTOs.Publisher.NodeData

Properties

Name

Type

Required

Restrictions

Description

createdAt

string(date-time)¦null

false

none

none

fileExtension

string¦null

false

none

none

fileName

string¦null

false

none

none

uuid

string¦null

false

none

none

fileType

string¦null

false

none

none

location

string¦null

false

none

none

expiresAt

string(date-time)¦null

false

none

none

size

integer(int64)¦null

false

none

none

json
{
  "createdAt": "2019-08-24T14:15:22Z",
  "fileExtension": "string",
  "fileName": "string",
  "uuid": "string",
  "fileType": "string",
  "location": "string",
  "expiresAt": "2019-08-24T14:15:22Z",
  "size": 0
}

RESTAPI.v1.DTOs.Publisher.PublishedFileDTO

Properties

Name

Type

Required

Restrictions

Description

uuid

string(uuid)

false

none

none

fileName

string¦null

false

none

none

fileExtension

string¦null

false

none

none

location

string¦null

false

none

none

createdAt

string(date-time)

false

none

none

expiresAt

string(date-time)¦null

false

none

none

json
{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "fileName": "string",
  "fileExtension": "string",
  "location": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "expiresAt": "2019-08-24T14:15:22Z"
}

RESTAPI.v1.DTOs.Publisher.PublishedNodeDTO

Properties

Name

Type

Required

Restrictions

Description

parent

string¦null

false

none

none

children

[RESTAPI.v1.DTOs.Publisher.PublishedNodeDTO]¦null

false

none

none

nodeData

RESTAPI.v1.DTOs.Publisher.NodeData

false

none

none

nodeId

string¦null

false

none

none

json
{
  "parent": "string",
  "children": [],
  "nodeData": {
    "createdAt": "2019-08-24T14:15:22Z",
    "fileExtension": "string",
    "fileName": "string",
    "uuid": "string",
    "fileType": "string",
    "location": "string",
    "expiresAt": "2019-08-24T14:15:22Z",
    "size": 0
  },
  "nodeId": "string"
}

RESTAPI.v1.DTOs.Pulse.CompPlanValidationItemDTO

Properties

Name

Type

Required

Restrictions

Description

level

integer(int32)

false

none

none

code

integer(int32)

false

none

none

affectedColumn

RESTAPI.v1.DTOs.Pulse.TagColumnDTORESTAPI.v1.DTOs.Pulse.TagColumnDTO

false

none

none

affectedTagType

integer(int32)

false

none

none

json
{
  "level": 0,
  "code": 0,
  "affectedColumn": {
    "displayName": "string",
    "value": 0,
    "allowedTypes": [
      "String"
    ]
  },
  "affectedTagType": 0
}

RESTAPI.v1.DTOs.Pulse.PulseMetricDTO

Properties

Name

Type

Required

Restrictions

Description

planId

integer(int32)

false

none

none

metricType

string

false

none

none

value

any

false

none

none

Enumerated Values

Property

Value

metricType

PayeeNumberOf

metricType

PayeeExceedQuota

metricType

PayeeWithTransactions

metricType

OperationalDaysToPayday

metricType

PayPeriodStartDate

json
{
  "planId": 0,
  "metricType": "PayeeNumberOf",
  "value": null
}

RESTAPI.v1.DTOs.Pulse.PulsePlanDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

name

string¦null

false

none

none

description

string¦null

false

none

none

highlightColor

string¦null

false

none

none

creationDate

string(date-time)

false

none

none

workflowObjectId

integer(int32)

false

none

none

settings

RESTAPI.v1.DTOs.Pulse.PulsePlanSettingsDTO

false

none

none

tagged

[RESTAPI.v1.DTOs.Pulse.TaggedDTO]¦null

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "id": 0,
  "name": "string",
  "description": "string",
  "highlightColor": "string",
  "creationDate": "2019-08-24T14:15:22Z",
  "workflowObjectId": 0,
  "settings": {
    "id": 0,
    "planId": 0,
    "calendarId": "string",
    "calendarLevel": "string",
    "calendarStartDate": "2019-08-24T14:15:22Z",
    "calendarEndDate": "2019-08-24T14:15:22Z",
    "payDayExampleDate": "2019-08-24T14:15:22Z",
    "payDayFrequencyType": 0,
    "payDayPrimaryValue": 0,
    "payDaySecondaryValue": 0,
    "payDayCountFromEndOfMonth": true,
    "workflowGroupId": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "tagged": [
    {
      "id": 0,
      "planId": 0,
      "tagType": 0,
      "taggedTo": "string",
      "mappings": [],
      "restrictions": {},
      "valid": true,
      "validationItems": [],
      "displayName": "string",
      "version": {}
    }
  ],
  "version": {
    "rowVersion": 0
  }
}

RESTAPI.v1.DTOs.Pulse.PulsePlanSettingsDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

planId

integer(int32)

false

none

none

calendarId

string¦null

false

none

none

calendarLevel

string¦null

false

none

none

calendarStartDate

string(date-time)¦null

false

none

none

calendarEndDate

string(date-time)¦null

false

none

none

payDayExampleDate

string(date-time)

false

none

none

payDayFrequencyType

integer(int32)

false

none

none

payDayPrimaryValue

integer(int32)

false

none

none

payDaySecondaryValue

integer(int32)

false

none

none

payDayCountFromEndOfMonth

boolean

false

none

none

workflowGroupId

integer(int32)¦null

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "id": 0,
  "planId": 0,
  "calendarId": "string",
  "calendarLevel": "string",
  "calendarStartDate": "2019-08-24T14:15:22Z",
  "calendarEndDate": "2019-08-24T14:15:22Z",
  "payDayExampleDate": "2019-08-24T14:15:22Z",
  "payDayFrequencyType": 0,
  "payDayPrimaryValue": 0,
  "payDaySecondaryValue": 0,
  "payDayCountFromEndOfMonth": true,
  "workflowGroupId": 0,
  "version": {
    "rowVersion": 0
  }
}

RESTAPI.v1.DTOs.Pulse.ReportDefaultParametersDTO

Properties

Name

Type

Required

Restrictions

Description

columnMappings

object¦null

false

none

none

» additionalProperties

string

false

none

none

columnOptions

object¦null

false

none

none

» additionalProperties

[string]

false

none

none

reportType

string

false

none

none

Enumerated Values

Property

Value

reportType

Undefined

reportType

TransactionsProductionsResults

reportType

CompensationSummary

reportType

PerformanceReport

reportType

SalesManagerOverview

reportType

Overview

reportType

PayeePerformanceReport

reportType

PerformanceOTE

reportType

SalesVsAttainment

reportType

PerformanceDistribution

reportType

PerformanceDistributionByRole

reportType

PayDistribution

json
{
  "columnMappings": {
    "property1": "string",
    "property2": "string"
  },
  "columnOptions": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "reportType": "Undefined"
}

RESTAPI.v1.DTOs.Pulse.TagColumnDTO

Properties

Name

Type

Required

Restrictions

Description

displayName

string¦null

false

none

none

value

integer(int32)

false

none

none

allowedTypes

[string]¦null

false

none

none

json
{
  "displayName": "string",
  "value": 0,
  "allowedTypes": [
    "String"
  ]
}

RESTAPI.v1.DTOs.Pulse.TagMappingDTO

Properties

Name

Type

Required

Restrictions

Description

tagColumn

integer(int32)

false

none

none

taggedToTable

string¦null

false

none

none

taggedToColumn

string¦null

false

none

none

json
{
  "tagColumn": 0,
  "taggedToTable": "string",
  "taggedToColumn": "string"
}

RESTAPI.v1.DTOs.Pulse.TaggableDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

displayName

string¦null

false

none

none

columns

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

none

frequencyColumns

[string]¦null

false

none

none

payeeColumns

[string]¦null

false

none

none

objectType

string

false

none

none

Enumerated Values

Property

Value

objectType

Undefined

objectType

Calculation

objectType

Table

json
{
  "name": "string",
  "displayName": "string",
  "columns": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "frequencyColumns": [
    "string"
  ],
  "payeeColumns": [
    "string"
  ],
  "objectType": "Undefined"
}

RESTAPI.v1.DTOs.Pulse.TaggedDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

planId

integer(int32)

false

none

none

tagType

integer(int32)

false

none

none

taggedTo

string¦null

false

none

none

mappings

[RESTAPI.v1.DTOs.Pulse.TagMappingDTO]¦null

false

none

none

restrictions

Varicent.RESTAPI.v1.DTOs.QuerySourceDefinitionDTO Varicent.RESTAPI.v1.DTOs.QuerySourceDefinitionDTO

false

none

none

valid

boolean

false

none

none

validationItems

[RESTAPI.v1.DTOs.Pulse.CompPlanValidationItemDTO]¦null

false

none

none

displayName

string¦null

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "id": 0,
  "planId": 0,
  "tagType": 0,
  "taggedTo": "string",
  "mappings": [
    {
      "tagColumn": 0,
      "taggedToTable": "string",
      "taggedToColumn": "string"
    }
  ],
  "restrictions": {
    "name": "string",
    "sourceDefinition": {
      "query": {},
      "sourceNames": {}
    },
    "dependencies": [
      "string"
    ],
    "columns": [
      {}
    ],
    "references": {
      "property1": "string",
      "property2": "string"
    },
    "timeReferences": {
      "property1": {},
      "property2": {}
    }
  },
  "valid": true,
  "validationItems": [
    {
      "level": 0,
      "code": 0,
      "affectedColumn": {},
      "affectedTagType": 0
    }
  ],
  "displayName": "string",
  "version": {
    "rowVersion": 0
  }
}

RESTAPI.v1.DTOs.RapidReport.RapidReportAttributeDTOV1

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

mappedAttributeName

string¦null

false

none

none

displayName

string¦null

false

none

none

type

string

false

none

none

isUserDefined

boolean

false

none

none

Enumerated Values

Property

Value

type

String

type

Number

type

Currency

type

Percent

type

Date

json
{
  "name": "string",
  "mappedAttributeName": "string",
  "displayName": "string",
  "type": "String",
  "isUserDefined": true
}

RESTAPI.v1.DTOs.RapidReport.RapidReportDTOV1

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

name

string¦null

false

none

none

definitionName

string¦null

false

none

none

workflowObjectId

integer(int32)¦null

false

none

none

calendarTimeId

string¦null

false

none

none

calendarLevel

string¦null

false

none

none

sources

[RESTAPI.v1.DTOs.RapidReport.RapidReportSourceDTOV1]¦null

false

none

none

metadata

object¦null

false

none

none

» additionalProperties

any

false

none

none

hierarchyID

integer(int32)¦null

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "id": 0,
  "name": "string",
  "definitionName": "string",
  "workflowObjectId": 0,
  "calendarTimeId": "string",
  "calendarLevel": "string",
  "sources": [
    {
      "name": "string",
      "mappedSourceName": "string",
      "timeFilterMode": "None",
      "timeFilterMappings": {},
      "restrictions": {},
      "attributes": [],
      "mappedDatastoreId": 0,
      "hierarchyPeriodColumn": "string"
    }
  ],
  "metadata": {
    "property1": null,
    "property2": null
  },
  "hierarchyID": 0,
  "version": {
    "rowVersion": 0
  }
}

RESTAPI.v1.DTOs.RapidReport.RapidReportDataAttributeSchemaDTOV1

Properties

Name

Type

Required

Restrictions

Description

attributeType

string

false

none

none

Enumerated Values

Property

Value

attributeType

String

attributeType

Number

attributeType

Currency

attributeType

Percent

attributeType

Date

json
{
  "attributeType": "String"
}

RESTAPI.v1.DTOs.RapidReport.RapidReportDataSourceDTOV1

Properties

Name

Type

Required

Restrictions

Description

dataRows

[object]¦null

false

none

none

» additionalProperties

any

false

none

none

schema

object¦null

false

none

none

» additionalProperties

RESTAPI.v1.DTOs.RapidReport.RapidReportDataAttributeSchemaDTOV1

false

none

none

totalRows

integer(int32)

false

none

none

json
{
  "dataRows": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "schema": {
    "property1": {
      "attributeType": "String"
    },
    "property2": {
      "attributeType": "String"
    }
  },
  "totalRows": 0
}

RESTAPI.v1.DTOs.RapidReport.RapidReportDefinitionAttributeDTOV1

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

type

string

false

none

none

isPayeeFilter

boolean

false

none

none

isRequired

boolean

false

none

none

Enumerated Values

Property

Value

type

String

type

Number

type

Currency

type

Percent

type

Date

json
{
  "name": "string",
  "type": "String",
  "isPayeeFilter": true,
  "isRequired": true
}

RESTAPI.v1.DTOs.RapidReport.RapidReportDefinitionDTOV1

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

sources

[RESTAPI.v1.DTOs.RapidReport.RapidReportDefinitionSourceDTOV1]¦null

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "name": "string",
  "sources": [
    {
      "name": "string",
      "attributes": []
    }
  ],
  "version": {
    "rowVersion": 0
  }
}

RESTAPI.v1.DTOs.RapidReport.RapidReportDefinitionSourceDTOV1

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

attributes

[RESTAPI.v1.DTOs.RapidReport.RapidReportDefinitionAttributeDTOV1]¦null

false

none

none

json
{
  "name": "string",
  "attributes": [
    {
      "name": "string",
      "type": "String",
      "isPayeeFilter": true,
      "isRequired": true
    }
  ]
}

RESTAPI.v1.DTOs.RapidReport.RapidReportMappableSourceDTOV1

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

displayName

string¦null

false

none

none

columns

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

none

datastoreId

integer(int32)¦null

false

none

none

joinCount

integer(int32)¦null

false

none

none

json
{
  "name": "string",
  "displayName": "string",
  "columns": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "datastoreId": 0,
  "joinCount": 0
}

RESTAPI.v1.DTOs.RapidReport.RapidReportSourceDTOV1

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

mappedSourceName

string¦null

false

none

none

timeFilterMode

string

false

none

none

timeFilterMappings

RESTAPI.v1.DTOs.RapidReport.RapidReportSourceTimeFilterMappingsDTOV1

false

none

none

restrictions

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

attributes

[RESTAPI.v1.DTOs.RapidReport.RapidReportAttributeDTOV1]¦null

false

none

none

mappedDatastoreId

integer(int32)¦null

false

none

none

hierarchyPeriodColumn

string¦null

false

none

none

Enumerated Values

Property

Value

timeFilterMode

None

timeFilterMode

Period

timeFilterMode

EffectiveDateRange

timeFilterMode

Date

json
{
  "name": "string",
  "mappedSourceName": "string",
  "timeFilterMode": "None",
  "timeFilterMappings": {
    "periodMappedColumnName": "string",
    "rangeStartDateMappedColumnName": "string",
    "rangeEndDateMappedColumnName": "string",
    "dateMappedColumnName": "string"
  },
  "restrictions": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "attributes": [
    {
      "name": "string",
      "mappedAttributeName": "string",
      "displayName": "string",
      "type": "String",
      "isUserDefined": true
    }
  ],
  "mappedDatastoreId": 0,
  "hierarchyPeriodColumn": "string"
}

RESTAPI.v1.DTOs.RapidReport.RapidReportSourceTimeFilterMappingsDTOV1

Properties

Name

Type

Required

Restrictions

Description

periodMappedColumnName

string¦null

false

none

none

rangeStartDateMappedColumnName

string¦null

false

none

none

rangeEndDateMappedColumnName

string¦null

false

none

none

dateMappedColumnName

string¦null

false

none

none

json
{
  "periodMappedColumnName": "string",
  "rangeStartDateMappedColumnName": "string",
  "rangeEndDateMappedColumnName": "string",
  "dateMappedColumnName": "string"
}

RESTAPI.v1.DTOs.Replication.ChangeReplicationDTO

Properties

Name

Type

Required

Restrictions

Description

tenantSecretArn

string¦null

false

none

none

proxyName

string¦null

false

none

none

json
{
  "tenantSecretArn": "string",
  "proxyName": "string"
}

RESTAPI.v1.DTOs.ScheduleItemPatchDTO

Properties

Name

Type

Required

Restrictions

Description

order

integer(int32)

false

none

none

runInParallel

boolean¦null

false

none

none

json
{
  "order": 0,
  "runInParallel": true
}

RESTAPI.v1.DTOs.Scheduler.DeprecatedScheduleItemIndexRebuildDTO

Properties

Name

Type

Required

Restrictions

Description

calculationIDs

[integer]¦null

false

none

none

tables

[string]¦null

false

none

none

calculationIDsV2

object¦null

false

none

none

» additionalProperties

boolean¦null

false

none

none

tablesV2

object¦null

false

none

none

» additionalProperties

boolean¦null

false

none

none

id

integer(int32)

false

none

none

name

string¦null

false

none

none

scheduleItemType

string

false

none

none

order

integer(int32)

false

none

none

lastRun

string(date-time)

false

none

none

lastRunStatus

string

false

none

none

activation

string

false

none

none

nextRun

string(date-time)

false

none

none

parent

integer(int32)¦null

false

none

none

scheduledTime

Varicent.RESTAPI.v1.DTOs.Scheduler.ScheduleTimeDTO

false

none

none

parentItem

Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO

false

none

none

childScheduleItems

[Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO]¦null

false

none

none

settings

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

previousName

string¦null

false

none

none

runInParallel

boolean

false

none

none

externalItemID

string¦null

false

none

none

ptzId

string¦null

false

none

none

Enumerated Values

Property

Value

scheduleItemType

Folder

scheduleItemType

Calculation

scheduleItemType

Import

scheduleItemType

ExternalTool

scheduleItemType

TaskGeneration

scheduleItemType

StarSchemaPopulation

scheduleItemType

LockPeriod

scheduleItemType

EnableWeb

scheduleItemType

DisableWeb

scheduleItemType

Plan

scheduleItemType

Transformation

scheduleItemType

ClearTable

scheduleItemType

Publish

scheduleItemType

WebReport

scheduleItemType

Optimize

scheduleItemType

TaskRun

scheduleItemType

AddWorkflowMembers

scheduleItemType

UnassignIdleInquiries

scheduleItemType

PurgeHistory

scheduleItemType

ExpiringPasswordEmailNotificationAdmin

scheduleItemType

ExpiringPasswordEmailNotificationWeb

scheduleItemType

EnableWebUsers

scheduleItemType

CloudExternalTool

scheduleItemType

CloudSystemTool

scheduleItemType

IndexRebuild

scheduleItemType

PublishQueryTool

scheduleItemType

CalculateAndLock

scheduleItemType

HealthDashboardEvaluation

scheduleItemType

CalculationComponent

scheduleItemType

RefreshMaterializedView

scheduleItemType

RemoveWorkflowMembers

scheduleItemType

ELTRun

scheduleItemType

CalculationPlanBuilder

lastRunStatus

Success

lastRunStatus

Warning

lastRunStatus

Error

lastRunStatus

Cancelled

lastRunStatus

None

activation

Enabled

activation

DisabledForNextScheduledRunOnly

activation

Disabled

json
{
  "calculationIDs": [
    0
  ],
  "tables": [
    "string"
  ],
  "calculationIDsV2": {
    "property1": true,
    "property2": true
  },
  "tablesV2": {
    "property1": true,
    "property2": true
  },
  "id": 0,
  "name": "string",
  "scheduleItemType": "Folder",
  "order": 0,
  "lastRun": "2019-08-24T14:15:22Z",
  "lastRunStatus": "Success",
  "activation": "Enabled",
  "nextRun": "2019-08-24T14:15:22Z",
  "parent": 0,
  "scheduledTime": {
    "id": 0,
    "scheduleItemId": 0,
    "minute": 0,
    "hour": 0,
    "dayOfMonth": 0,
    "month": 0,
    "dayOfWeek": 0,
    "nextRunTime": "2019-08-24T14:15:22Z",
    "isDSTAdjusted": true,
    "version": {
      "rowVersion": 0
    }
  },
  "parentItem": {
    "id": 0,
    "name": "string",
    "scheduleItemType": "Folder",
    "order": 0,
    "lastRun": "2019-08-24T14:15:22Z",
    "lastRunStatus": "Success",
    "activation": "Enabled",
    "nextRun": "2019-08-24T14:15:22Z",
    "parent": 0,
    "scheduledTime": {
      "id": 0,
      "scheduleItemId": 0,
      "minute": 0,
      "hour": 0,
      "dayOfMonth": 0,
      "month": 0,
      "dayOfWeek": 0,
      "nextRunTime": "2019-08-24T14:15:22Z",
      "isDSTAdjusted": true,
      "version": {}
    },
    "parentItem": null,
    "childScheduleItems": [],
    "settings": {
      "schedulerSettingsId": 0,
      "scheduleItemId": 0,
      "parentSettingsID": 0,
      "emailOnFailure": true,
      "emailOnSuccess": true,
      "stopOnFailure": true,
      "stopToolOnTimeout": true,
      "isGlobal": true,
      "overrideChildSettings": true,
      "successEmails": [],
      "failEmails": [],
      "externalToolTimeout": 0,
      "parentSettings": null,
      "enableRetries": true,
      "retries": 0,
      "interval": 0,
      "version": {}
    },
    "version": {
      "rowVersion": 0
    },
    "previousName": "string",
    "runInParallel": true,
    "externalItemID": "string",
    "ptzId": "string"
  },
  "childScheduleItems": [
    {
      "id": 0,
      "name": "string",
      "scheduleItemType": "Folder",
      "order": 0,
      "lastRun": "2019-08-24T14:15:22Z",
      "lastRunStatus": "Success",
      "activation": "Enabled",
      "nextRun": "2019-08-24T14:15:22Z",
      "parent": 0,
      "scheduledTime": {},
      "parentItem": null,
      "childScheduleItems": [],
      "settings": {},
      "version": {},
      "previousName": "string",
      "runInParallel": true,
      "externalItemID": "string",
      "ptzId": "string"
    }
  ],
  "settings": {
    "schedulerSettingsId": 0,
    "scheduleItemId": 0,
    "parentSettingsID": 0,
    "emailOnFailure": true,
    "emailOnSuccess": true,
    "stopOnFailure": true,
    "stopToolOnTimeout": true,
    "isGlobal": true,
    "overrideChildSettings": true,
    "successEmails": [
      "string"
    ],
    "failEmails": [
      "string"
    ],
    "externalToolTimeout": 0,
    "parentSettings": null,
    "enableRetries": true,
    "retries": 0,
    "interval": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "version": {
    "rowVersion": 0
  },
  "previousName": "string",
  "runInParallel": true,
  "externalItemID": "string",
  "ptzId": "string"
}

RESTAPI.v1.DTOs.Scheduler.ScheduleItemCloudExternalToolDTO

Properties

Name

Type

Required

Restrictions

Description

command

string¦null

false

none

none

executable

string¦null

false

none

none

id

integer(int32)

false

none

none

name

string¦null

false

none

none

scheduleItemType

string

false

none

none

order

integer(int32)

false

none

none

lastRun

string(date-time)

false

none

none

lastRunStatus

string

false

none

none

activation

string

false

none

none

nextRun

string(date-time)

false

none

none

parent

integer(int32)¦null

false

none

none

scheduledTime

Varicent.RESTAPI.v1.DTOs.Scheduler.ScheduleTimeDTO

false

none

none

parentItem

Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO

false

none

none

childScheduleItems

[Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO]¦null

false

none

none

settings

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

previousName

string¦null

false

none

none

runInParallel

boolean

false

none

none

externalItemID

string¦null

false

none

none

ptzId

string¦null

false

none

none

Enumerated Values

Property

Value

scheduleItemType

Folder

scheduleItemType

Calculation

scheduleItemType

Import

scheduleItemType

ExternalTool

scheduleItemType

TaskGeneration

scheduleItemType

StarSchemaPopulation

scheduleItemType

LockPeriod

scheduleItemType

EnableWeb

scheduleItemType

DisableWeb

scheduleItemType

Plan

scheduleItemType

Transformation

scheduleItemType

ClearTable

scheduleItemType

Publish

scheduleItemType

WebReport

scheduleItemType

Optimize

scheduleItemType

TaskRun

scheduleItemType

AddWorkflowMembers

scheduleItemType

UnassignIdleInquiries

scheduleItemType

PurgeHistory

scheduleItemType

ExpiringPasswordEmailNotificationAdmin

scheduleItemType

ExpiringPasswordEmailNotificationWeb

scheduleItemType

EnableWebUsers

scheduleItemType

CloudExternalTool

scheduleItemType

CloudSystemTool

scheduleItemType

IndexRebuild

scheduleItemType

PublishQueryTool

scheduleItemType

CalculateAndLock

scheduleItemType

HealthDashboardEvaluation

scheduleItemType

CalculationComponent

scheduleItemType

RefreshMaterializedView

scheduleItemType

RemoveWorkflowMembers

scheduleItemType

ELTRun

scheduleItemType

CalculationPlanBuilder

lastRunStatus

Success

lastRunStatus

Warning

lastRunStatus

Error

lastRunStatus

Cancelled

lastRunStatus

None

activation

Enabled

activation

DisabledForNextScheduledRunOnly

activation

Disabled

json
{
  "command": "string",
  "executable": "string",
  "id": 0,
  "name": "string",
  "scheduleItemType": "Folder",
  "order": 0,
  "lastRun": "2019-08-24T14:15:22Z",
  "lastRunStatus": "Success",
  "activation": "Enabled",
  "nextRun": "2019-08-24T14:15:22Z",
  "parent": 0,
  "scheduledTime": {
    "id": 0,
    "scheduleItemId": 0,
    "minute": 0,
    "hour": 0,
    "dayOfMonth": 0,
    "month": 0,
    "dayOfWeek": 0,
    "nextRunTime": "2019-08-24T14:15:22Z",
    "isDSTAdjusted": true,
    "version": {
      "rowVersion": 0
    }
  },
  "parentItem": {
    "id": 0,
    "name": "string",
    "scheduleItemType": "Folder",
    "order": 0,
    "lastRun": "2019-08-24T14:15:22Z",
    "lastRunStatus": "Success",
    "activation": "Enabled",
    "nextRun": "2019-08-24T14:15:22Z",
    "parent": 0,
    "scheduledTime": {
      "id": 0,
      "scheduleItemId": 0,
      "minute": 0,
      "hour": 0,
      "dayOfMonth": 0,
      "month": 0,
      "dayOfWeek": 0,
      "nextRunTime": "2019-08-24T14:15:22Z",
      "isDSTAdjusted": true,
      "version": {}
    },
    "parentItem": null,
    "childScheduleItems": [],
    "settings": {
      "schedulerSettingsId": 0,
      "scheduleItemId": 0,
      "parentSettingsID": 0,
      "emailOnFailure": true,
      "emailOnSuccess": true,
      "stopOnFailure": true,
      "stopToolOnTimeout": true,
      "isGlobal": true,
      "overrideChildSettings": true,
      "successEmails": [],
      "failEmails": [],
      "externalToolTimeout": 0,
      "parentSettings": null,
      "enableRetries": true,
      "retries": 0,
      "interval": 0,
      "version": {}
    },
    "version": {
      "rowVersion": 0
    },
    "previousName": "string",
    "runInParallel": true,
    "externalItemID": "string",
    "ptzId": "string"
  },
  "childScheduleItems": [
    {
      "id": 0,
      "name": "string",
      "scheduleItemType": "Folder",
      "order": 0,
      "lastRun": "2019-08-24T14:15:22Z",
      "lastRunStatus": "Success",
      "activation": "Enabled",
      "nextRun": "2019-08-24T14:15:22Z",
      "parent": 0,
      "scheduledTime": {},
      "parentItem": null,
      "childScheduleItems": [],
      "settings": {},
      "version": {},
      "previousName": "string",
      "runInParallel": true,
      "externalItemID": "string",
      "ptzId": "string"
    }
  ],
  "settings": {
    "schedulerSettingsId": 0,
    "scheduleItemId": 0,
    "parentSettingsID": 0,
    "emailOnFailure": true,
    "emailOnSuccess": true,
    "stopOnFailure": true,
    "stopToolOnTimeout": true,
    "isGlobal": true,
    "overrideChildSettings": true,
    "successEmails": [
      "string"
    ],
    "failEmails": [
      "string"
    ],
    "externalToolTimeout": 0,
    "parentSettings": null,
    "enableRetries": true,
    "retries": 0,
    "interval": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "version": {
    "rowVersion": 0
  },
  "previousName": "string",
  "runInParallel": true,
  "externalItemID": "string",
  "ptzId": "string"
}

RESTAPI.v1.DTOs.Scheduler.ScheduleItemCloudSystemToolDTO

Properties

Name

Type

Required

Restrictions

Description

systemToolType

string

false

none

none

arguments

string¦null

false

none

none

id

integer(int32)

false

none

none

name

string¦null

false

none

none

scheduleItemType

string

false

none

none

order

integer(int32)

false

none

none

lastRun

string(date-time)

false

none

none

lastRunStatus

string

false

none

none

activation

string

false

none

none

nextRun

string(date-time)

false

none

none

parent

integer(int32)¦null

false

none

none

scheduledTime

Varicent.RESTAPI.v1.DTOs.Scheduler.ScheduleTimeDTO

false

none

none

parentItem

Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO

false

none

none

childScheduleItems

[Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO]¦null

false

none

none

settings

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

previousName

string¦null

false

none

none

runInParallel

boolean

false

none

none

externalItemID

string¦null

false

none

none

ptzId

string¦null

false

none

none

Enumerated Values

Property

Value

systemToolType

PGPEncrypt

systemToolType

PGPDecrypt

scheduleItemType

Folder

scheduleItemType

Calculation

scheduleItemType

Import

scheduleItemType

ExternalTool

scheduleItemType

TaskGeneration

scheduleItemType

StarSchemaPopulation

scheduleItemType

LockPeriod

scheduleItemType

EnableWeb

scheduleItemType

DisableWeb

scheduleItemType

Plan

scheduleItemType

Transformation

scheduleItemType

ClearTable

scheduleItemType

Publish

scheduleItemType

WebReport

scheduleItemType

Optimize

scheduleItemType

TaskRun

scheduleItemType

AddWorkflowMembers

scheduleItemType

UnassignIdleInquiries

scheduleItemType

PurgeHistory

scheduleItemType

ExpiringPasswordEmailNotificationAdmin

scheduleItemType

ExpiringPasswordEmailNotificationWeb

scheduleItemType

EnableWebUsers

scheduleItemType

CloudExternalTool

scheduleItemType

CloudSystemTool

scheduleItemType

IndexRebuild

scheduleItemType

PublishQueryTool

scheduleItemType

CalculateAndLock

scheduleItemType

HealthDashboardEvaluation

scheduleItemType

CalculationComponent

scheduleItemType

RefreshMaterializedView

scheduleItemType

RemoveWorkflowMembers

scheduleItemType

ELTRun

scheduleItemType

CalculationPlanBuilder

lastRunStatus

Success

lastRunStatus

Warning

lastRunStatus

Error

lastRunStatus

Cancelled

lastRunStatus

None

activation

Enabled

activation

DisabledForNextScheduledRunOnly

activation

Disabled

json
{
  "systemToolType": "PGPEncrypt",
  "arguments": "string",
  "id": 0,
  "name": "string",
  "scheduleItemType": "Folder",
  "order": 0,
  "lastRun": "2019-08-24T14:15:22Z",
  "lastRunStatus": "Success",
  "activation": "Enabled",
  "nextRun": "2019-08-24T14:15:22Z",
  "parent": 0,
  "scheduledTime": {
    "id": 0,
    "scheduleItemId": 0,
    "minute": 0,
    "hour": 0,
    "dayOfMonth": 0,
    "month": 0,
    "dayOfWeek": 0,
    "nextRunTime": "2019-08-24T14:15:22Z",
    "isDSTAdjusted": true,
    "version": {
      "rowVersion": 0
    }
  },
  "parentItem": {
    "id": 0,
    "name": "string",
    "scheduleItemType": "Folder",
    "order": 0,
    "lastRun": "2019-08-24T14:15:22Z",
    "lastRunStatus": "Success",
    "activation": "Enabled",
    "nextRun": "2019-08-24T14:15:22Z",
    "parent": 0,
    "scheduledTime": {
      "id": 0,
      "scheduleItemId": 0,
      "minute": 0,
      "hour": 0,
      "dayOfMonth": 0,
      "month": 0,
      "dayOfWeek": 0,
      "nextRunTime": "2019-08-24T14:15:22Z",
      "isDSTAdjusted": true,
      "version": {}
    },
    "parentItem": null,
    "childScheduleItems": [],
    "settings": {
      "schedulerSettingsId": 0,
      "scheduleItemId": 0,
      "parentSettingsID": 0,
      "emailOnFailure": true,
      "emailOnSuccess": true,
      "stopOnFailure": true,
      "stopToolOnTimeout": true,
      "isGlobal": true,
      "overrideChildSettings": true,
      "successEmails": [],
      "failEmails": [],
      "externalToolTimeout": 0,
      "parentSettings": null,
      "enableRetries": true,
      "retries": 0,
      "interval": 0,
      "version": {}
    },
    "version": {
      "rowVersion": 0
    },
    "previousName": "string",
    "runInParallel": true,
    "externalItemID": "string",
    "ptzId": "string"
  },
  "childScheduleItems": [
    {
      "id": 0,
      "name": "string",
      "scheduleItemType": "Folder",
      "order": 0,
      "lastRun": "2019-08-24T14:15:22Z",
      "lastRunStatus": "Success",
      "activation": "Enabled",
      "nextRun": "2019-08-24T14:15:22Z",
      "parent": 0,
      "scheduledTime": {},
      "parentItem": null,
      "childScheduleItems": [],
      "settings": {},
      "version": {},
      "previousName": "string",
      "runInParallel": true,
      "externalItemID": "string",
      "ptzId": "string"
    }
  ],
  "settings": {
    "schedulerSettingsId": 0,
    "scheduleItemId": 0,
    "parentSettingsID": 0,
    "emailOnFailure": true,
    "emailOnSuccess": true,
    "stopOnFailure": true,
    "stopToolOnTimeout": true,
    "isGlobal": true,
    "overrideChildSettings": true,
    "successEmails": [
      "string"
    ],
    "failEmails": [
      "string"
    ],
    "externalToolTimeout": 0,
    "parentSettings": null,
    "enableRetries": true,
    "retries": 0,
    "interval": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "version": {
    "rowVersion": 0
  },
  "previousName": "string",
  "runInParallel": true,
  "externalItemID": "string",
  "ptzId": "string"
}

RESTAPI.v1.DTOs.Scheduler.ScheduleItemELTRunDTO

Properties

Name

Type

Required

Restrictions

Description

scheduleItemID

integer(int32)

false

none

none

pipeID

string¦null

false

none

none

refreshAllPipeSources

boolean

false

none

none

id

integer(int32)

false

none

none

name

string¦null

false

none

none

scheduleItemType

string

false

none

none

order

integer(int32)

false

none

none

lastRun

string(date-time)

false

none

none

lastRunStatus

string

false

none

none

activation

string

false

none

none

nextRun

string(date-time)

false

none

none

parent

integer(int32)¦null

false

none

none

scheduledTime

Varicent.RESTAPI.v1.DTOs.Scheduler.ScheduleTimeDTO

false

none

none

parentItem

Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO

false

none

none

childScheduleItems

[Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO]¦null

false

none

none

settings

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

previousName

string¦null

false

none

none

runInParallel

boolean

false

none

none

externalItemID

string¦null

false

none

none

ptzId

string¦null

false

none

none

Enumerated Values

Property

Value

scheduleItemType

Folder

scheduleItemType

Calculation

scheduleItemType

Import

scheduleItemType

ExternalTool

scheduleItemType

TaskGeneration

scheduleItemType

StarSchemaPopulation

scheduleItemType

LockPeriod

scheduleItemType

EnableWeb

scheduleItemType

DisableWeb

scheduleItemType

Plan

scheduleItemType

Transformation

scheduleItemType

ClearTable

scheduleItemType

Publish

scheduleItemType

WebReport

scheduleItemType

Optimize

scheduleItemType

TaskRun

scheduleItemType

AddWorkflowMembers

scheduleItemType

UnassignIdleInquiries

scheduleItemType

PurgeHistory

scheduleItemType

ExpiringPasswordEmailNotificationAdmin

scheduleItemType

ExpiringPasswordEmailNotificationWeb

scheduleItemType

EnableWebUsers

scheduleItemType

CloudExternalTool

scheduleItemType

CloudSystemTool

scheduleItemType

IndexRebuild

scheduleItemType

PublishQueryTool

scheduleItemType

CalculateAndLock

scheduleItemType

HealthDashboardEvaluation

scheduleItemType

CalculationComponent

scheduleItemType

RefreshMaterializedView

scheduleItemType

RemoveWorkflowMembers

scheduleItemType

ELTRun

scheduleItemType

CalculationPlanBuilder

lastRunStatus

Success

lastRunStatus

Warning

lastRunStatus

Error

lastRunStatus

Cancelled

lastRunStatus

None

activation

Enabled

activation

DisabledForNextScheduledRunOnly

activation

Disabled

json
{
  "scheduleItemID": 0,
  "pipeID": "string",
  "refreshAllPipeSources": true,
  "id": 0,
  "name": "string",
  "scheduleItemType": "Folder",
  "order": 0,
  "lastRun": "2019-08-24T14:15:22Z",
  "lastRunStatus": "Success",
  "activation": "Enabled",
  "nextRun": "2019-08-24T14:15:22Z",
  "parent": 0,
  "scheduledTime": {
    "id": 0,
    "scheduleItemId": 0,
    "minute": 0,
    "hour": 0,
    "dayOfMonth": 0,
    "month": 0,
    "dayOfWeek": 0,
    "nextRunTime": "2019-08-24T14:15:22Z",
    "isDSTAdjusted": true,
    "version": {
      "rowVersion": 0
    }
  },
  "parentItem": {
    "id": 0,
    "name": "string",
    "scheduleItemType": "Folder",
    "order": 0,
    "lastRun": "2019-08-24T14:15:22Z",
    "lastRunStatus": "Success",
    "activation": "Enabled",
    "nextRun": "2019-08-24T14:15:22Z",
    "parent": 0,
    "scheduledTime": {
      "id": 0,
      "scheduleItemId": 0,
      "minute": 0,
      "hour": 0,
      "dayOfMonth": 0,
      "month": 0,
      "dayOfWeek": 0,
      "nextRunTime": "2019-08-24T14:15:22Z",
      "isDSTAdjusted": true,
      "version": {}
    },
    "parentItem": null,
    "childScheduleItems": [],
    "settings": {
      "schedulerSettingsId": 0,
      "scheduleItemId": 0,
      "parentSettingsID": 0,
      "emailOnFailure": true,
      "emailOnSuccess": true,
      "stopOnFailure": true,
      "stopToolOnTimeout": true,
      "isGlobal": true,
      "overrideChildSettings": true,
      "successEmails": [],
      "failEmails": [],
      "externalToolTimeout": 0,
      "parentSettings": null,
      "enableRetries": true,
      "retries": 0,
      "interval": 0,
      "version": {}
    },
    "version": {
      "rowVersion": 0
    },
    "previousName": "string",
    "runInParallel": true,
    "externalItemID": "string",
    "ptzId": "string"
  },
  "childScheduleItems": [
    {
      "id": 0,
      "name": "string",
      "scheduleItemType": "Folder",
      "order": 0,
      "lastRun": "2019-08-24T14:15:22Z",
      "lastRunStatus": "Success",
      "activation": "Enabled",
      "nextRun": "2019-08-24T14:15:22Z",
      "parent": 0,
      "scheduledTime": {},
      "parentItem": null,
      "childScheduleItems": [],
      "settings": {},
      "version": {},
      "previousName": "string",
      "runInParallel": true,
      "externalItemID": "string",
      "ptzId": "string"
    }
  ],
  "settings": {
    "schedulerSettingsId": 0,
    "scheduleItemId": 0,
    "parentSettingsID": 0,
    "emailOnFailure": true,
    "emailOnSuccess": true,
    "stopOnFailure": true,
    "stopToolOnTimeout": true,
    "isGlobal": true,
    "overrideChildSettings": true,
    "successEmails": [
      "string"
    ],
    "failEmails": [
      "string"
    ],
    "externalToolTimeout": 0,
    "parentSettings": null,
    "enableRetries": true,
    "retries": 0,
    "interval": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "version": {
    "rowVersion": 0
  },
  "previousName": "string",
  "runInParallel": true,
  "externalItemID": "string",
  "ptzId": "string"
}

RESTAPI.v1.DTOs.Scheduler.ScheduleItemEnableWebUsersDTO

Properties

Name

Type

Required

Restrictions

Description

portalAccessGroupId

integer(int32)

false

none

none

defaultPwd

string¦null

false

none

none

id

integer(int32)

false

none

none

name

string¦null

false

none

none

scheduleItemType

string

false

none

none

order

integer(int32)

false

none

none

lastRun

string(date-time)

false

none

none

lastRunStatus

string

false

none

none

activation

string

false

none

none

nextRun

string(date-time)

false

none

none

parent

integer(int32)¦null

false

none

none

scheduledTime

Varicent.RESTAPI.v1.DTOs.Scheduler.ScheduleTimeDTO

false

none

none

parentItem

Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO

false

none

none

childScheduleItems

[Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO]¦null

false

none

none

settings

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

previousName

string¦null

false

none

none

runInParallel

boolean

false

none

none

externalItemID

string¦null

false

none

none

ptzId

string¦null

false

none

none

Enumerated Values

Property

Value

scheduleItemType

Folder

scheduleItemType

Calculation

scheduleItemType

Import

scheduleItemType

ExternalTool

scheduleItemType

TaskGeneration

scheduleItemType

StarSchemaPopulation

scheduleItemType

LockPeriod

scheduleItemType

EnableWeb

scheduleItemType

DisableWeb

scheduleItemType

Plan

scheduleItemType

Transformation

scheduleItemType

ClearTable

scheduleItemType

Publish

scheduleItemType

WebReport

scheduleItemType

Optimize

scheduleItemType

TaskRun

scheduleItemType

AddWorkflowMembers

scheduleItemType

UnassignIdleInquiries

scheduleItemType

PurgeHistory

scheduleItemType

ExpiringPasswordEmailNotificationAdmin

scheduleItemType

ExpiringPasswordEmailNotificationWeb

scheduleItemType

EnableWebUsers

scheduleItemType

CloudExternalTool

scheduleItemType

CloudSystemTool

scheduleItemType

IndexRebuild

scheduleItemType

PublishQueryTool

scheduleItemType

CalculateAndLock

scheduleItemType

HealthDashboardEvaluation

scheduleItemType

CalculationComponent

scheduleItemType

RefreshMaterializedView

scheduleItemType

RemoveWorkflowMembers

scheduleItemType

ELTRun

scheduleItemType

CalculationPlanBuilder

lastRunStatus

Success

lastRunStatus

Warning

lastRunStatus

Error

lastRunStatus

Cancelled

lastRunStatus

None

activation

Enabled

activation

DisabledForNextScheduledRunOnly

activation

Disabled

json
{
  "portalAccessGroupId": 0,
  "defaultPwd": "string",
  "id": 0,
  "name": "string",
  "scheduleItemType": "Folder",
  "order": 0,
  "lastRun": "2019-08-24T14:15:22Z",
  "lastRunStatus": "Success",
  "activation": "Enabled",
  "nextRun": "2019-08-24T14:15:22Z",
  "parent": 0,
  "scheduledTime": {
    "id": 0,
    "scheduleItemId": 0,
    "minute": 0,
    "hour": 0,
    "dayOfMonth": 0,
    "month": 0,
    "dayOfWeek": 0,
    "nextRunTime": "2019-08-24T14:15:22Z",
    "isDSTAdjusted": true,
    "version": {
      "rowVersion": 0
    }
  },
  "parentItem": {
    "id": 0,
    "name": "string",
    "scheduleItemType": "Folder",
    "order": 0,
    "lastRun": "2019-08-24T14:15:22Z",
    "lastRunStatus": "Success",
    "activation": "Enabled",
    "nextRun": "2019-08-24T14:15:22Z",
    "parent": 0,
    "scheduledTime": {
      "id": 0,
      "scheduleItemId": 0,
      "minute": 0,
      "hour": 0,
      "dayOfMonth": 0,
      "month": 0,
      "dayOfWeek": 0,
      "nextRunTime": "2019-08-24T14:15:22Z",
      "isDSTAdjusted": true,
      "version": {}
    },
    "parentItem": null,
    "childScheduleItems": [],
    "settings": {
      "schedulerSettingsId": 0,
      "scheduleItemId": 0,
      "parentSettingsID": 0,
      "emailOnFailure": true,
      "emailOnSuccess": true,
      "stopOnFailure": true,
      "stopToolOnTimeout": true,
      "isGlobal": true,
      "overrideChildSettings": true,
      "successEmails": [],
      "failEmails": [],
      "externalToolTimeout": 0,
      "parentSettings": null,
      "enableRetries": true,
      "retries": 0,
      "interval": 0,
      "version": {}
    },
    "version": {
      "rowVersion": 0
    },
    "previousName": "string",
    "runInParallel": true,
    "externalItemID": "string",
    "ptzId": "string"
  },
  "childScheduleItems": [
    {
      "id": 0,
      "name": "string",
      "scheduleItemType": "Folder",
      "order": 0,
      "lastRun": "2019-08-24T14:15:22Z",
      "lastRunStatus": "Success",
      "activation": "Enabled",
      "nextRun": "2019-08-24T14:15:22Z",
      "parent": 0,
      "scheduledTime": {},
      "parentItem": null,
      "childScheduleItems": [],
      "settings": {},
      "version": {},
      "previousName": "string",
      "runInParallel": true,
      "externalItemID": "string",
      "ptzId": "string"
    }
  ],
  "settings": {
    "schedulerSettingsId": 0,
    "scheduleItemId": 0,
    "parentSettingsID": 0,
    "emailOnFailure": true,
    "emailOnSuccess": true,
    "stopOnFailure": true,
    "stopToolOnTimeout": true,
    "isGlobal": true,
    "overrideChildSettings": true,
    "successEmails": [
      "string"
    ],
    "failEmails": [
      "string"
    ],
    "externalToolTimeout": 0,
    "parentSettings": null,
    "enableRetries": true,
    "retries": 0,
    "interval": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "version": {
    "rowVersion": 0
  },
  "previousName": "string",
  "runInParallel": true,
  "externalItemID": "string",
  "ptzId": "string"
}

RESTAPI.v1.DTOs.Scheduler.ScheduleItemIdleInquriesDTO

Properties

Name

Type

Required

Restrictions

Description

idleDaysCap

integer(int32)

false

none

none

id

integer(int32)

false

none

none

name

string¦null

false

none

none

scheduleItemType

string

false

none

none

order

integer(int32)

false

none

none

lastRun

string(date-time)

false

none

none

lastRunStatus

string

false

none

none

activation

string

false

none

none

nextRun

string(date-time)

false

none

none

parent

integer(int32)¦null

false

none

none

scheduledTime

Varicent.RESTAPI.v1.DTOs.Scheduler.ScheduleTimeDTO

false

none

none

parentItem

Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO

false

none

none

childScheduleItems

[Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO]¦null

false

none

none

settings

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

previousName

string¦null

false

none

none

runInParallel

boolean

false

none

none

externalItemID

string¦null

false

none

none

ptzId

string¦null

false

none

none

Enumerated Values

Property

Value

scheduleItemType

Folder

scheduleItemType

Calculation

scheduleItemType

Import

scheduleItemType

ExternalTool

scheduleItemType

TaskGeneration

scheduleItemType

StarSchemaPopulation

scheduleItemType

LockPeriod

scheduleItemType

EnableWeb

scheduleItemType

DisableWeb

scheduleItemType

Plan

scheduleItemType

Transformation

scheduleItemType

ClearTable

scheduleItemType

Publish

scheduleItemType

WebReport

scheduleItemType

Optimize

scheduleItemType

TaskRun

scheduleItemType

AddWorkflowMembers

scheduleItemType

UnassignIdleInquiries

scheduleItemType

PurgeHistory

scheduleItemType

ExpiringPasswordEmailNotificationAdmin

scheduleItemType

ExpiringPasswordEmailNotificationWeb

scheduleItemType

EnableWebUsers

scheduleItemType

CloudExternalTool

scheduleItemType

CloudSystemTool

scheduleItemType

IndexRebuild

scheduleItemType

PublishQueryTool

scheduleItemType

CalculateAndLock

scheduleItemType

HealthDashboardEvaluation

scheduleItemType

CalculationComponent

scheduleItemType

RefreshMaterializedView

scheduleItemType

RemoveWorkflowMembers

scheduleItemType

ELTRun

scheduleItemType

CalculationPlanBuilder

lastRunStatus

Success

lastRunStatus

Warning

lastRunStatus

Error

lastRunStatus

Cancelled

lastRunStatus

None

activation

Enabled

activation

DisabledForNextScheduledRunOnly

activation

Disabled

json
{
  "idleDaysCap": 0,
  "id": 0,
  "name": "string",
  "scheduleItemType": "Folder",
  "order": 0,
  "lastRun": "2019-08-24T14:15:22Z",
  "lastRunStatus": "Success",
  "activation": "Enabled",
  "nextRun": "2019-08-24T14:15:22Z",
  "parent": 0,
  "scheduledTime": {
    "id": 0,
    "scheduleItemId": 0,
    "minute": 0,
    "hour": 0,
    "dayOfMonth": 0,
    "month": 0,
    "dayOfWeek": 0,
    "nextRunTime": "2019-08-24T14:15:22Z",
    "isDSTAdjusted": true,
    "version": {
      "rowVersion": 0
    }
  },
  "parentItem": {
    "id": 0,
    "name": "string",
    "scheduleItemType": "Folder",
    "order": 0,
    "lastRun": "2019-08-24T14:15:22Z",
    "lastRunStatus": "Success",
    "activation": "Enabled",
    "nextRun": "2019-08-24T14:15:22Z",
    "parent": 0,
    "scheduledTime": {
      "id": 0,
      "scheduleItemId": 0,
      "minute": 0,
      "hour": 0,
      "dayOfMonth": 0,
      "month": 0,
      "dayOfWeek": 0,
      "nextRunTime": "2019-08-24T14:15:22Z",
      "isDSTAdjusted": true,
      "version": {}
    },
    "parentItem": null,
    "childScheduleItems": [],
    "settings": {
      "schedulerSettingsId": 0,
      "scheduleItemId": 0,
      "parentSettingsID": 0,
      "emailOnFailure": true,
      "emailOnSuccess": true,
      "stopOnFailure": true,
      "stopToolOnTimeout": true,
      "isGlobal": true,
      "overrideChildSettings": true,
      "successEmails": [],
      "failEmails": [],
      "externalToolTimeout": 0,
      "parentSettings": null,
      "enableRetries": true,
      "retries": 0,
      "interval": 0,
      "version": {}
    },
    "version": {
      "rowVersion": 0
    },
    "previousName": "string",
    "runInParallel": true,
    "externalItemID": "string",
    "ptzId": "string"
  },
  "childScheduleItems": [
    {
      "id": 0,
      "name": "string",
      "scheduleItemType": "Folder",
      "order": 0,
      "lastRun": "2019-08-24T14:15:22Z",
      "lastRunStatus": "Success",
      "activation": "Enabled",
      "nextRun": "2019-08-24T14:15:22Z",
      "parent": 0,
      "scheduledTime": {},
      "parentItem": null,
      "childScheduleItems": [],
      "settings": {},
      "version": {},
      "previousName": "string",
      "runInParallel": true,
      "externalItemID": "string",
      "ptzId": "string"
    }
  ],
  "settings": {
    "schedulerSettingsId": 0,
    "scheduleItemId": 0,
    "parentSettingsID": 0,
    "emailOnFailure": true,
    "emailOnSuccess": true,
    "stopOnFailure": true,
    "stopToolOnTimeout": true,
    "isGlobal": true,
    "overrideChildSettings": true,
    "successEmails": [
      "string"
    ],
    "failEmails": [
      "string"
    ],
    "externalToolTimeout": 0,
    "parentSettings": null,
    "enableRetries": true,
    "retries": 0,
    "interval": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "version": {
    "rowVersion": 0
  },
  "previousName": "string",
  "runInParallel": true,
  "externalItemID": "string",
  "ptzId": "string"
}

RESTAPI.v1.DTOs.Scheduler.ScheduleItemIndexRebuildDTO

Properties

Name

Type

Required

Restrictions

Description

calculationIDs

[integer]¦null

false

none

none

tables

[string]¦null

false

none

none

calculationIDsV2

object¦null

false

none

none

» additionalProperties

string¦null

false

none

none

tablesV2

object¦null

false

none

none

» additionalProperties

string¦null

false

none

none

id

integer(int32)

false

none

none

name

string¦null

false

none

none

scheduleItemType

string

false

none

none

order

integer(int32)

false

none

none

lastRun

string(date-time)

false

none

none

lastRunStatus

string

false

none

none

activation

string

false

none

none

nextRun

string(date-time)

false

none

none

parent

integer(int32)¦null

false

none

none

scheduledTime

Varicent.RESTAPI.v1.DTOs.Scheduler.ScheduleTimeDTO

false

none

none

parentItem

Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO

false

none

none

childScheduleItems

[Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO]¦null

false

none

none

settings

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

previousName

string¦null

false

none

none

runInParallel

boolean

false

none

none

externalItemID

string¦null

false

none

none

ptzId

string¦null

false

none

none

Enumerated Values

Property

Value

additionalProperties

Reorganize

additionalProperties

Full

additionalProperties

CompleteWithFullscan

additionalProperties

Reorganize

additionalProperties

Full

additionalProperties

CompleteWithFullscan

scheduleItemType

Folder

scheduleItemType

Calculation

scheduleItemType

Import

scheduleItemType

ExternalTool

scheduleItemType

TaskGeneration

scheduleItemType

StarSchemaPopulation

scheduleItemType

LockPeriod

scheduleItemType

EnableWeb

scheduleItemType

DisableWeb

scheduleItemType

Plan

scheduleItemType

Transformation

scheduleItemType

ClearTable

scheduleItemType

Publish

scheduleItemType

WebReport

scheduleItemType

Optimize

scheduleItemType

TaskRun

scheduleItemType

AddWorkflowMembers

scheduleItemType

UnassignIdleInquiries

scheduleItemType

PurgeHistory

scheduleItemType

ExpiringPasswordEmailNotificationAdmin

scheduleItemType

ExpiringPasswordEmailNotificationWeb

scheduleItemType

EnableWebUsers

scheduleItemType

CloudExternalTool

scheduleItemType

CloudSystemTool

scheduleItemType

IndexRebuild

scheduleItemType

PublishQueryTool

scheduleItemType

CalculateAndLock

scheduleItemType

HealthDashboardEvaluation

scheduleItemType

CalculationComponent

scheduleItemType

RefreshMaterializedView

scheduleItemType

RemoveWorkflowMembers

scheduleItemType

ELTRun

scheduleItemType

CalculationPlanBuilder

lastRunStatus

Success

lastRunStatus

Warning

lastRunStatus

Error

lastRunStatus

Cancelled

lastRunStatus

None

activation

Enabled

activation

DisabledForNextScheduledRunOnly

activation

Disabled

json
{
  "calculationIDs": [
    0
  ],
  "tables": [
    "string"
  ],
  "calculationIDsV2": {
    "property1": "Reorganize",
    "property2": "Reorganize"
  },
  "tablesV2": {
    "property1": "Reorganize",
    "property2": "Reorganize"
  },
  "id": 0,
  "name": "string",
  "scheduleItemType": "Folder",
  "order": 0,
  "lastRun": "2019-08-24T14:15:22Z",
  "lastRunStatus": "Success",
  "activation": "Enabled",
  "nextRun": "2019-08-24T14:15:22Z",
  "parent": 0,
  "scheduledTime": {
    "id": 0,
    "scheduleItemId": 0,
    "minute": 0,
    "hour": 0,
    "dayOfMonth": 0,
    "month": 0,
    "dayOfWeek": 0,
    "nextRunTime": "2019-08-24T14:15:22Z",
    "isDSTAdjusted": true,
    "version": {
      "rowVersion": 0
    }
  },
  "parentItem": {
    "id": 0,
    "name": "string",
    "scheduleItemType": "Folder",
    "order": 0,
    "lastRun": "2019-08-24T14:15:22Z",
    "lastRunStatus": "Success",
    "activation": "Enabled",
    "nextRun": "2019-08-24T14:15:22Z",
    "parent": 0,
    "scheduledTime": {
      "id": 0,
      "scheduleItemId": 0,
      "minute": 0,
      "hour": 0,
      "dayOfMonth": 0,
      "month": 0,
      "dayOfWeek": 0,
      "nextRunTime": "2019-08-24T14:15:22Z",
      "isDSTAdjusted": true,
      "version": {}
    },
    "parentItem": null,
    "childScheduleItems": [],
    "settings": {
      "schedulerSettingsId": 0,
      "scheduleItemId": 0,
      "parentSettingsID": 0,
      "emailOnFailure": true,
      "emailOnSuccess": true,
      "stopOnFailure": true,
      "stopToolOnTimeout": true,
      "isGlobal": true,
      "overrideChildSettings": true,
      "successEmails": [],
      "failEmails": [],
      "externalToolTimeout": 0,
      "parentSettings": null,
      "enableRetries": true,
      "retries": 0,
      "interval": 0,
      "version": {}
    },
    "version": {
      "rowVersion": 0
    },
    "previousName": "string",
    "runInParallel": true,
    "externalItemID": "string",
    "ptzId": "string"
  },
  "childScheduleItems": [
    {
      "id": 0,
      "name": "string",
      "scheduleItemType": "Folder",
      "order": 0,
      "lastRun": "2019-08-24T14:15:22Z",
      "lastRunStatus": "Success",
      "activation": "Enabled",
      "nextRun": "2019-08-24T14:15:22Z",
      "parent": 0,
      "scheduledTime": {},
      "parentItem": null,
      "childScheduleItems": [],
      "settings": {},
      "version": {},
      "previousName": "string",
      "runInParallel": true,
      "externalItemID": "string",
      "ptzId": "string"
    }
  ],
  "settings": {
    "schedulerSettingsId": 0,
    "scheduleItemId": 0,
    "parentSettingsID": 0,
    "emailOnFailure": true,
    "emailOnSuccess": true,
    "stopOnFailure": true,
    "stopToolOnTimeout": true,
    "isGlobal": true,
    "overrideChildSettings": true,
    "successEmails": [
      "string"
    ],
    "failEmails": [
      "string"
    ],
    "externalToolTimeout": 0,
    "parentSettings": null,
    "enableRetries": true,
    "retries": 0,
    "interval": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "version": {
    "rowVersion": 0
  },
  "previousName": "string",
  "runInParallel": true,
  "externalItemID": "string",
  "ptzId": "string"
}

RESTAPI.v1.DTOs.Scheduler.ScheduleItemOptimizeDTO

Properties

Name

Type

Required

Restrictions

Description

tableNames

[string]¦null

false

none

none

id

integer(int32)

false

none

none

name

string¦null

false

none

none

scheduleItemType

string

false

none

none

order

integer(int32)

false

none

none

lastRun

string(date-time)

false

none

none

lastRunStatus

string

false

none

none

activation

string

false

none

none

nextRun

string(date-time)

false

none

none

parent

integer(int32)¦null

false

none

none

scheduledTime

Varicent.RESTAPI.v1.DTOs.Scheduler.ScheduleTimeDTO

false

none

none

parentItem

Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO

false

none

none

childScheduleItems

[Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO]¦null

false

none

none

settings

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

previousName

string¦null

false

none

none

runInParallel

boolean

false

none

none

externalItemID

string¦null

false

none

none

ptzId

string¦null

false

none

none

Enumerated Values

Property

Value

scheduleItemType

Folder

scheduleItemType

Calculation

scheduleItemType

Import

scheduleItemType

ExternalTool

scheduleItemType

TaskGeneration

scheduleItemType

StarSchemaPopulation

scheduleItemType

LockPeriod

scheduleItemType

EnableWeb

scheduleItemType

DisableWeb

scheduleItemType

Plan

scheduleItemType

Transformation

scheduleItemType

ClearTable

scheduleItemType

Publish

scheduleItemType

WebReport

scheduleItemType

Optimize

scheduleItemType

TaskRun

scheduleItemType

AddWorkflowMembers

scheduleItemType

UnassignIdleInquiries

scheduleItemType

PurgeHistory

scheduleItemType

ExpiringPasswordEmailNotificationAdmin

scheduleItemType

ExpiringPasswordEmailNotificationWeb

scheduleItemType

EnableWebUsers

scheduleItemType

CloudExternalTool

scheduleItemType

CloudSystemTool

scheduleItemType

IndexRebuild

scheduleItemType

PublishQueryTool

scheduleItemType

CalculateAndLock

scheduleItemType

HealthDashboardEvaluation

scheduleItemType

CalculationComponent

scheduleItemType

RefreshMaterializedView

scheduleItemType

RemoveWorkflowMembers

scheduleItemType

ELTRun

scheduleItemType

CalculationPlanBuilder

lastRunStatus

Success

lastRunStatus

Warning

lastRunStatus

Error

lastRunStatus

Cancelled

lastRunStatus

None

activation

Enabled

activation

DisabledForNextScheduledRunOnly

activation

Disabled

json
{
  "tableNames": [
    "string"
  ],
  "id": 0,
  "name": "string",
  "scheduleItemType": "Folder",
  "order": 0,
  "lastRun": "2019-08-24T14:15:22Z",
  "lastRunStatus": "Success",
  "activation": "Enabled",
  "nextRun": "2019-08-24T14:15:22Z",
  "parent": 0,
  "scheduledTime": {
    "id": 0,
    "scheduleItemId": 0,
    "minute": 0,
    "hour": 0,
    "dayOfMonth": 0,
    "month": 0,
    "dayOfWeek": 0,
    "nextRunTime": "2019-08-24T14:15:22Z",
    "isDSTAdjusted": true,
    "version": {
      "rowVersion": 0
    }
  },
  "parentItem": {
    "id": 0,
    "name": "string",
    "scheduleItemType": "Folder",
    "order": 0,
    "lastRun": "2019-08-24T14:15:22Z",
    "lastRunStatus": "Success",
    "activation": "Enabled",
    "nextRun": "2019-08-24T14:15:22Z",
    "parent": 0,
    "scheduledTime": {
      "id": 0,
      "scheduleItemId": 0,
      "minute": 0,
      "hour": 0,
      "dayOfMonth": 0,
      "month": 0,
      "dayOfWeek": 0,
      "nextRunTime": "2019-08-24T14:15:22Z",
      "isDSTAdjusted": true,
      "version": {}
    },
    "parentItem": null,
    "childScheduleItems": [],
    "settings": {
      "schedulerSettingsId": 0,
      "scheduleItemId": 0,
      "parentSettingsID": 0,
      "emailOnFailure": true,
      "emailOnSuccess": true,
      "stopOnFailure": true,
      "stopToolOnTimeout": true,
      "isGlobal": true,
      "overrideChildSettings": true,
      "successEmails": [],
      "failEmails": [],
      "externalToolTimeout": 0,
      "parentSettings": null,
      "enableRetries": true,
      "retries": 0,
      "interval": 0,
      "version": {}
    },
    "version": {
      "rowVersion": 0
    },
    "previousName": "string",
    "runInParallel": true,
    "externalItemID": "string",
    "ptzId": "string"
  },
  "childScheduleItems": [
    {
      "id": 0,
      "name": "string",
      "scheduleItemType": "Folder",
      "order": 0,
      "lastRun": "2019-08-24T14:15:22Z",
      "lastRunStatus": "Success",
      "activation": "Enabled",
      "nextRun": "2019-08-24T14:15:22Z",
      "parent": 0,
      "scheduledTime": {},
      "parentItem": null,
      "childScheduleItems": [],
      "settings": {},
      "version": {},
      "previousName": "string",
      "runInParallel": true,
      "externalItemID": "string",
      "ptzId": "string"
    }
  ],
  "settings": {
    "schedulerSettingsId": 0,
    "scheduleItemId": 0,
    "parentSettingsID": 0,
    "emailOnFailure": true,
    "emailOnSuccess": true,
    "stopOnFailure": true,
    "stopToolOnTimeout": true,
    "isGlobal": true,
    "overrideChildSettings": true,
    "successEmails": [
      "string"
    ],
    "failEmails": [
      "string"
    ],
    "externalToolTimeout": 0,
    "parentSettings": null,
    "enableRetries": true,
    "retries": 0,
    "interval": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "version": {
    "rowVersion": 0
  },
  "previousName": "string",
  "runInParallel": true,
  "externalItemID": "string",
  "ptzId": "string"
}

RESTAPI.v1.DTOs.Scheduler.ScheduleItemPublishDTO

Properties

Name

Type

Required

Restrictions

Description

publishFolderPath

string¦null

false

none

none

id

integer(int32)

false

none

none

name

string¦null

false

none

none

scheduleItemType

string

false

none

none

order

integer(int32)

false

none

none

lastRun

string(date-time)

false

none

none

lastRunStatus

string

false

none

none

activation

string

false

none

none

nextRun

string(date-time)

false

none

none

parent

integer(int32)¦null

false

none

none

scheduledTime

Varicent.RESTAPI.v1.DTOs.Scheduler.ScheduleTimeDTO

false

none

none

parentItem

Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO

false

none

none

childScheduleItems

[Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO]¦null

false

none

none

settings

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

previousName

string¦null

false

none

none

runInParallel

boolean

false

none

none

externalItemID

string¦null

false

none

none

ptzId

string¦null

false

none

none

Enumerated Values

Property

Value

scheduleItemType

Folder

scheduleItemType

Calculation

scheduleItemType

Import

scheduleItemType

ExternalTool

scheduleItemType

TaskGeneration

scheduleItemType

StarSchemaPopulation

scheduleItemType

LockPeriod

scheduleItemType

EnableWeb

scheduleItemType

DisableWeb

scheduleItemType

Plan

scheduleItemType

Transformation

scheduleItemType

ClearTable

scheduleItemType

Publish

scheduleItemType

WebReport

scheduleItemType

Optimize

scheduleItemType

TaskRun

scheduleItemType

AddWorkflowMembers

scheduleItemType

UnassignIdleInquiries

scheduleItemType

PurgeHistory

scheduleItemType

ExpiringPasswordEmailNotificationAdmin

scheduleItemType

ExpiringPasswordEmailNotificationWeb

scheduleItemType

EnableWebUsers

scheduleItemType

CloudExternalTool

scheduleItemType

CloudSystemTool

scheduleItemType

IndexRebuild

scheduleItemType

PublishQueryTool

scheduleItemType

CalculateAndLock

scheduleItemType

HealthDashboardEvaluation

scheduleItemType

CalculationComponent

scheduleItemType

RefreshMaterializedView

scheduleItemType

RemoveWorkflowMembers

scheduleItemType

ELTRun

scheduleItemType

CalculationPlanBuilder

lastRunStatus

Success

lastRunStatus

Warning

lastRunStatus

Error

lastRunStatus

Cancelled

lastRunStatus

None

activation

Enabled

activation

DisabledForNextScheduledRunOnly

activation

Disabled

json
{
  "publishFolderPath": "string",
  "id": 0,
  "name": "string",
  "scheduleItemType": "Folder",
  "order": 0,
  "lastRun": "2019-08-24T14:15:22Z",
  "lastRunStatus": "Success",
  "activation": "Enabled",
  "nextRun": "2019-08-24T14:15:22Z",
  "parent": 0,
  "scheduledTime": {
    "id": 0,
    "scheduleItemId": 0,
    "minute": 0,
    "hour": 0,
    "dayOfMonth": 0,
    "month": 0,
    "dayOfWeek": 0,
    "nextRunTime": "2019-08-24T14:15:22Z",
    "isDSTAdjusted": true,
    "version": {
      "rowVersion": 0
    }
  },
  "parentItem": {
    "id": 0,
    "name": "string",
    "scheduleItemType": "Folder",
    "order": 0,
    "lastRun": "2019-08-24T14:15:22Z",
    "lastRunStatus": "Success",
    "activation": "Enabled",
    "nextRun": "2019-08-24T14:15:22Z",
    "parent": 0,
    "scheduledTime": {
      "id": 0,
      "scheduleItemId": 0,
      "minute": 0,
      "hour": 0,
      "dayOfMonth": 0,
      "month": 0,
      "dayOfWeek": 0,
      "nextRunTime": "2019-08-24T14:15:22Z",
      "isDSTAdjusted": true,
      "version": {}
    },
    "parentItem": null,
    "childScheduleItems": [],
    "settings": {
      "schedulerSettingsId": 0,
      "scheduleItemId": 0,
      "parentSettingsID": 0,
      "emailOnFailure": true,
      "emailOnSuccess": true,
      "stopOnFailure": true,
      "stopToolOnTimeout": true,
      "isGlobal": true,
      "overrideChildSettings": true,
      "successEmails": [],
      "failEmails": [],
      "externalToolTimeout": 0,
      "parentSettings": null,
      "enableRetries": true,
      "retries": 0,
      "interval": 0,
      "version": {}
    },
    "version": {
      "rowVersion": 0
    },
    "previousName": "string",
    "runInParallel": true,
    "externalItemID": "string",
    "ptzId": "string"
  },
  "childScheduleItems": [
    {
      "id": 0,
      "name": "string",
      "scheduleItemType": "Folder",
      "order": 0,
      "lastRun": "2019-08-24T14:15:22Z",
      "lastRunStatus": "Success",
      "activation": "Enabled",
      "nextRun": "2019-08-24T14:15:22Z",
      "parent": 0,
      "scheduledTime": {},
      "parentItem": null,
      "childScheduleItems": [],
      "settings": {},
      "version": {},
      "previousName": "string",
      "runInParallel": true,
      "externalItemID": "string",
      "ptzId": "string"
    }
  ],
  "settings": {
    "schedulerSettingsId": 0,
    "scheduleItemId": 0,
    "parentSettingsID": 0,
    "emailOnFailure": true,
    "emailOnSuccess": true,
    "stopOnFailure": true,
    "stopToolOnTimeout": true,
    "isGlobal": true,
    "overrideChildSettings": true,
    "successEmails": [
      "string"
    ],
    "failEmails": [
      "string"
    ],
    "externalToolTimeout": 0,
    "parentSettings": null,
    "enableRetries": true,
    "retries": 0,
    "interval": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "version": {
    "rowVersion": 0
  },
  "previousName": "string",
  "runInParallel": true,
  "externalItemID": "string",
  "ptzId": "string"
}

RESTAPI.v1.DTOs.Scheduler.ScheduleItemPurgeHistoryDTO

Properties

Name

Type

Required

Restrictions

Description

tableNames

[string]¦null

false

none

none

range

string

false

none

none

endDate

string(date-time)¦null

false

none

none

id

integer(int32)

false

none

none

name

string¦null

false

none

none

scheduleItemType

string

false

none

none

order

integer(int32)

false

none

none

lastRun

string(date-time)

false

none

none

lastRunStatus

string

false

none

none

activation

string

false

none

none

nextRun

string(date-time)

false

none

none

parent

integer(int32)¦null

false

none

none

scheduledTime

Varicent.RESTAPI.v1.DTOs.Scheduler.ScheduleTimeDTO

false

none

none

parentItem

Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO

false

none

none

childScheduleItems

[Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO]¦null

false

none

none

settings

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

previousName

string¦null

false

none

none

runInParallel

boolean

false

none

none

externalItemID

string¦null

false

none

none

ptzId

string¦null

false

none

none

Enumerated Values

Property

Value

range

Everything

range

OlderThanOneMonth

range

OlderThanSixMonths

range

OlderThanOneYear

range

ExactPeriod

scheduleItemType

Folder

scheduleItemType

Calculation

scheduleItemType

Import

scheduleItemType

ExternalTool

scheduleItemType

TaskGeneration

scheduleItemType

StarSchemaPopulation

scheduleItemType

LockPeriod

scheduleItemType

EnableWeb

scheduleItemType

DisableWeb

scheduleItemType

Plan

scheduleItemType

Transformation

scheduleItemType

ClearTable

scheduleItemType

Publish

scheduleItemType

WebReport

scheduleItemType

Optimize

scheduleItemType

TaskRun

scheduleItemType

AddWorkflowMembers

scheduleItemType

UnassignIdleInquiries

scheduleItemType

PurgeHistory

scheduleItemType

ExpiringPasswordEmailNotificationAdmin

scheduleItemType

ExpiringPasswordEmailNotificationWeb

scheduleItemType

EnableWebUsers

scheduleItemType

CloudExternalTool

scheduleItemType

CloudSystemTool

scheduleItemType

IndexRebuild

scheduleItemType

PublishQueryTool

scheduleItemType

CalculateAndLock

scheduleItemType

HealthDashboardEvaluation

scheduleItemType

CalculationComponent

scheduleItemType

RefreshMaterializedView

scheduleItemType

RemoveWorkflowMembers

scheduleItemType

ELTRun

scheduleItemType

CalculationPlanBuilder

lastRunStatus

Success

lastRunStatus

Warning

lastRunStatus

Error

lastRunStatus

Cancelled

lastRunStatus

None

activation

Enabled

activation

DisabledForNextScheduledRunOnly

activation

Disabled

json
{
  "tableNames": [
    "string"
  ],
  "range": "Everything",
  "endDate": "2019-08-24T14:15:22Z",
  "id": 0,
  "name": "string",
  "scheduleItemType": "Folder",
  "order": 0,
  "lastRun": "2019-08-24T14:15:22Z",
  "lastRunStatus": "Success",
  "activation": "Enabled",
  "nextRun": "2019-08-24T14:15:22Z",
  "parent": 0,
  "scheduledTime": {
    "id": 0,
    "scheduleItemId": 0,
    "minute": 0,
    "hour": 0,
    "dayOfMonth": 0,
    "month": 0,
    "dayOfWeek": 0,
    "nextRunTime": "2019-08-24T14:15:22Z",
    "isDSTAdjusted": true,
    "version": {
      "rowVersion": 0
    }
  },
  "parentItem": {
    "id": 0,
    "name": "string",
    "scheduleItemType": "Folder",
    "order": 0,
    "lastRun": "2019-08-24T14:15:22Z",
    "lastRunStatus": "Success",
    "activation": "Enabled",
    "nextRun": "2019-08-24T14:15:22Z",
    "parent": 0,
    "scheduledTime": {
      "id": 0,
      "scheduleItemId": 0,
      "minute": 0,
      "hour": 0,
      "dayOfMonth": 0,
      "month": 0,
      "dayOfWeek": 0,
      "nextRunTime": "2019-08-24T14:15:22Z",
      "isDSTAdjusted": true,
      "version": {}
    },
    "parentItem": null,
    "childScheduleItems": [],
    "settings": {
      "schedulerSettingsId": 0,
      "scheduleItemId": 0,
      "parentSettingsID": 0,
      "emailOnFailure": true,
      "emailOnSuccess": true,
      "stopOnFailure": true,
      "stopToolOnTimeout": true,
      "isGlobal": true,
      "overrideChildSettings": true,
      "successEmails": [],
      "failEmails": [],
      "externalToolTimeout": 0,
      "parentSettings": null,
      "enableRetries": true,
      "retries": 0,
      "interval": 0,
      "version": {}
    },
    "version": {
      "rowVersion": 0
    },
    "previousName": "string",
    "runInParallel": true,
    "externalItemID": "string",
    "ptzId": "string"
  },
  "childScheduleItems": [
    {
      "id": 0,
      "name": "string",
      "scheduleItemType": "Folder",
      "order": 0,
      "lastRun": "2019-08-24T14:15:22Z",
      "lastRunStatus": "Success",
      "activation": "Enabled",
      "nextRun": "2019-08-24T14:15:22Z",
      "parent": 0,
      "scheduledTime": {},
      "parentItem": null,
      "childScheduleItems": [],
      "settings": {},
      "version": {},
      "previousName": "string",
      "runInParallel": true,
      "externalItemID": "string",
      "ptzId": "string"
    }
  ],
  "settings": {
    "schedulerSettingsId": 0,
    "scheduleItemId": 0,
    "parentSettingsID": 0,
    "emailOnFailure": true,
    "emailOnSuccess": true,
    "stopOnFailure": true,
    "stopToolOnTimeout": true,
    "isGlobal": true,
    "overrideChildSettings": true,
    "successEmails": [
      "string"
    ],
    "failEmails": [
      "string"
    ],
    "externalToolTimeout": 0,
    "parentSettings": null,
    "enableRetries": true,
    "retries": 0,
    "interval": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "version": {
    "rowVersion": 0
  },
  "previousName": "string",
  "runInParallel": true,
  "externalItemID": "string",
  "ptzId": "string"
}

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

Properties

Name

Type

Required

Restrictions

Description

schedulerSettingsId

integer(int32)

false

none

none

scheduleItemId

integer(int32)¦null

false

none

none

parentSettingsID

integer(int32)¦null

false

none

none

emailOnFailure

boolean

false

none

none

emailOnSuccess

boolean

false

none

none

stopOnFailure

boolean

false

none

none

stopToolOnTimeout

boolean

false

none

none

isGlobal

boolean

false

none

none

overrideChildSettings

boolean

false

none

none

successEmails

[string]¦null

false

none

none

failEmails

[string]¦null

false

none

none

externalToolTimeout

integer(int32)

false

none

none

parentSettings

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

false

none

none

enableRetries

boolean

false

none

none

retries

integer(int32)¦null

false

none

none

interval

integer(int32)¦null

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "schedulerSettingsId": 0,
  "scheduleItemId": 0,
  "parentSettingsID": 0,
  "emailOnFailure": true,
  "emailOnSuccess": true,
  "stopOnFailure": true,
  "stopToolOnTimeout": true,
  "isGlobal": true,
  "overrideChildSettings": true,
  "successEmails": [
    "string"
  ],
  "failEmails": [
    "string"
  ],
  "externalToolTimeout": 0,
  "parentSettings": null,
  "enableRetries": true,
  "retries": 0,
  "interval": 0,
  "version": {
    "rowVersion": 0
  }
}

RESTAPI.v1.DTOs.SimplePeriodDTO

Properties

Name

Type

Required

Restrictions

Description

start

string(date-time)

false

none

none

end

string(date-time)

false

none

none

json
{
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z"
}

RESTAPI.v1.DTOs.SingleActionResolver.ExecutedSingleActionResultDTO

Properties

Name

Type

Required

Restrictions

Description

workflowActionSingleActionResultDTO

RESTAPI.v1.DTOs.SingleActionResolver.WorkflowActionSingleActionResultDTO

false

none

none

json
{
  "workflowActionSingleActionResultDTO": {
    "workflowId": 0,
    "inquiryId": 0,
    "workflowActionName": "string",
    "userName": "string",
    "resolvedWorkflowActionStatus": "Succeeded"
  }
}

RESTAPI.v1.DTOs.SingleActionResolver.WorkflowActionSingleActionResultDTO

Properties

Name

Type

Required

Restrictions

Description

workflowId

integer(int32)¦null

false

none

none

inquiryId

integer(int32)¦null

false

none

none

workflowActionName

string¦null

false

none

none

userName

string¦null

false

none

none

resolvedWorkflowActionStatus

string¦null

false

none

none

Enumerated Values

Property

Value

resolvedWorkflowActionStatus

Succeeded

resolvedWorkflowActionStatus

Failed

resolvedWorkflowActionStatus

NoActionRequired

json
{
  "workflowId": 0,
  "inquiryId": 0,
  "workflowActionName": "string",
  "userName": "string",
  "resolvedWorkflowActionStatus": "Succeeded"
}

RESTAPI.v1.DTOs.Symon.CosLocationDTO

Properties

Name

Type

Required

Restrictions

Description

bucket

string¦null

false

none

none

key

string¦null

false

none

none

json
{
  "bucket": "string",
  "key": "string"
}

RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO

Properties

Name

Type

Required

Restrictions

Description

source

string¦null

false

none

none

destination

string¦null

false

none

none

type

string

false

none

none

Enumerated Values

Property

Value

type

String

type

Number

type

Boolean

type

Date

json
{
  "source": "string",
  "destination": "string",
  "type": "String"
}

RESTAPI.v1.DTOs.ThemeDTO

Properties

Name

Type

Required

Restrictions

Description

isEnabled

boolean

false

none

none

headerImage

string(byte)¦null

false

none

none

webThemeType

string

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

headerImageName

string¦null

false

none

none

backgroundImages

[Varicent.RESTAPI.v1.DTOs.BackgroundImageDTO]¦null

false

none

none

selectedBackgroundImage

integer(int32)¦null

false

none

none

themeColor

string¦null

false

none

none

navStyle

string¦null

false

none

none

mobileEnabled

boolean¦null

false

none

none

qrCodeEnabled

boolean¦null

false

none

none

isMobileDemoEnabled

boolean¦null

false

none

none

isSlackEnabled

boolean¦null

false

none

none

isWebViewForMobileSSOEnabled

boolean¦null

false

none

none

isLeftSideNavigationEnabled

boolean¦null

false

none

none

isFooterEnabled

boolean¦null

false

none

none

footerTheme

string

false

none

none

footerImageMode

string

false

none

none

footerImagePosition

string

false

none

none

footerImageName

string¦null

false

none

none

footerImage

string(byte)¦null

false

none

none

footerText

string¦null

false

none

none

footerCustomSettings

Varicent.Domain.Themes.FooterCustomColor

false

none

none

navBarCustomSettings

Varicent.Domain.Themes.NavBarCustomColor

false

none

none

navLogoImageMode

string

false

none

none

navLogoImage

string(byte)¦null

false

none

none

organizationLogoImageMode

string

false

none

none

isTaglineEnabled

boolean¦null

false

none

none

taglineText

string¦null

false

none

none

menuItemAlignment

string

false

none

none

navBarTheme

string

false

none

none

Enumerated Values

Property

Value

webThemeType

Standard

webThemeType

SFDC

webThemeType

Modern

footerTheme

Light

footerTheme

Dark

footerTheme

Custom

footerImageMode

None

footerImageMode

UseHeader

footerImageMode

Upload

footerImagePosition

TopLeft

footerImagePosition

TopRight

navLogoImageMode

None

navLogoImageMode

UseHeader

navLogoImageMode

Upload

organizationLogoImageMode

None

organizationLogoImageMode

UseHeader

organizationLogoImageMode

Upload

menuItemAlignment

Left

menuItemAlignment

Right

navBarTheme

Light

navBarTheme

Dark

navBarTheme

Custom

json
{
  "isEnabled": true,
  "headerImage": "string",
  "webThemeType": "Standard",
  "version": {
    "rowVersion": 0
  },
  "headerImageName": "string",
  "backgroundImages": [
    {
      "isNew": true,
      "image": "string",
      "id": 0,
      "cosObjectName": "string",
      "expiryDate": "2019-08-24T14:15:22Z",
      "imageUrl": "string"
    }
  ],
  "selectedBackgroundImage": 0,
  "themeColor": "string",
  "navStyle": "string",
  "mobileEnabled": true,
  "qrCodeEnabled": true,
  "isMobileDemoEnabled": true,
  "isSlackEnabled": true,
  "isWebViewForMobileSSOEnabled": true,
  "isLeftSideNavigationEnabled": true,
  "isFooterEnabled": true,
  "footerTheme": "Light",
  "footerImageMode": "None",
  "footerImagePosition": "TopLeft",
  "footerImageName": "string",
  "footerImage": "string",
  "footerText": "string",
  "footerCustomSettings": {
    "backgroundColor": "string",
    "textColor": "string",
    "linkColor": "string"
  },
  "navBarCustomSettings": {
    "backgroundColor": "string",
    "highlightColor": "string",
    "textIconColor": "string"
  },
  "navLogoImageMode": "None",
  "navLogoImage": "string",
  "organizationLogoImageMode": "None",
  "isTaglineEnabled": true,
  "taglineText": "string",
  "menuItemAlignment": "Left",
  "navBarTheme": "Light"
}

RESTAPI.v1.DTOs.Time.CalendarTemplateDTO

Properties

Name

Type

Required

Restrictions

Description

template

string

false

none

none

levels

[string]¦null

false

none

none

Enumerated Values

Property

Value

template

Monthly

template

HalfMonths

template

Biweekly

template

FourWeekPeriod

template

Weekly

template

Standard445

template

Standard454

template

Standard544

json
{
  "template": "Monthly",
  "levels": [
    "string"
  ]
}

RESTAPI.v1.DTOs.TranslateSingleReportSourceDTO

Properties

Name

Type

Required

Restrictions

Description

source

Varicent.RESTAPI.v1.DTOs.ReportSourceDTO

false

none

none

dependencies

[Varicent.RESTAPI.v1.DTOs.ReportSourceDTO]¦null

false

none

none

json
{
  "source": {
    "dependencies": [
      "string"
    ],
    "name": "string",
    "type": "AggregateTransformation",
    "scalarType": "string",
    "value": null,
    "column": "string",
    "keyValues": {
      "property1": {},
      "property2": {}
    },
    "table": "string",
    "expression": "string",
    "variables": [
      "string"
    ],
    "required": true,
    "useWebUser": true,
    "isParameterValueScalar": true,
    "parameterValue": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "parameterId": 0,
    "columnNames": [
      "string"
    ],
    "source": {
      "query": {},
      "sourceNames": {}
    },
    "formula": "string",
    "partitionColumns": [
      "string"
    ],
    "timeEnd": "2019-08-24T14:15:22Z",
    "timeFrequency": {
      "levelId": "string",
      "timeId": "string"
    },
    "timePartition": "string",
    "timeStart": "2019-08-24T14:15:22Z",
    "newColumnName": "string",
    "keyColumns": [
      "string"
    ],
    "newColumns": [
      "string"
    ],
    "transposeColumn": "string"
  },
  "dependencies": [
    {
      "dependencies": [],
      "name": "string",
      "type": "AggregateTransformation",
      "scalarType": "string",
      "value": null,
      "column": "string",
      "keyValues": {},
      "table": "string",
      "expression": "string",
      "variables": [],
      "required": true,
      "useWebUser": true,
      "isParameterValueScalar": true,
      "parameterValue": {},
      "parameterId": 0,
      "columnNames": [],
      "source": {},
      "formula": "string",
      "partitionColumns": [],
      "timeEnd": "2019-08-24T14:15:22Z",
      "timeFrequency": {},
      "timePartition": "string",
      "timeStart": "2019-08-24T14:15:22Z",
      "newColumnName": "string",
      "keyColumns": [],
      "newColumns": [],
      "transposeColumn": "string"
    }
  ]
}

RESTAPI.v1.DTOs.TreeNodeDTO

Properties

Name

Type

Required

Restrictions

Description

node

any

false

none

none

children

[RESTAPI.v1.DTOs.TreeNodeDTO]¦null

false

none

none

json
{
  "node": null,
  "children": []
}

RESTAPI.v1.DTOs.WebReportHtmlPreviewRequestDTO

Properties

Name

Type

Required

Restrictions

Description

payeeId

string¦null

false

none

none

parameters

object¦null

false

none

none

» additionalProperties

string¦null

false

none

none

webReport

Varicent.RESTAPI.v1.DTOs.WebReportDTO

false

none

none

isFull

boolean

false

none

none

retrieveBPMParams

boolean

false

none

none

bpmTokenID

integer(int32)

false

none

none

forWorkflow

boolean

false

none

none

workflowID

integer(int32)

false

none

none

timeZoneOffsetMinutes

integer(int32)

false

none

none

signatures

object¦null

false

none

none

» additionalProperties

integer(int32)¦null

false

none

none

json
{
  "payeeId": "string",
  "parameters": {
    "property1": "string",
    "property2": "string"
  },
  "webReport": {
    "allowPdfExport": true,
    "showInquiry": true,
    "batchExportDetails": {
      "canBatchExport": true,
      "picklistRefParam": "string"
    },
    "background": {
      "color": {},
      "image": {},
      "imageAttachment": "Scroll",
      "imagePosition": "Absolute",
      "imageTile": "None",
      "webreportId": 0,
      "x": 0,
      "y": 0,
      "opacity": 0
    },
    "defaultStyle": {
      "color": {},
      "font": {}
    },
    "directlyAccessible": true,
    "frameLayout": {
      "horizontalAlign": "Left",
      "verticalAlign": "Top",
      "type": "Frame",
      "childHeightPercents": [],
      "childWidthPercents": [],
      "frames": [],
      "name": "string",
      "numColumns": 0,
      "numRows": 0,
      "display": {}
    },
    "isLayoutLocked": true,
    "name": "string",
    "pdfOptions": {
      "autoScale": true,
      "customScaleValue": 0.1,
      "footerText": "string",
      "includePageNumber": true,
      "portraitOrientation": true,
      "showTotalPageNumber": true,
      "tableViewportWidth": 0.1
    },
    "sources": [
      {}
    ],
    "trees": [
      {}
    ],
    "version": {
      "rowVersion": 0
    },
    "webReportId": 0,
    "workflowObjectId": 0,
    "element": {},
    "styleCategory": "string"
  },
  "isFull": true,
  "retrieveBPMParams": true,
  "bpmTokenID": 0,
  "forWorkflow": true,
  "workflowID": 0,
  "timeZoneOffsetMinutes": 0,
  "signatures": {
    "property1": 0,
    "property2": 0
  }
}

RESTAPI.v1.DTOs.WebReportSourceDependencyItemDTO

Properties

Name

Type

Required

Restrictions

Description

type

string

false

none

none

name

string¦null

false

none

none

Enumerated Values

Property

Value

type

Query

type

InputRow

type

ValueScalar

json
{
  "type": "Query",
  "name": "string"
}

RESTAPI.v1.DTOs.WebReportTransposeDTO

Properties

Name

Type

Required

Restrictions

Description

sources

[Varicent.RESTAPI.v1.DTOs.ReportSourceDTO]¦null

false

none

none

transposeSourceName

string¦null

false

none

none

transposeColumn

string¦null

false

none

none

json
{
  "sources": [
    {
      "dependencies": [],
      "name": "string",
      "type": "AggregateTransformation",
      "scalarType": "string",
      "value": null,
      "column": "string",
      "keyValues": {},
      "table": "string",
      "expression": "string",
      "variables": [],
      "required": true,
      "useWebUser": true,
      "isParameterValueScalar": true,
      "parameterValue": {},
      "parameterId": 0,
      "columnNames": [],
      "source": {},
      "formula": "string",
      "partitionColumns": [],
      "timeEnd": "2019-08-24T14:15:22Z",
      "timeFrequency": {},
      "timePartition": "string",
      "timeStart": "2019-08-24T14:15:22Z",
      "newColumnName": "string",
      "keyColumns": [],
      "newColumns": [],
      "transposeColumn": "string"
    }
  ],
  "transposeSourceName": "string",
  "transposeColumn": "string"
}

RESTAPI.v1.DTOs.Workflow.ValidateConditionalNodeDTO

Properties

Name

Type

Required

Restrictions

Description

formula

string¦null

false

none

none

swimLaneID

integer(int32)

false

none

none

json
{
  "formula": "string",
  "swimLaneID": 0
}

RESTAPI.v2.DTOs.AdminUserDTO

Properties

Name

Type

Required

Restrictions

Description

id

string¦null

false

none

none

email

string¦null

false

none

none

name

string¦null

false

none

none

models

[string]¦null

false

none

none

role

string¦null

false

none

none

createdAt

string(date-time)

false

none

none

elearningEmail

string¦null

false

none

none

ssoNameId

string¦null

false

none

none

useNativeLogin

boolean

false

none

none

disabled

boolean

false

none

none

locked

boolean

false

none

none

hasApiKey

boolean

false

none

none

json
{
  "id": "string",
  "email": "string",
  "name": "string",
  "models": [
    "string"
  ],
  "role": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "elearningEmail": "string",
  "ssoNameId": "string",
  "useNativeLogin": true,
  "disabled": true,
  "locked": true,
  "hasApiKey": true
}

RESTAPI.v2.DTOs.Composer.DataImport.ImportParamsDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

importType

string

false

none

none

hasHeader

boolean

false

none

none

table

string¦null

false

none

none

columnMatchings

RESTAPI.v1.DTOs.ColumnMatchingsDTO

false

none

none

dateFormat

string

false

none

none

listSubitems

[string]¦null

false

none

none

subitemMap

object¦null

false

none

none

» additionalProperties

RESTAPI.v1.DTOs.Composer.DataImport.SubitemDTO

false

none

none

addMember

boolean

false

none

none

updateExistingRows

boolean

false

none

none

tableType

string

false

none

none

isLocal

boolean

false

none

none

localCulture

System.IFormatProvider

false

none

none

useIncrementalImport

boolean

false

none

none

culture

string¦null

false

none

none

tableEffectiveDated

boolean

false

none

none

isODBCTextDriver

boolean

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

fileOverwrite

boolean

false

none

none

importId

integer(int32)

false

none

none

filename

string¦null

false

none

none

localPath

string¦null

false

none

none

username

string¦null

false

none

none

password

string¦null

false

none

none

delimiter

string

false

none

none

sheetName

string¦null

false

none

none

cellRange

string¦null

false

none

none

query

string¦null

false

none

none

queryTimeout

integer(int32)

false

none

none

connectionString

string¦null

false

none

none

useAdvanced

boolean

false

none

none

model

string¦null

false

none

none

importMethod

integer(int32)

false

none

none

sourceTableName

string¦null

false

none

none

securityToken

string¦null

false

none

none

customColumns

[string]¦null

false

none

none

userSelected

boolean

false

none

none

sandbox

boolean

false

none

none

fileLocation

string¦null

false

none

none

codePage

integer(int32)

false

none

none

ignoreFirst

boolean

false

none

none

ignoreLast

boolean

false

none

none

recordLength

integer(int32)

false

none

none

fields

[RESTAPI.v1.DTOs.Composer.DataImport.EBCDICFieldDTO]¦null

false

none

none

selectRowNode

string¦null

false

none

none

pipeConnection

Varicent.RESTAPI.v1.DTOs.Symon.PipeConnectionDTO

false

none

none

inputTable

string¦null

false

none

none

uploadStage

boolean

false

none

none

predictStage

boolean

false

none

none

downloadStage

boolean

false

none

none

symonImportType

string

false

none

none

refreshAllPipeDatasources

boolean

false

none

none

connectorID

string¦null

false

none

none

streamID

string¦null

false

none

none

importConfig

any

false

none

none

outputMapping

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

none

Enumerated Values

Property

Value

importType

None

importType

Text

importType

Excel

importType

DBImport

importType

Salesforce

importType

MSCRM

importType

EBCDICText

importType

TerrAlign

importType

XML

importType

ODBCImport

importType

SymonImport

importType

SymonConnectorImport

importType

Cos

importType

SQLServer

importType

Dynamics

importType

GoogleSheets

importType

MySql

importType

AmazonAurora

importType

AmazonS3

importType

Snowflake

importType

Shopify

importType

Hubspot

importType

Oracle

importType

AmazonRedshift

importType

Workday

dateFormat

Default

dateFormat

DayFirst

dateFormat

MonthFirst

tableType

System

tableType

Dimension

tableType

Structural

tableType

Lookup

tableType

Data

tableType

View

tableType

Custom

tableType

StarSchema

tableType

ExportTable

tableType

CreditingRule

tableType

AssignTable

tableType

PlcmCustomTable

tableType

PlcmStructuralTable

tableType

PlcmTable

tableType

DataSource

tableType

Cached

tableType

MaterializedView

symonImportType

None

symonImportType

Text

symonImportType

Excel

symonImportType

DBImport

symonImportType

Salesforce

symonImportType

MSCRM

symonImportType

EBCDICText

symonImportType

TerrAlign

symonImportType

XML

symonImportType

ODBCImport

symonImportType

SymonImport

symonImportType

SymonConnectorImport

symonImportType

Cos

symonImportType

SQLServer

symonImportType

Dynamics

symonImportType

GoogleSheets

symonImportType

MySql

symonImportType

AmazonAurora

symonImportType

AmazonS3

symonImportType

Snowflake

symonImportType

Shopify

symonImportType

Hubspot

symonImportType

Oracle

symonImportType

AmazonRedshift

symonImportType

Workday

json
{
  "name": "string",
  "importType": "None",
  "hasHeader": true,
  "table": "string",
  "columnMatchings": {
    "columns": [
      "string"
    ],
    "matched": [
      "string"
    ]
  },
  "dateFormat": "Default",
  "listSubitems": [
    "string"
  ],
  "subitemMap": {
    "property1": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    },
    "property2": {
      "name": [],
      "fieldName": [],
      "type": "Delimited",
      "delimiter": "string",
      "segment": 0,
      "selection": [],
      "fieldIndices": []
    }
  },
  "addMember": true,
  "updateExistingRows": true,
  "tableType": "System",
  "isLocal": true,
  "localCulture": {},
  "useIncrementalImport": true,
  "culture": "string",
  "tableEffectiveDated": true,
  "isODBCTextDriver": true,
  "version": {
    "rowVersion": 0
  },
  "fileOverwrite": true,
  "importId": 0,
  "filename": "string",
  "localPath": "string",
  "username": "string",
  "password": "string",
  "delimiter": "string",
  "sheetName": "string",
  "cellRange": "string",
  "query": "string",
  "queryTimeout": 0,
  "connectionString": "string",
  "useAdvanced": true,
  "model": "string",
  "importMethod": 0,
  "sourceTableName": "string",
  "securityToken": "string",
  "customColumns": [
    "string"
  ],
  "userSelected": true,
  "sandbox": true,
  "fileLocation": "string",
  "codePage": 0,
  "ignoreFirst": true,
  "ignoreLast": true,
  "recordLength": 0,
  "fields": [
    {
      "name": "string",
      "offset": 0,
      "length": 0,
      "dataType": "String"
    }
  ],
  "selectRowNode": "string",
  "pipeConnection": {
    "pipeID": "string",
    "inputID": "string",
    "outputID": "string",
    "outputName": "string",
    "lastValidated": "2019-08-24T14:15:22Z",
    "inputMapping": [
      {}
    ],
    "outputMapping": [
      {}
    ]
  },
  "inputTable": "string",
  "uploadStage": true,
  "predictStage": true,
  "downloadStage": true,
  "symonImportType": "None",
  "refreshAllPipeDatasources": true,
  "connectorID": "string",
  "streamID": "string",
  "importConfig": null,
  "outputMapping": [
    {
      "source": "string",
      "destination": "string",
      "type": "String"
    }
  ]
}

RESTAPI.v2.DTOs.FileDTO

Properties

Name

Type

Required

Restrictions

Description

fileId

integer(int32)

false

none

none

data64

string¦null

false

none

none

chunkNo

integer(int32)

false

none

none

tempFileName

string¦null

false

none

none

json
{
  "fileId": 0,
  "data64": "string",
  "chunkNo": 0,
  "tempFileName": "string"
}

RESTAPI.v2.DTOs.HealthDashboard.HealthMetricDTO

Properties

Name

Type

Required

Restrictions

Description

id

string¦null

false

none

none

name

string¦null

false

none

none

description

string¦null

false

none

none

json
{
  "id": "string",
  "name": "string",
  "description": "string"
}

RESTAPI.v2.DTOs.HealthDashboard.HealthMetricLinkDTO

Properties

Name

Type

Required

Restrictions

Description

type

string

false

none

none

name

string¦null

false

none

none

column

integer(int32)

false

none

none

link

string¦null

false

none

none

Enumerated Values

Property

Value

type

Block

type

Table

type

Calculation

type

Plan

type

TailoredReport

type

WebForm

type

WebReport

type

InputPort

type

OutputPort

type

Library

type

DataStore

type

AssignTable

type

Hub

type

Waypoint

type

InsertionPoint

json
{
  "type": "Block",
  "name": "string",
  "column": 0,
  "link": "string"
}

RESTAPI.v2.DTOs.HealthDashboard.HealthMetricResultItemReviewDTO

Properties

Name

Type

Required

Restrictions

Description

snapshotID

integer(int32)

false

none

none

metricID

string¦null

false

none

none

rowID

integer(int32)

false

none

none

objectID

string¦null

false

none

none

reviewed

integer(int32)

false

none

none

comment

string¦null

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "snapshotID": 0,
  "metricID": "string",
  "rowID": 0,
  "objectID": "string",
  "reviewed": 0,
  "comment": "string",
  "version": {
    "rowVersion": 0
  }
}

RESTAPI.v2.DTOs.HealthDashboard.HealthMetricSnapshotDetailsDTO

Properties

Name

Type

Required

Restrictions

Description

summary

RESTAPI.v2.DTOs.HealthDashboard.HealthMetricSummaryDTO

false

none

none

details

Varicent.RESTAPI.v1.DTOs.ResultSetDTO Varicent.RESTAPI.v1.DTOs.ResultSetDTO

false

none

none

links

[RESTAPI.v2.DTOs.HealthDashboard.HealthMetricLinkDTO]¦null

false

none

none

reviews

[RESTAPI.v2.DTOs.HealthDashboard.HealthMetricResultItemReviewDTO]¦null

false

none

none

displayType

[string]¦null

false

none

none

json
{
  "summary": {
    "metric": {
      "id": "string",
      "name": "string",
      "description": "string"
    },
    "status": "Success",
    "value": 0
  },
  "details": {
    "columnDefinitions": [
      {}
    ],
    "data": [
      null
    ],
    "columnSourceMap": {
      "property1": "string",
      "property2": "string"
    },
    "isDataSynced": true,
    "hierarchyMetadata": {
      "tableName": "string",
      "idColumnName": "string",
      "parentColumnName": "string"
    }
  },
  "links": [
    {
      "type": "Block",
      "name": "string",
      "column": 0,
      "link": "string"
    }
  ],
  "reviews": [
    {
      "snapshotID": 0,
      "metricID": "string",
      "rowID": 0,
      "objectID": "string",
      "reviewed": 0,
      "comment": "string",
      "version": {}
    }
  ],
  "displayType": [
    "String"
  ]
}

RESTAPI.v2.DTOs.HealthDashboard.HealthMetricSummaryDTO

Properties

Name

Type

Required

Restrictions

Description

metric

RESTAPI.v2.DTOs.HealthDashboard.HealthMetricDTO

false

none

none

status

string

false

none

none

value

integer(int32)

false

none

none

Enumerated Values

Property

Value

status

Success

status

Warning

status

Fail

status

Unknown

status

NoStatus

json
{
  "metric": {
    "id": "string",
    "name": "string",
    "description": "string"
  },
  "status": "Success",
  "value": 0
}

RESTAPI.v2.DTOs.HealthDashboard.HealthMetricsResponseDTO

Properties

Name

Type

Required

Restrictions

Description

metrics

[RESTAPI.v2.DTOs.HealthDashboard.HealthMetricDTO]¦null

false

none

none

json
{
  "metrics": [
    {
      "id": "string",
      "name": "string",
      "description": "string"
    }
  ]
}

RESTAPI.v2.DTOs.HealthDashboard.HealthSnapshotDTO

Properties

Name

Type

Required

Restrictions

Description

snapshotID

integer(int32)

false

none

none

runDate

string(date-time)

false

none

none

json
{
  "snapshotID": 0,
  "runDate": "2019-08-24T14:15:22Z"
}

RESTAPI.v2.DTOs.HealthDashboard.HealthSnapshotDetailsResponseDTO

Properties

Name

Type

Required

Restrictions

Description

snapshotID

integer(int32)

false

none

none

runDate

string(date-time)

false

none

none

metrics

[RESTAPI.v2.DTOs.HealthDashboard.HealthMetricSnapshotDetailsDTO]¦null

false

none

none

json
{
  "snapshotID": 0,
  "runDate": "2019-08-24T14:15:22Z",
  "metrics": [
    {
      "summary": {},
      "details": {},
      "links": [],
      "reviews": [],
      "displayType": []
    }
  ]
}

RESTAPI.v2.DTOs.HealthDashboard.HealthSnapshotRequestDTO

Properties

Name

Type

Required

Restrictions

Description

metricIDs

[string]¦null

false

none

none

json
{
  "metricIDs": [
    "string"
  ]
}

RESTAPI.v2.DTOs.HealthDashboard.HealthSnapshotResponseDTO

Properties

Name

Type

Required

Restrictions

Description

snapshotID

integer(int32)

false

none

none

metrics

[RESTAPI.v2.DTOs.HealthDashboard.HealthMetricSummaryDTO]¦null

false

none

none

json
{
  "snapshotID": 0,
  "metrics": [
    {
      "metric": {},
      "status": "Success",
      "value": 0
    }
  ]
}

RESTAPI.v2.DTOs.HealthDashboard.HealthSnapshotsResponseDTO

Properties

Name

Type

Required

Restrictions

Description

snapshots

[RESTAPI.v2.DTOs.HealthDashboard.HealthSnapshotDTO]¦null

false

none

none

json
{
  "snapshots": [
    {
      "snapshotID": 0,
      "runDate": "2019-08-24T14:15:22Z"
    }
  ]
}

RESTAPI.v2.DTOs.HelpVideoKBConfigDTO

Properties

Name

Type

Required

Restrictions

Description

cloudBase

string¦null

false

none

none

kBBase

string¦null

false

none

none

kBOn

boolean

false

none

none

cloudOn

boolean

false

none

none

publicKeyID

string¦null

false

none

none

signature

string¦null

false

none

none

encodedCustomPolicy

string¦null

false

none

none

expires

string¦null

false

none

none

sampleQuery

string¦null

false

none

none

json
{
  "cloudBase": "string",
  "kBBase": "string",
  "kBOn": true,
  "cloudOn": true,
  "publicKeyID": "string",
  "signature": "string",
  "encodedCustomPolicy": "string",
  "expires": "string",
  "sampleQuery": "string"
}

RESTAPI.v2.DTOs.ImportFileDTO

Properties

Name

Type

Required

Restrictions

Description

fileId

integer(int32)

false

none

none

fileName

string¦null

false

none

none

fileType

string

false

none

none

chunkSize

integer(int32)

false

none

none

size

integer(int64)

false

none

none

currSize

integer(int64)

false

none

none

adminId

string¦null

false

none

none

time

string(date-time)

false

none

none

tempFileName

string¦null

false

none

none

isComplete

boolean

false

read-only

none

Enumerated Values

Property

Value

fileType

None

fileType

Data

fileType

Script

fileType

Image

fileType

Document

fileType

Publication

json
{
  "fileId": 0,
  "fileName": "string",
  "fileType": "None",
  "chunkSize": 0,
  "size": 0,
  "currSize": 0,
  "adminId": "string",
  "time": "2019-08-24T14:15:22Z",
  "tempFileName": "string",
  "isComplete": true
}

RESTAPI.v2.DTOs.NewFileDTO

Properties

Name

Type

Required

Restrictions

Description

fileId

integer(int32)

false

none

none

fileName

string¦null

false

none

none

fileType

string

false

none

none

size

integer(int64)

false

none

none

currSize

integer(int64)

false

none

none

chunkSize

integer(int32)

false

none

none

overwrite

boolean

false

none

none

Enumerated Values

Property

Value

fileType

None

fileType

Data

fileType

Script

fileType

Image

fileType

Document

fileType

Publication

json
{
  "fileId": 0,
  "fileName": "string",
  "fileType": "None",
  "size": 0,
  "currSize": 0,
  "chunkSize": 0,
  "overwrite": true
}

RESTAPI.v2.DTOs.Symon.CosPublishDTO

Properties

Name

Type

Required

Restrictions

Description

cosLocation

RESTAPI.v1.DTOs.Symon.CosLocationDTO

false

none

none

cosCredentials

RESTAPI.v1.DTOs.Composer.DataImport.CosCredentialsDTO

false

none

none

columnMappings

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

none

useCSV

boolean

false

none

none

json
{
  "cosLocation": {
    "bucket": "string",
    "key": "string"
  },
  "cosCredentials": {
    "endpoint": "string",
    "accessKey": "string",
    "secretKey": "string",
    "sessionToken": "string",
    "taskAuthToken": "string",
    "taskAuthEndpoint": "string",
    "taskAuthExpiration": "string"
  },
  "columnMappings": [
    {
      "source": "string",
      "destination": "string",
      "type": "String"
    }
  ],
  "useCSV": true
}

RESTAPI.v2.DTOs.Symon.CosSourceDTO

Properties

Name

Type

Required

Restrictions

Description

columnMapping

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

none

cosLocations

[RESTAPI.v1.DTOs.Symon.CosLocationDTO]¦null

false

none

none

cosCredentials

RESTAPI.v1.DTOs.Composer.DataImport.CosCredentialsDTO

false

none

none

addMembers

boolean

false

none

none

updateExistingRows

boolean

false

none

none

cancelOnUpdates

boolean

false

none

none

isEffectiveDated

boolean¦null

false

none

none

csvDateFormat

string

false

none

none

Enumerated Values

Property

Value

csvDateFormat

Default

csvDateFormat

DayFirst

csvDateFormat

MonthFirst

json
{
  "columnMapping": [
    {
      "source": "string",
      "destination": "string",
      "type": "String"
    }
  ],
  "cosLocations": [
    {
      "bucket": "string",
      "key": "string"
    }
  ],
  "cosCredentials": {
    "endpoint": "string",
    "accessKey": "string",
    "secretKey": "string",
    "sessionToken": "string",
    "taskAuthToken": "string",
    "taskAuthEndpoint": "string",
    "taskAuthExpiration": "string"
  },
  "addMembers": true,
  "updateExistingRows": true,
  "cancelOnUpdates": true,
  "isEffectiveDated": true,
  "csvDateFormat": "Default"
}

Salesforce.partner.ActionOverride

Properties

Name

Type

Required

Restrictions

Description

formFactor

string¦null

false

none

none

isAvailableInTouch

boolean

false

none

none

name

string¦null

false

none

none

pageId

string¦null

false

none

none

url

string¦null

false

none

none

json
{
  "formFactor": "string",
  "isAvailableInTouch": true,
  "name": "string",
  "pageId": "string",
  "url": "string"
}

Salesforce.partner.ChildRelationship

Properties

Name

Type

Required

Restrictions

Description

cascadeDelete

boolean

false

none

none

childSObject

string¦null

false

none

none

deprecatedAndHidden

boolean

false

none

none

field

string¦null

false

none

none

junctionIdListNames

[string]¦null

false

none

none

junctionReferenceTo

[string]¦null

false

none

none

relationshipName

string¦null

false

none

none

restrictedDelete

boolean

false

none

none

restrictedDeleteSpecified

boolean

false

none

none

json
{
  "cascadeDelete": true,
  "childSObject": "string",
  "deprecatedAndHidden": true,
  "field": "string",
  "junctionIdListNames": [
    "string"
  ],
  "junctionReferenceTo": [
    "string"
  ],
  "relationshipName": "string",
  "restrictedDelete": true,
  "restrictedDeleteSpecified": true
}

Salesforce.partner.DescribeSObjectResult

Properties

Name

Type

Required

Restrictions

Description

actionOverrides

[Salesforce.partner.ActionOverride]¦null

false

none

none

activateable

boolean

false

none

none

childRelationships

[Salesforce.partner.ChildRelationship]¦null

false

none

none

compactLayoutable

boolean

false

none

none

createable

boolean

false

none

none

custom

boolean

false

none

none

customSetting

boolean

false

none

none

dataTranslationEnabled

boolean

false

none

none

dataTranslationEnabledSpecified

boolean

false

none

none

deepCloneable

boolean

false

none

none

defaultImplementation

string¦null

false

none

none

deletable

boolean

false

none

none

deprecatedAndHidden

boolean

false

none

none

feedEnabled

boolean

false

none

none

fields

[Salesforce.partner.Field]¦null

false

none

none

hasSubtypes

boolean

false

none

none

idEnabled

boolean

false

none

none

implementedBy

string¦null

false

none

none

implementsInterfaces

string¦null

false

none

none

isInterface

boolean

false

none

none

isSubtype

boolean

false

none

none

keyPrefix

string¦null

false

none

none

label

string¦null

false

none

none

labelPlural

string¦null

false

none

none

layoutable

boolean

false

none

none

mergeable

boolean

false

none

none

mruEnabled

boolean

false

none

none

name

string¦null

false

none

none

namedLayoutInfos

[Salesforce.partner.NamedLayoutInfo]¦null

false

none

none

networkScopeFieldName

string¦null

false

none

none

queryable

boolean

false

none

none

recordTypeInfos

[Salesforce.partner.RecordTypeInfo]¦null

false

none

none

replicateable

boolean

false

none

none

retrieveable

boolean

false

none

none

searchLayoutable

boolean

false

none

none

searchLayoutableSpecified

boolean

false

none

none

searchable

boolean

false

none

none

supportedScopes

[Salesforce.partner.ScopeInfo]¦null

false

none

none

triggerable

boolean

false

none

none

triggerableSpecified

boolean

false

none

none

undeletable

boolean

false

none

none

updateable

boolean

false

none

none

urlDetail

string¦null

false

none

none

urlEdit

string¦null

false

none

none

urlNew

string¦null

false

none

none

json
{
  "actionOverrides": [
    {
      "formFactor": "string",
      "isAvailableInTouch": true,
      "name": "string",
      "pageId": "string",
      "url": "string"
    }
  ],
  "activateable": true,
  "childRelationships": [
    {
      "cascadeDelete": true,
      "childSObject": "string",
      "deprecatedAndHidden": true,
      "field": "string",
      "junctionIdListNames": [],
      "junctionReferenceTo": [],
      "relationshipName": "string",
      "restrictedDelete": true,
      "restrictedDeleteSpecified": true
    }
  ],
  "compactLayoutable": true,
  "createable": true,
  "custom": true,
  "customSetting": true,
  "dataTranslationEnabled": true,
  "dataTranslationEnabledSpecified": true,
  "deepCloneable": true,
  "defaultImplementation": "string",
  "deletable": true,
  "deprecatedAndHidden": true,
  "feedEnabled": true,
  "fields": [
    {
      "aggregatable": true,
      "aiPredictionField": true,
      "autoNumber": true,
      "byteLength": 0,
      "calculated": true,
      "calculatedFormula": "string",
      "cascadeDelete": true,
      "cascadeDeleteSpecified": true,
      "caseSensitive": true,
      "compoundFieldName": "string",
      "controllerName": "string",
      "createable": true,
      "custom": true,
      "dataTranslationEnabled": true,
      "dataTranslationEnabledSpecified": true,
      "defaultValue": null,
      "defaultValueFormula": "string",
      "defaultedOnCreate": true,
      "dependentPicklist": true,
      "dependentPicklistSpecified": true,
      "deprecatedAndHidden": true,
      "digits": 0,
      "displayLocationInDecimal": true,
      "displayLocationInDecimalSpecified": true,
      "encrypted": true,
      "encryptedSpecified": true,
      "externalId": true,
      "externalIdSpecified": true,
      "extraTypeInfo": "string",
      "filterable": true,
      "filteredLookupInfo": {},
      "formulaTreatNullNumberAsZero": true,
      "formulaTreatNullNumberAsZeroSpecified": true,
      "groupable": true,
      "highScaleNumber": true,
      "highScaleNumberSpecified": true,
      "htmlFormatted": true,
      "htmlFormattedSpecified": true,
      "idLookup": true,
      "inlineHelpText": "string",
      "label": "string",
      "length": 0,
      "mask": "string",
      "maskType": "string",
      "name": "string",
      "nameField": true,
      "namePointing": true,
      "namePointingSpecified": true,
      "nillable": true,
      "permissionable": true,
      "picklistValues": [],
      "polymorphicForeignKey": true,
      "precision": 0,
      "queryByDistance": true,
      "referenceTargetField": "string",
      "referenceTo": [],
      "relationshipName": "string",
      "relationshipOrder": 0,
      "relationshipOrderSpecified": true,
      "restrictedDelete": true,
      "restrictedDeleteSpecified": true,
      "restrictedPicklist": true,
      "scale": 0,
      "searchPrefilterable": true,
      "soapType": "tnsID",
      "sortable": true,
      "sortableSpecified": true,
      "type": "string",
      "unique": true,
      "updateable": true,
      "writeRequiresMasterRead": true,
      "writeRequiresMasterReadSpecified": true
    }
  ],
  "hasSubtypes": true,
  "idEnabled": true,
  "implementedBy": "string",
  "implementsInterfaces": "string",
  "isInterface": true,
  "isSubtype": true,
  "keyPrefix": "string",
  "label": "string",
  "labelPlural": "string",
  "layoutable": true,
  "mergeable": true,
  "mruEnabled": true,
  "name": "string",
  "namedLayoutInfos": [
    {
      "name": "string"
    }
  ],
  "networkScopeFieldName": "string",
  "queryable": true,
  "recordTypeInfos": [
    {
      "active": true,
      "available": true,
      "defaultRecordTypeMapping": true,
      "developerName": "string",
      "master": true,
      "name": "string",
      "recordTypeId": "string"
    }
  ],
  "replicateable": true,
  "retrieveable": true,
  "searchLayoutable": true,
  "searchLayoutableSpecified": true,
  "searchable": true,
  "supportedScopes": [
    {
      "label": "string",
      "name": "string"
    }
  ],
  "triggerable": true,
  "triggerableSpecified": true,
  "undeletable": true,
  "updateable": true,
  "urlDetail": "string",
  "urlEdit": "string",
  "urlNew": "string"
}

Salesforce.partner.Field

Properties

Name

Type

Required

Restrictions

Description

aggregatable

boolean

false

none

none

aiPredictionField

boolean

false

none

none

autoNumber

boolean

false

none

none

byteLength

integer(int32)

false

none

none

calculated

boolean

false

none

none

calculatedFormula

string¦null

false

none

none

cascadeDelete

boolean

false

none

none

cascadeDeleteSpecified

boolean

false

none

none

caseSensitive

boolean

false

none

none

compoundFieldName

string¦null

false

none

none

controllerName

string¦null

false

none

none

createable

boolean

false

none

none

custom

boolean

false

none

none

dataTranslationEnabled

boolean

false

none

none

dataTranslationEnabledSpecified

boolean

false

none

none

defaultValue

any

false

none

none

defaultValueFormula

string¦null

false

none

none

defaultedOnCreate

boolean

false

none

none

dependentPicklist

boolean

false

none

none

dependentPicklistSpecified

boolean

false

none

none

deprecatedAndHidden

boolean

false

none

none

digits

integer(int32)

false

none

none

displayLocationInDecimal

boolean

false

none

none

displayLocationInDecimalSpecified

boolean

false

none

none

encrypted

boolean

false

none

none

encryptedSpecified

boolean

false

none

none

externalId

boolean

false

none

none

externalIdSpecified

boolean

false

none

none

extraTypeInfo

string¦null

false

none

none

filterable

boolean

false

none

none

filteredLookupInfo

Salesforce.partner.FilteredLookupInfo

false

none

none

formulaTreatNullNumberAsZero

boolean

false

none

none

formulaTreatNullNumberAsZeroSpecified

boolean

false

none

none

groupable

boolean

false

none

none

highScaleNumber

boolean

false

none

none

highScaleNumberSpecified

boolean

false

none

none

htmlFormatted

boolean

false

none

none

htmlFormattedSpecified

boolean

false

none

none

idLookup

boolean

false

none

none

inlineHelpText

string¦null

false

none

none

label

string¦null

false

none

none

length

integer(int32)

false

none

none

mask

string¦null

false

none

none

maskType

string¦null

false

none

none

name

string¦null

false

none

none

nameField

boolean

false

none

none

namePointing

boolean

false

none

none

namePointingSpecified

boolean

false

none

none

nillable

boolean

false

none

none

permissionable

boolean

false

none

none

picklistValues

[Salesforce.partner.PicklistEntry]¦null

false

none

none

polymorphicForeignKey

boolean

false

none

none

precision

integer(int32)

false

none

none

queryByDistance

boolean

false

none

none

referenceTargetField

string¦null

false

none

none

referenceTo

[string]¦null

false

none

none

relationshipName

string¦null

false

none

none

relationshipOrder

integer(int32)

false

none

none

relationshipOrderSpecified

boolean

false

none

none

restrictedDelete

boolean

false

none

none

restrictedDeleteSpecified

boolean

false

none

none

restrictedPicklist

boolean

false

none

none

scale

integer(int32)

false

none

none

searchPrefilterable

boolean

false

none

none

soapType

string

false

none

none

sortable

boolean

false

none

none

sortableSpecified

boolean

false

none

none

type

string

false

none

none

unique

boolean

false

none

none

updateable

boolean

false

none

none

writeRequiresMasterRead

boolean

false

none

none

writeRequiresMasterReadSpecified

boolean

false

none

none

Enumerated Values

Property

Value

soapType

tnsID

soapType

xsdbase64Binary

soapType

xsdboolean

soapType

xsddouble

soapType

xsdint

soapType

xsdstring

soapType

xsddate

soapType

xsddateTime

soapType

xsdtime

soapType

tnslocation

soapType

tnsaddress

soapType

xsdanyType

soapType

tnsjson

soapType

urnRelationshipReferenceTo

soapType

urnJunctionIdListNames

soapType

urnSearchLayoutFieldsDisplayed

soapType

urnSearchLayoutField

soapType

urnSearchLayoutButtonsDisplayed

soapType

urnSearchLayoutButton

soapType

urnRecordTypesSupported

soapType

tnsStringList

soapType

tnsChangeEventHeader

type

string

type

picklist

type

multipicklist

type

combobox

type

reference

type

base64

type

boolean

type

currency

type

textarea

type

int

type

double

type

percent

type

phone

type

id

type

date

type

datetime

type

time

type

url

type

email

type

encryptedstring

type

datacategorygroupreference

type

location

type

address

type

anyType

type

complexvalue

type

long

json
{
  "aggregatable": true,
  "aiPredictionField": true,
  "autoNumber": true,
  "byteLength": 0,
  "calculated": true,
  "calculatedFormula": "string",
  "cascadeDelete": true,
  "cascadeDeleteSpecified": true,
  "caseSensitive": true,
  "compoundFieldName": "string",
  "controllerName": "string",
  "createable": true,
  "custom": true,
  "dataTranslationEnabled": true,
  "dataTranslationEnabledSpecified": true,
  "defaultValue": null,
  "defaultValueFormula": "string",
  "defaultedOnCreate": true,
  "dependentPicklist": true,
  "dependentPicklistSpecified": true,
  "deprecatedAndHidden": true,
  "digits": 0,
  "displayLocationInDecimal": true,
  "displayLocationInDecimalSpecified": true,
  "encrypted": true,
  "encryptedSpecified": true,
  "externalId": true,
  "externalIdSpecified": true,
  "extraTypeInfo": "string",
  "filterable": true,
  "filteredLookupInfo": {
    "controllingFields": [
      "string"
    ],
    "dependent": true,
    "optionalFilter": true
  },
  "formulaTreatNullNumberAsZero": true,
  "formulaTreatNullNumberAsZeroSpecified": true,
  "groupable": true,
  "highScaleNumber": true,
  "highScaleNumberSpecified": true,
  "htmlFormatted": true,
  "htmlFormattedSpecified": true,
  "idLookup": true,
  "inlineHelpText": "string",
  "label": "string",
  "length": 0,
  "mask": "string",
  "maskType": "string",
  "name": "string",
  "nameField": true,
  "namePointing": true,
  "namePointingSpecified": true,
  "nillable": true,
  "permissionable": true,
  "picklistValues": [
    {
      "active": true,
      "defaultValue": true,
      "label": "string",
      "validFor": "string",
      "value": "string"
    }
  ],
  "polymorphicForeignKey": true,
  "precision": 0,
  "queryByDistance": true,
  "referenceTargetField": "string",
  "referenceTo": [
    "string"
  ],
  "relationshipName": "string",
  "relationshipOrder": 0,
  "relationshipOrderSpecified": true,
  "restrictedDelete": true,
  "restrictedDeleteSpecified": true,
  "restrictedPicklist": true,
  "scale": 0,
  "searchPrefilterable": true,
  "soapType": "tnsID",
  "sortable": true,
  "sortableSpecified": true,
  "type": "string",
  "unique": true,
  "updateable": true,
  "writeRequiresMasterRead": true,
  "writeRequiresMasterReadSpecified": true
}

Salesforce.partner.FilteredLookupInfo

Properties

Name

Type

Required

Restrictions

Description

controllingFields

[string]¦null

false

none

none

dependent

boolean

false

none

none

optionalFilter

boolean

false

none

none

json
{
  "controllingFields": [
    "string"
  ],
  "dependent": true,
  "optionalFilter": true
}

Salesforce.partner.NamedLayoutInfo

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

json
{
  "name": "string"
}

Salesforce.partner.PicklistEntry

Properties

Name

Type

Required

Restrictions

Description

active

boolean

false

none

none

defaultValue

boolean

false

none

none

label

string¦null

false

none

none

validFor

string(byte)¦null

false

none

none

value

string¦null

false

none

none

json
{
  "active": true,
  "defaultValue": true,
  "label": "string",
  "validFor": "string",
  "value": "string"
}

Salesforce.partner.RecordTypeInfo

Properties

Name

Type

Required

Restrictions

Description

active

boolean

false

none

none

available

boolean

false

none

none

defaultRecordTypeMapping

boolean

false

none

none

developerName

string¦null

false

none

none

master

boolean

false

none

none

name

string¦null

false

none

none

recordTypeId

string¦null

false

none

none

json
{
  "active": true,
  "available": true,
  "defaultRecordTypeMapping": true,
  "developerName": "string",
  "master": true,
  "name": "string",
  "recordTypeId": "string"
}

Salesforce.partner.ScopeInfo

Properties

Name

Type

Required

Restrictions

Description

label

string¦null

false

none

none

name

string¦null

false

none

none

json
{
  "label": "string",
  "name": "string"
}

System.Collections.Generic.KeyValuePair2[System.String,System.Collections.Generic.IEnumerable1[System.String]]

Properties

Name

Type

Required

Restrictions

Description

key

string¦null

false

none

none

value

[string]¦null

false

none

none

json
{
  "key": "string",
  "value": [
    "string"
  ]
}

Properties

Name

Type

Required

Restrictions

Description

key

string¦null

false

none

none

value

string¦null

false

none

none

json
{
  "key": "string",
  "value": "string"
}

Properties

Name

Type

Required

Restrictions

Description

key

string

false

none

none

value

string¦null

false

none

none

Enumerated Values

Property

Value

key

Block

key

Table

key

Calculation

key

Plan

key

TailoredReport

key

WebForm

key

WebReport

key

InputPort

key

OutputPort

key

Library

key

DataStore

key

AssignTable

key

Hub

key

Waypoint

key

InsertionPoint

json
{
  "key": "Block",
  "value": "string"
}

System.Drawing.PointF

Properties

Name

Type

Required

Restrictions

Description

isEmpty

boolean

false

read-only

none

x

number(float)

false

none

none

y

number(float)

false

none

none

json
{
  "isEmpty": true,
  "x": 0.1,
  "y": 0.1
}

System.Drawing.RectangleF

Properties

Name

Type

Required

Restrictions

Description

location

System.Drawing.PointF

false

none

none

size

string

false

none

none

x

number(float)

false

none

none

y

number(float)

false

none

none

width

number(float)

false

none

none

height

number(float)

false

none

none

left

number(float)

false

read-only

none

top

number(float)

false

read-only

none

right

number(float)

false

read-only

none

bottom

number(float)

false

read-only

none

isEmpty

boolean

false

read-only

none

json
{
  "location": {
    "isEmpty": true,
    "x": 0.1,
    "y": 0.1
  },
  "size": "string",
  "x": 0.1,
  "y": 0.1,
  "width": 0.1,
  "height": 0.1,
  "left": 0.1,
  "top": 0.1,
  "right": 0.1,
  "bottom": 0.1,
  "isEmpty": true
}

System.IFormatProvider

Properties

None

json
{}

System.Net.Http.StreamContent

Properties

json
{
  "headers": [
    {
      "key": "string",
      "value": []
    }
  ]
}

Properties

Name

Type

Required

Restrictions

Description

item1

string(date-time)

false

none

none

item2

string(date-time)

false

none

none

json
{
  "item1": "2019-08-24T14:15:22Z",
  "item2": "2019-08-24T14:15:22Z"
}

Properties

Name

Type

Required

Restrictions

Description

item1

integer(int32)

false

none

none

item2

boolean

false

none

none

json
{
  "item1": 0,
  "item2": true
}

Properties

Name

Type

Required

Restrictions

Description

item1

string¦null

false

none

none

item2

string¦null

false

none

none

item3

string¦null

false

none

none

json
{
  "item1": "string",
  "item2": "string",
  "item3": "string"
}

Varicent.Domain.Audit.AuditItem

Properties

Name

Type

Required

Restrictions

Description

message

string¦null

false

none

none

hasHistory

boolean

false

none

none

auditId

integer(int32)

false

none

none

type

string

false

none

none

userId

string¦null

false

none

none

module

string¦null

false

none

none

event

string¦null

false

read-only

none

time

string(date-time)

false

none

none

revisionStart

integer(int32)¦null

false

none

none

revisionEnd

integer(int32)¦null

false

none

none

Enumerated Values

Property

Value

type

Admin

type

Web

type

Anonymous

json
{
  "message": "string",
  "hasHistory": true,
  "auditId": 0,
  "type": "Admin",
  "userId": "string",
  "module": "string",
  "event": "string",
  "time": "2019-08-24T14:15:22Z",
  "revisionStart": 0,
  "revisionEnd": 0
}

Varicent.Domain.BPM.BPMDocument

Properties

Name

Type

Required

Restrictions

Description

documentID

integer(int32)

false

none

none

tokenID

integer(int32)

false

none

none

name

string¦null

false

none

none

type

string

false

none

none

Enumerated Values

Property

Value

type

Attachment

type

GeneratedPdf

type

SignedPdf

json
{
  "documentID": 0,
  "tokenID": 0,
  "name": "string",
  "type": "Attachment"
}

Varicent.Domain.DataModule.TableAudit

Properties

Name

Type

Required

Restrictions

Description

tableName

string¦null

false

none

none

userID

string¦null

false

none

none

inserts

integer(int64)

false

none

none

updates

integer(int64)

false

none

none

deletes

integer(int64)

false

none

none

eventType

string

false

none

none

importType

string¦null

false

none

none

startTime

string(date-time)

false

none

none

endTime

string(date-time)

false

none

none

Enumerated Values

Property

Value

eventType

RowAdd

eventType

RowUpdate

eventType

RowDelete

eventType

TableClear

eventType

Import

eventType

ScheduledImport

eventType

TableCreated

eventType

SystemUpdate

importType

None

importType

Text

importType

Excel

importType

DBImport

importType

Salesforce

importType

MSCRM

importType

EBCDICText

importType

TerrAlign

importType

XML

importType

ODBCImport

importType

SymonImport

importType

SymonConnectorImport

importType

Cos

importType

SQLServer

importType

Dynamics

importType

GoogleSheets

importType

MySql

importType

AmazonAurora

importType

AmazonS3

importType

Snowflake

importType

Shopify

importType

Hubspot

importType

Oracle

importType

AmazonRedshift

importType

Workday

json
{
  "tableName": "string",
  "userID": "string",
  "inserts": 0,
  "updates": 0,
  "deletes": 0,
  "eventType": "RowAdd",
  "importType": "None",
  "startTime": "2019-08-24T14:15:22Z",
  "endTime": "2019-08-24T14:15:22Z"
}

Varicent.Domain.Slack.InteractionObject

Properties

Name

Type

Required

Restrictions

Description

payload

any

false

none

none

json
{
  "payload": null
}

Varicent.Domain.Themes.FooterCustomColor

Properties

Name

Type

Required

Restrictions

Description

backgroundColor

string¦null

false

none

none

textColor

string¦null

false

none

none

linkColor

string¦null

false

none

none

json
{
  "backgroundColor": "string",
  "textColor": "string",
  "linkColor": "string"
}

Varicent.Domain.Themes.NavBarCustomColor

Properties

Name

Type

Required

Restrictions

Description

backgroundColor

string¦null

false

none

none

highlightColor

string¦null

false

none

none

textIconColor

string¦null

false

none

none

json
{
  "backgroundColor": "string",
  "highlightColor": "string",
  "textIconColor": "string"
}

Varicent.RESTAPI.Models.SftpDataDTO

Properties

Name

Type

Required

Restrictions

Description

tenant_id

string¦null

false

none

none

model_id

string¦null

false

none

none

model_name

string¦null

false

none

none

sftp_quota_gb

integer(int32)

false

none

none

sftp_usage_mb

integer(int32)

false

none

none

sftp_usage_last_updated

string¦null

false

none

none

json
{
  "tenant_id": "string",
  "model_id": "string",
  "model_name": "string",
  "sftp_quota_gb": 0,
  "sftp_usage_mb": 0,
  "sftp_usage_last_updated": "string"
}

Varicent.RESTAPI.Utils.Json.Converters.Date

Properties

None

json
{}

Varicent.RESTAPI.v1.DTOs.AdminUserAuditLogDTO

Properties

Name

Type

Required

Restrictions

Description

userIds

[string]¦null

false

none

none

modelMap

object¦null

false

none

none

» additionalProperties

string¦null

false

none

none

featureFlagsMap

object¦null

false

none

none

» additionalProperties

string¦null

false

none

none

eventName

string¦null

false

none

none

targetUser

string¦null

false

none

none

name

string¦null

false

none

none

adminUserAuditLogEnabled

boolean

false

none

none

json
{
  "userIds": [
    "string"
  ],
  "modelMap": {
    "property1": "string",
    "property2": "string"
  },
  "featureFlagsMap": {
    "property1": "string",
    "property2": "string"
  },
  "eventName": "string",
  "targetUser": "string",
  "name": "string",
  "adminUserAuditLogEnabled": true
}

Varicent.RESTAPI.v1.DTOs.AdminUserDTO

Properties

Name

Type

Required

Restrictions

Description

id

string¦null

false

none

none

name

string¦null

false

none

none

email

string¦null

false

none

none

role

string¦null

false

none

none

createdAt

string(date-time)

false

none

none

disabled

boolean

false

none

none

isVaricentUser

boolean

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "id": "string",
  "name": "string",
  "email": "string",
  "role": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "disabled": true,
  "isVaricentUser": true,
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.AuditErrorItemDTO

Properties

Name

Type

Required

Restrictions

Description

timestamp

string(date-time)

false

none

none

error

string¦null

false

none

none

json
{
  "timestamp": "2019-08-24T14:15:22Z",
  "error": "string"
}

Varicent.RESTAPI.v1.DTOs.AuditItemDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

userType

string

false

none

none

userId

string¦null

false

none

none

module

string¦null

false

none

none

eventName

string¦null

false

none

none

time

string(date-time)

false

none

none

revisionStart

integer(int32)¦null

false

none

none

revisionEnd

integer(int32)¦null

false

none

none

message

string¦null

false

none

none

hasHistory

boolean

false

none

none

Enumerated Values

Property

Value

userType

Admin

userType

Web

userType

Anonymous

json
{
  "id": 0,
  "userType": "Admin",
  "userId": "string",
  "module": "string",
  "eventName": "string",
  "time": "2019-08-24T14:15:22Z",
  "revisionStart": 0,
  "revisionEnd": 0,
  "message": "string",
  "hasHistory": true
}

Varicent.RESTAPI.v1.DTOs.AuditItemDetailsDTO

Properties

Name

Type

Required

Restrictions

Description

columns

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

none

rowChanges

[Varicent.RESTAPI.v1.DTOs.RowChangeDTO]¦null

false

none

none

table

string¦null

false

none

none

json
{
  "columns": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "rowChanges": [
    {
      "start": [],
      "end": [],
      "rowChangeDiff": {}
    }
  ],
  "table": "string"
}

Varicent.RESTAPI.v1.DTOs.AuditLogPayeeLoginDTO

Properties

Name

Type

Required

Restrictions

Description

payeeID

string¦null

false

none

none

salesforceSessionId

string¦null

false

none

none

json
{
  "payeeID": "string",
  "salesforceSessionId": "string"
}

Varicent.RESTAPI.v1.DTOs.AuditLogSalesPortalUsageLogsDTO

Properties

Name

Type

Required

Restrictions

Description

salesPortalActionCategory

string¦null

false

none

none

salesPortalModuleName

string¦null

false

none

none

salesPortalSubModuleName

string¦null

false

none

none

salesPortalURL

string¦null

false

none

none

salesPortalWebTabName

string¦null

false

none

none

salesPortalWebTabType

string¦null

false

none

none

salesPortalReportName

string¦null

false

none

none

salesPortalReportTimestamp

string(date-time)

false

none

none

json
{
  "salesPortalActionCategory": "string",
  "salesPortalModuleName": "string",
  "salesPortalSubModuleName": "string",
  "salesPortalURL": "string",
  "salesPortalWebTabName": "string",
  "salesPortalWebTabType": "string",
  "salesPortalReportName": "string",
  "salesPortalReportTimestamp": "2019-08-24T14:15:22Z"
}

Varicent.RESTAPI.v1.DTOs.BPMAdminInquiryMonthInfoDTO

Properties

Name

Type

Required

Restrictions

Description

newInquiries

integer(int32)

false

none

none

totalInquiries

integer(int32)

false

none

none

averageOpenDays

integer(int32)

false

none

none

json
{
  "newInquiries": 0,
  "totalInquiries": 0,
  "averageOpenDays": 0
}

Varicent.RESTAPI.v1.DTOs.BPMComponentSelectionDTO

Properties

Name

Type

Required

Restrictions

Description

inquiryID

integer(int32)

false

none

none

componentID

integer(int32)

false

none

none

componentName

string¦null

false

none

none

componentType

string

false

none

none

componentValue

string¦null

false

none

none

componentSourceDrivenID

string¦null

false

none

none

Enumerated Values

Property

Value

componentType

pickList

componentType

title

componentType

subject

componentType

description

componentType

text

componentType

numeric

componentType

sourcePickList

json
{
  "inquiryID": 0,
  "componentID": 0,
  "componentName": "string",
  "componentType": "pickList",
  "componentValue": "string",
  "componentSourceDrivenID": "string"
}

Varicent.RESTAPI.v1.DTOs.BPMFolderDTO

Properties

Name

Type

Required

Restrictions

Description

folderID

integer(int32)

false

none

none

folderName

string¦null

false

none

none

rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

workflowType

string¦null

false

none

none

Enumerated Values

Property

Value

workflowType

PresenterReport

workflowType

Inquiry

workflowType

PlanApproval

workflowType

PresenterFlexReport

workflowType

PlanDocument

json
{
  "folderID": 0,
  "folderName": "string",
  "rowVersion": {
    "rowVersion": 0
  },
  "workflowType": "PresenterReport"
}

Varicent.RESTAPI.v1.DTOs.BPMInquiryDTO

Properties

Name

Type

Required

Restrictions

Description

inquiryID

integer(int32)

false

none

none

objectName

string¦null

false

none

none

objectType

string¦null

false

none

none

tokenID

integer(int32)

false

none

none

dateCreated

string(date-time)

false

none

none

creator

string¦null

false

none

none

payeeId

string¦null

false

none

none

workflowID

integer(int32)

false

none

none

workflowObjectID

integer(int32)

false

none

none

adminOwner

Varicent.RESTAPI.v1.DTOs.BPMInquiryOwnerDTO

false

none

none

status

string

false

none

none

inquiryState

string

false

none

none

subjectName

string¦null

false

none

none

openFor

integer(int32)

false

none

none

actionRequired

boolean

false

none

none

canReopen

boolean

false

none

none

lastUpdate

string(date-time)

false

none

none

isOpen

boolean

false

none

none

isNew

boolean

false

none

none

pickListValue

string¦null

false

none

none

copiedRow

string¦null

false

none

none

reportName

string¦null

false

none

none

componentValueList

object¦null

false

none

none

» additionalProperties

[System.Tuple3[System.String,System.String,System.String]](#schemasystem.tuple3[system.string,system.string,system.string])

false

none

none

rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

status

Entered

status

Investigating

status

Escalated

status

WaitingForApproval

status

MoreInfoRequired

status

Resolved

status

Closed

inquiryState

Default

inquiryState

FormFieldsReadOnly

inquiryState

ActionDisabled

json
{
  "inquiryID": 0,
  "objectName": "string",
  "objectType": "string",
  "tokenID": 0,
  "dateCreated": "2019-08-24T14:15:22Z",
  "creator": "string",
  "payeeId": "string",
  "workflowID": 0,
  "workflowObjectID": 0,
  "adminOwner": {
    "adminSwimLaneID": 0,
    "assignee": "string",
    "adminSwimlaneName": "string"
  },
  "status": "Entered",
  "inquiryState": "Default",
  "subjectName": "string",
  "openFor": 0,
  "actionRequired": true,
  "canReopen": true,
  "lastUpdate": "2019-08-24T14:15:22Z",
  "isOpen": true,
  "isNew": true,
  "pickListValue": "string",
  "copiedRow": "string",
  "reportName": "string",
  "componentValueList": {
    "property1": {
      "item1": "string",
      "item2": "string",
      "item3": "string"
    },
    "property2": {
      "item1": "string",
      "item2": "string",
      "item3": "string"
    }
  },
  "rowVersion": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.BPMInquiryOwnerDTO

Properties

Name

Type

Required

Restrictions

Description

adminSwimLaneID

integer(int32)

false

none

none

assignee

string¦null

false

none

none

adminSwimlaneName

string¦null

false

none

none

json
{
  "adminSwimLaneID": 0,
  "assignee": "string",
  "adminSwimlaneName": "string"
}

Varicent.RESTAPI.v1.DTOs.BPMInquirySubmissionDTO

Properties

Name

Type

Required

Restrictions

Description

inquiry

Varicent.RESTAPI.v1.DTOs.BPMInquiryDTO

false

none

none

componentSelectionList

[Varicent.RESTAPI.v1.DTOs.BPMComponentSelectionDTO]¦null

false

none

none

attachmentList

[Varicent.RESTAPI.v1.DTOs.PortalAccess.AttachmentItemDTO]¦null

false

none

none

reportType

string

false

none

none

reportScreenshot

Varicent.RESTAPI.v1.DTOs.PortalAccess.AttachmentItemDTO

false

none

none

Enumerated Values

Property

Value

reportType

PresenterAdaptive

reportType

DDE

reportType

Rapid

reportType

PresenterStructured

json
{
  "inquiry": {
    "inquiryID": 0,
    "objectName": "string",
    "objectType": "string",
    "tokenID": 0,
    "dateCreated": "2019-08-24T14:15:22Z",
    "creator": "string",
    "payeeId": "string",
    "workflowID": 0,
    "workflowObjectID": 0,
    "adminOwner": {
      "adminSwimLaneID": 0,
      "assignee": "string",
      "adminSwimlaneName": "string"
    },
    "status": "Entered",
    "inquiryState": "Default",
    "subjectName": "string",
    "openFor": 0,
    "actionRequired": true,
    "canReopen": true,
    "lastUpdate": "2019-08-24T14:15:22Z",
    "isOpen": true,
    "isNew": true,
    "pickListValue": "string",
    "copiedRow": "string",
    "reportName": "string",
    "componentValueList": {
      "property1": {},
      "property2": {}
    },
    "rowVersion": {
      "rowVersion": 0
    }
  },
  "componentSelectionList": [
    {
      "inquiryID": 0,
      "componentID": 0,
      "componentName": "string",
      "componentType": "pickList",
      "componentValue": "string",
      "componentSourceDrivenID": "string"
    }
  ],
  "attachmentList": [
    {
      "bytes": "string",
      "path": "string"
    }
  ],
  "reportType": "PresenterAdaptive",
  "reportScreenshot": {
    "bytes": "string",
    "path": "string"
  }
}

Varicent.RESTAPI.v1.DTOs.BPMInquiryViewDTO

Properties

Name

Type

Required

Restrictions

Description

inquiry

Varicent.RESTAPI.v1.DTOs.BPMInquiryDTO

false

none

none

paths

[RESTAPI.v1.DTOs.BPM.BPMPathDTO]¦null

false

none

none

comments

[RESTAPI.v1.DTOs.BPM.BPMInquiryCommentDTO]¦null

false

none

none

attachments

[string]¦null

false

none

none

json
{
  "inquiry": {
    "inquiryID": 0,
    "objectName": "string",
    "objectType": "string",
    "tokenID": 0,
    "dateCreated": "2019-08-24T14:15:22Z",
    "creator": "string",
    "payeeId": "string",
    "workflowID": 0,
    "workflowObjectID": 0,
    "adminOwner": {
      "adminSwimLaneID": 0,
      "assignee": "string",
      "adminSwimlaneName": "string"
    },
    "status": "Entered",
    "inquiryState": "Default",
    "subjectName": "string",
    "openFor": 0,
    "actionRequired": true,
    "canReopen": true,
    "lastUpdate": "2019-08-24T14:15:22Z",
    "isOpen": true,
    "isNew": true,
    "pickListValue": "string",
    "copiedRow": "string",
    "reportName": "string",
    "componentValueList": {
      "property1": {},
      "property2": {}
    },
    "rowVersion": {
      "rowVersion": 0
    }
  },
  "paths": [
    {
      "pathID": 0,
      "name": "string",
      "originNodeID": 0,
      "destinationNodeID": 0,
      "allMember": true,
      "allSubmit": true,
      "saveAndSubmit": true,
      "reviewResult": "Rejected",
      "position": 0,
      "condition": "string",
      "isDefault": true,
      "isSign": true
    }
  ],
  "comments": [
    {
      "commentID": 0,
      "author": "string",
      "authorName": "string",
      "admin": "string",
      "adminName": "string",
      "created": "2019-08-24T14:15:22Z",
      "text": "string",
      "commentType": "Comment",
      "componentName": "string",
      "prevComponentValue": "string",
      "newComponentValue": "string"
    }
  ],
  "attachments": [
    "string"
  ]
}

Varicent.RESTAPI.v1.DTOs.BPMNodeDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

swimLaneId

integer(int32)

false

none

none

name

string¦null

false

none

none

description

string¦null

false

none

none

order

integer(int32)

false

none

none

paths

[RESTAPI.v1.DTOs.BPM.BPMPathDTO]¦null

false

none

none

nodeType

string

false

none

none

schedulerFolderId

integer(int32)¦null

false

none

none

layoutAssignment

object¦null

false

none

none

» additionalProperties

[RESTAPI.v1.DTOs.PairDTO2[System.Boolean,System.Boolean]](#schemarestapi.v1.dtos.pairdto2[system.boolean,system.boolean])

false

none

none

expiryType

string

false

none

none

screenshotType

string¦null

false

none

none

useVaricentLogo

boolean¦null

false

none

none

expiryDateTime

string(date-time)¦null

false

none

none

expiryTimeLength

integer(int64)¦null

false

none

none

expiryPathID

integer(int32)¦null

false

none

none

sendNotification

boolean¦null

false

none

none

inquiryStatus

string¦null

false

none

none

alertType

string¦null

false

none

none

subject

string¦null

false

none

none

body

string¦null

false

none

none

externalEmails

[Varicent.RESTAPI.v1.DTOs.ExternalEmailDTO]¦null

false

none

none

autoAdjust

RESTAPI.v1.DTOs.BPM.BPMAutoAdjustNodeFieldDTO

false

none

none

isAdmin

boolean

false

none

none

swimLaneName

string¦null

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

objectRestrictions

object¦null

false

none

none

» additionalProperties

RESTAPI.v1.DTOs.BPM.BPMVisibilityEditabilityDTO

false

none

none

workflowId

integer(int32)¦null

false

none

none

reportId

integer(int32)¦null

false

none

none

isAppendPdf

boolean¦null

false

none

none

uploadedPdfName

string¦null

false

none

none

uploadedPdf

string¦null

false

none

none

pdfAppendOrder

string¦null

false

none

none

isUploadedExistingPdf

boolean¦null

false

none

none

Enumerated Values

Property

Value

nodeType

Start

nodeType

End

nodeType

Action

nodeType

Alert

nodeType

Process

nodeType

Conditional

nodeType

AutoAdjust

nodeType

GeneratePdf

nodeType

Sign

expiryType

None

expiryType

DateTime

expiryType

TimeLength

screenshotType

Unkown

screenshotType

Full

screenshotType

Preview

screenshotType

None

inquiryStatus

Entered

inquiryStatus

Investigating

inquiryStatus

Escalated

inquiryStatus

WaitingForApproval

inquiryStatus

MoreInfoRequired

inquiryStatus

Resolved

inquiryStatus

Closed

alertType

Email

alertType

InternalAndEmail

alertType

Internal

pdfAppendOrder

Unknown

pdfAppendOrder

AfterAgreement

pdfAppendOrder

BeforeAgreement

json
{
  "id": 0,
  "swimLaneId": 0,
  "name": "string",
  "description": "string",
  "order": 0,
  "paths": [
    {
      "pathID": 0,
      "name": "string",
      "originNodeID": 0,
      "destinationNodeID": 0,
      "allMember": true,
      "allSubmit": true,
      "saveAndSubmit": true,
      "reviewResult": "Rejected",
      "position": 0,
      "condition": "string",
      "isDefault": true,
      "isSign": true
    }
  ],
  "nodeType": "Start",
  "schedulerFolderId": 0,
  "layoutAssignment": {
    "property1": {
      "first": true,
      "second": true
    },
    "property2": {
      "first": true,
      "second": true
    }
  },
  "expiryType": "None",
  "screenshotType": "Unkown",
  "useVaricentLogo": true,
  "expiryDateTime": "2019-08-24T14:15:22Z",
  "expiryTimeLength": 0,
  "expiryPathID": 0,
  "sendNotification": true,
  "inquiryStatus": "Entered",
  "alertType": "Email",
  "subject": "string",
  "body": "string",
  "externalEmails": [
    {
      "email": "string",
      "isCC": true
    }
  ],
  "autoAdjust": {
    "sourceTableName": "string",
    "columnMappings": []
  },
  "isAdmin": true,
  "swimLaneName": "string",
  "version": {
    "rowVersion": 0
  },
  "objectRestrictions": {
    "property1": {
      "visible": true,
      "editable": true
    },
    "property2": {
      "visible": true,
      "editable": true
    }
  },
  "workflowId": 0,
  "reportId": 0,
  "isAppendPdf": true,
  "uploadedPdfName": "string",
  "uploadedPdf": "string",
  "pdfAppendOrder": "Unknown",
  "isUploadedExistingPdf": true
}

Varicent.RESTAPI.v1.DTOs.BPMWorkflowChildNodeDTO

Properties

Name

Type

Required

Restrictions

Description

workflow

Varicent.RESTAPI.v1.DTOs.BPMWorkflowDTO

false

none

none

parentFolderId

integer(int32)

false

none

none

json
{
  "workflow": {
    "id": 0,
    "name": "string",
    "description": "string",
    "isSingleInstance": true,
    "workflowState": "Stopped",
    "conditionalVars": [
      {}
    ],
    "columnCount": 0,
    "workflowConfig": {
      "pendingWorkflowEnabled": true
    },
    "runCount": 0,
    "runDate": "string",
    "runBy": "string",
    "lastActioned": "string",
    "workflowType": "PresenterReport",
    "webReport": {
      "parameters": [],
      "layoutAssignment": {},
      "webReportID": 0
    },
    "inquiry": {
      "hasRun": true,
      "components": []
    },
    "bpmWorkflowPresenterFlexReportDTO": {
      "reportId": 0,
      "parameters": [],
      "objectRestrictions": {}
    },
    "bpmWorkflowPlanDocPresenterFlexReportDTO": {
      "reportId": 0,
      "parameters": [],
      "templateType": "Payee"
    },
    "assignedReports": [
      "string"
    ],
    "numReportsAssigned": 0,
    "permissions": {
      "advanceToken": [],
      "viewDocuments": []
    },
    "parentFolder": {
      "folderID": 0,
      "folderName": "string",
      "rowVersion": {},
      "workflowType": "PresenterReport"
    },
    "parameters": [
      {}
    ],
    "layoutAssignment": {
      "property1": {},
      "property2": {}
    },
    "webReportID": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "parentFolderId": 0
}

Varicent.RESTAPI.v1.DTOs.BPMWorkflowConditionVariableDTO

Properties

Name

Type

Required

Restrictions

Description

expressionName

string¦null

false

none

none

name

string¦null

false

none

none

variableType

string

false

none

none

Enumerated Values

Property

Value

variableType

Text

variableType

Date

variableType

Numeric

json
{
  "expressionName": "string",
  "name": "string",
  "variableType": "Text"
}

Varicent.RESTAPI.v1.DTOs.BPMWorkflowDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

name

string¦null

false

none

none

description

string¦null

false

none

none

isSingleInstance

boolean

false

none

none

workflowState

string

false

none

none

conditionalVars

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowConditionVariableDTO]¦null

false

none

none

columnCount

integer(int32)

false

none

none

workflowConfig

RESTAPI.v1.DTOs.BPMWorkflowConfigDTO

false

none

none

runCount

integer(int32)

false

none

none

runDate

string¦null

false

none

none

runBy

string¦null

false

none

none

lastActioned

string¦null

false

none

none

workflowType

string

false

none

none

webReport

Varicent.RESTAPI.v1.DTOs.BPMWorkflowWebReportDTO

false

none

none

inquiry

Varicent.RESTAPI.v1.DTOs.BPMWorkflowInquiryDTO

false

none

none

bpmWorkflowPresenterFlexReportDTO

Varicent.RESTAPI.v1.DTOs.BPMWorkflowPresenterFlexReportDTO

false

none

none

bpmWorkflowPlanDocPresenterFlexReportDTO

Varicent.RESTAPI.v1.DTOs.BPMWorkflowPlanDocPresenterFlexReportDTO

false

none

none

assignedReports

[string]¦null

false

none

none

numReportsAssigned

integer(int32)

false

none

none

permissions

Varicent.RESTAPI.v1.DTOs.WorkflowPermissionsDTO

false

none

none

parentFolder

Varicent.RESTAPI.v1.DTOs.BPMFolderDTO

false

none

none

parameters

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowParameterDTO]¦null

false

none

none

layoutAssignment

object¦null

false

none

none

» additionalProperties

[RESTAPI.v1.DTOs.PairDTO2[System.Boolean,System.Boolean]](#schemarestapi.v1.dtos.pairdto2[system.boolean,system.boolean])

false

none

none

webReportID

integer(int32)

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

workflowState

Stopped

workflowState

Started

workflowState

Stopping

workflowState

Starting

workflowState

Archived

workflowState

Draft

workflowType

PresenterReport

workflowType

Inquiry

workflowType

PlanApproval

workflowType

PresenterFlexReport

workflowType

PlanDocument

json
{
  "id": 0,
  "name": "string",
  "description": "string",
  "isSingleInstance": true,
  "workflowState": "Stopped",
  "conditionalVars": [
    {
      "expressionName": "string",
      "name": "string",
      "variableType": "Text"
    }
  ],
  "columnCount": 0,
  "workflowConfig": {
    "pendingWorkflowEnabled": true
  },
  "runCount": 0,
  "runDate": "string",
  "runBy": "string",
  "lastActioned": "string",
  "workflowType": "PresenterReport",
  "webReport": {
    "parameters": [
      {}
    ],
    "layoutAssignment": {
      "property1": {},
      "property2": {}
    },
    "webReportID": 0
  },
  "inquiry": {
    "hasRun": true,
    "components": [
      {}
    ]
  },
  "bpmWorkflowPresenterFlexReportDTO": {
    "reportId": 0,
    "parameters": [
      {}
    ],
    "objectRestrictions": {
      "property1": {},
      "property2": {}
    }
  },
  "bpmWorkflowPlanDocPresenterFlexReportDTO": {
    "reportId": 0,
    "parameters": [
      {}
    ],
    "templateType": "Payee"
  },
  "assignedReports": [
    "string"
  ],
  "numReportsAssigned": 0,
  "permissions": {
    "advanceToken": [
      "Start"
    ],
    "viewDocuments": [
      "Start"
    ]
  },
  "parentFolder": {
    "folderID": 0,
    "folderName": "string",
    "rowVersion": {
      "rowVersion": 0
    },
    "workflowType": "PresenterReport"
  },
  "parameters": [
    {
      "paramName": "string",
      "value": "string",
      "paramType": "Text",
      "valueType": "Constant",
      "usesReportValue": true,
      "isRequired": true
    }
  ],
  "layoutAssignment": {
    "property1": {
      "first": true,
      "second": true
    },
    "property2": {
      "first": true,
      "second": true
    }
  },
  "webReportID": 0,
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.BPMWorkflowInformationDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

errors

integer(int32)

false

none

none

pendingActions

integer(int32)

false

none

none

history

integer(int32)

false

none

none

json
{
  "id": 0,
  "errors": 0,
  "pendingActions": 0,
  "history": 0
}

Varicent.RESTAPI.v1.DTOs.BPMWorkflowInquiryDTO

Properties

Name

Type

Required

Restrictions

Description

hasRun

boolean

false

none

none

components

[RESTAPI.v1.DTOs.BPM.BPMComponentDTO]¦nullRESTAPI.v1.DTOs.BPM.BPMComponentDTO

false

none

none

json
{
  "hasRun": true,
  "components": [
    {
      "workflowID": 0,
      "componentID": 0,
      "name": "string",
      "type": "pickList",
      "order": 0,
      "categories": [],
      "source": {},
      "config": {},
      "componentMappings": [],
      "rowVersion": {}
    }
  ]
}

Varicent.RESTAPI.v1.DTOs.BPMWorkflowParameterDTO

Properties

Name

Type

Required

Restrictions

Description

paramName

string¦null

false

none

none

value

string¦null

false

none

none

paramType

string

false

none

none

valueType

string

false

none

none

usesReportValue

boolean

false

none

none

isRequired

boolean

false

none

none

Enumerated Values

Property

Value

paramType

Text

paramType

Date

paramType

Numeric

valueType

Constant

valueType

Value

json
{
  "paramName": "string",
  "value": "string",
  "paramType": "Text",
  "valueType": "Constant",
  "usesReportValue": true,
  "isRequired": true
}

Varicent.RESTAPI.v1.DTOs.BPMWorkflowPlanDocPresenterFlexReportDTO

Properties

Name

Type

Required

Restrictions

Description

reportId

integer(int32)

false

none

none

parameters

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowParameterDTO]¦null

false

none

none

templateType

string

false

none

none

Enumerated Values

Property

Value

templateType

Payee

templateType

ManagerPayee

templateType

Custom

json
{
  "reportId": 0,
  "parameters": [
    {
      "paramName": "string",
      "value": "string",
      "paramType": "Text",
      "valueType": "Constant",
      "usesReportValue": true,
      "isRequired": true
    }
  ],
  "templateType": "Payee"
}

Varicent.RESTAPI.v1.DTOs.BPMWorkflowPresenterFlexReportDTO

Properties

Name

Type

Required

Restrictions

Description

reportId

integer(int32)

false

none

none

parameters

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowParameterDTO]¦null

false

none

none

objectRestrictions

object¦null

false

none

none

» additionalProperties

RESTAPI.v1.DTOs.BPM.BPMVisibilityEditabilityDTO

false

none

none

json
{
  "reportId": 0,
  "parameters": [
    {
      "paramName": "string",
      "value": "string",
      "paramType": "Text",
      "valueType": "Constant",
      "usesReportValue": true,
      "isRequired": true
    }
  ],
  "objectRestrictions": {
    "property1": {
      "visible": true,
      "editable": true
    },
    "property2": {
      "visible": true,
      "editable": true
    }
  }
}

Varicent.RESTAPI.v1.DTOs.BPMWorkflowWebReportDTO

Properties

Name

Type

Required

Restrictions

Description

parameters

[Varicent.RESTAPI.v1.DTOs.BPMWorkflowParameterDTO]¦null

false

none

none

layoutAssignment

object¦null

false

none

none

» additionalProperties

[RESTAPI.v1.DTOs.PairDTO2[System.Boolean,System.Boolean]](#schemarestapi.v1.dtos.pairdto2[system.boolean,system.boolean])

false

none

none

webReportID

integer(int32)

false

none

none

json
{
  "parameters": [
    {
      "paramName": "string",
      "value": "string",
      "paramType": "Text",
      "valueType": "Constant",
      "usesReportValue": true,
      "isRequired": true
    }
  ],
  "layoutAssignment": {
    "property1": {
      "first": true,
      "second": true
    },
    "property2": {
      "first": true,
      "second": true
    }
  },
  "webReportID": 0
}

Varicent.RESTAPI.v1.DTOs.BackgroundDisplayDTO

Properties

Name

Type

Required

Restrictions

Description

color

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

none

image

Varicent.RESTAPI.v1.DTOs.ImageDisplayDTO

false

none

none

imageAttachment

string

false

none

none

imagePosition

string

false

none

none

imageTile

string

false

none

none

webreportId

integer(int32)

false

none

none

x

integer(int32)

false

none

none

y

integer(int32)

false

none

none

opacity

integer(int32)

false

none

none

Enumerated Values

Property

Value

imageAttachment

Scroll

imageAttachment

Fixed

imagePosition

Absolute

imagePosition

Percent

imagePosition

LeftTop

imagePosition

LeftCenter

imagePosition

LeftBottom

imagePosition

RightTop

imagePosition

RightCenter

imagePosition

RightBottom

imagePosition

CenterTop

imagePosition

CenterCenter

imagePosition

CenterBottom

imageTile

None

imageTile

Vertical

imageTile

Horizontal

imageTile

Both

json
{
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "image": {
    "displayBorder": {
      "bottom": {},
      "left": {},
      "right": {},
      "top": {}
    },
    "displayPadding": {
      "bottom": 0.1,
      "left": 0.1,
      "right": 0.1,
      "top": 0.1
    },
    "gridType": "string",
    "hoverText": "string",
    "imageByteArray": "string",
    "imageId": 0,
    "imageLink": {
      "document": "string",
      "openInNewWindow": true,
      "parameters": {},
      "reportId": 0,
      "targetId": 0,
      "targetType": "WebReport",
      "webFormId": 0,
      "webTabId": 0
    },
    "imageType": "string",
    "imageUrl": "string",
    "expiryDate": "2019-08-24T14:15:22Z",
    "cosObjectName": "string",
    "name": "string",
    "source": {
      "name": "string"
    },
    "style": {
      "displayBorders": {},
      "displayPadding": {}
    }
  },
  "imageAttachment": "Scroll",
  "imagePosition": "Absolute",
  "imageTile": "None",
  "webreportId": 0,
  "x": 0,
  "y": 0,
  "opacity": 0
}

Varicent.RESTAPI.v1.DTOs.BackgroundImageDTO

Properties

Name

Type

Required

Restrictions

Description

isNew

boolean

false

none

none

image

string(byte)¦null

false

none

none

id

integer(int32)

false

none

none

cosObjectName

string¦null

false

none

none

expiryDate

string(date-time)¦null

false

none

none

imageUrl

string¦null

false

none

none

json
{
  "isNew": true,
  "image": "string",
  "id": 0,
  "cosObjectName": "string",
  "expiryDate": "2019-08-24T14:15:22Z",
  "imageUrl": "string"
}

Varicent.RESTAPI.v1.DTOs.BatchItemDTO

Properties

Name

Type

Required

Restrictions

Description

batchId

integer(int32)

false

none

none

status

string

false

none

none

start

string(date-time)

false

none

none

end

string(date-time)

false

none

none

duration

string(date-span)

false

none

none

computationEvents

[Varicent.RESTAPI.v1.DTOs.ComputationLogEventDTO]¦null

false

none

none

type

string

false

none

none

clientVersion

string¦null

false

none

none

databaseVersion

integer(int32)

false

none

none

incremental

string

false

none

none

calculationsCount

integer(int32)

false

none

none

Enumerated Values

Property

Value

status

Started

status

Success

status

Error

status

Cancelled

status

None

type

All

type

PlanIncludingReports

type

PlanEarnings

type

TailoredReports

type

Payee

type

WebForms

type

PresenterReports

type

Workspace

type

IndividualCalculation

type

SelectedCalculations

type

EltFull

type

EltIndividualCalculationWithDep

type

EltIndividualCalculationWithoutDep

type

None

incremental

No

incremental

Yes

json
{
  "batchId": 0,
  "status": "Started",
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z",
  "duration": "string",
  "computationEvents": [
    {
      "batchId": 0,
      "computationEventId": 0,
      "name": "string",
      "runningTime": 0,
      "finished": true,
      "calcId": 0,
      "calcMethod": "string",
      "status": "string",
      "syncRunningTime": 0,
      "skipped": true,
      "details": [],
      "start": "2019-08-24T14:15:22Z",
      "end": "2019-08-24T14:15:22Z",
      "duration": "string",
      "syncDuration": "string"
    }
  ],
  "type": "All",
  "clientVersion": "string",
  "databaseVersion": 0,
  "incremental": "No",
  "calculationsCount": 0
}

Varicent.RESTAPI.v1.DTOs.BlockDefinitionDTO

Properties

Name

Type

Required

Restrictions

Description

isRoot

boolean

false

none

none

isWaypoint

boolean

false

none

none

isInsertionPoint

boolean

false

none

none

hasDocuments

boolean

false

none

none

autoArrange

boolean

false

none

none

blockId

integer(int32)

false

none

none

name

string¦null

false

none

none

rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "isRoot": true,
  "isWaypoint": true,
  "isInsertionPoint": true,
  "hasDocuments": true,
  "autoArrange": true,
  "blockId": 0,
  "name": "string",
  "rowVersion": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.BlockDocumentDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

blockID

integer(int32)

false

none

none

name

string¦null

false

none

none

file

string¦null

false

none

none

json
{
  "id": 0,
  "blockID": 0,
  "name": "string",
  "file": "string"
}

Varicent.RESTAPI.v1.DTOs.BlockElementDTO

Properties

Name

Type

Required

Restrictions

Description

blockDefinition

Varicent.RESTAPI.v1.DTOs.BlockDefinitionDTO

false

none

none

elementId

integer(int32)

false

none

none

parentBlockId

integer(int32)¦null

false

none

none

bounds

System.Drawing.RectangleF

false

none

none

color

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

none

name

string¦null

false

none

none

parentBlock

Varicent.RESTAPI.v1.DTOs.Composer.ExpandableBlockElementDTO

false

none

none

isVisible

boolean

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "blockDefinition": {
    "isRoot": true,
    "isWaypoint": true,
    "isInsertionPoint": true,
    "hasDocuments": true,
    "autoArrange": true,
    "blockId": 0,
    "name": "string",
    "rowVersion": {
      "rowVersion": 0
    }
  },
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "isEmpty": true,
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1,
    "left": 0.1,
    "top": 0.1,
    "right": 0.1,
    "bottom": 0.1,
    "isEmpty": true
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.BorderDTO

Properties

Name

Type

Required

Restrictions

Description

color

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

none

width

number(float)

false

none

none

json
{
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "width": 0.1
}

Varicent.RESTAPI.v1.DTOs.BordersDTO

Properties

Name

Type

Required

Restrictions

Description

bottom

Varicent.RESTAPI.v1.DTOs.BorderDTO

false

none

none

left

Varicent.RESTAPI.v1.DTOs.BorderDTO

false

none

none

right

Varicent.RESTAPI.v1.DTOs.BorderDTO

false

none

none

top

Varicent.RESTAPI.v1.DTOs.BorderDTO

false

none

none

json
{
  "bottom": {
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "width": 0.1
  },
  "left": {
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "width": 0.1
  },
  "right": {
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "width": 0.1
  },
  "top": {
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "width": 0.1
  }
}

Varicent.RESTAPI.v1.DTOs.ButtonDisplayStyleDTO

Properties

Name

Type

Required

Restrictions

Description

style

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

none

displayBorders

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

none

displayPadding

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

none

json
{
  "style": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "displayBorders": {
    "bottom": {
      "color": {},
      "width": 0.1
    },
    "left": {
      "color": {},
      "width": 0.1
    },
    "right": {
      "color": {},
      "width": 0.1
    },
    "top": {
      "color": {},
      "width": 0.1
    }
  },
  "displayPadding": {
    "bottom": 0.1,
    "left": 0.1,
    "right": 0.1,
    "top": 0.1
  }
}

Varicent.RESTAPI.v1.DTOs.CalculatedColumnDTO

Properties

Name

Type

Required

Restrictions

Description

type

string¦null

false

none

none

id

integer(int32)¦null

false

none

none

order

integer(int32)¦null

false

none

none

columnName

string¦null

false

none

none

formula

string¦null

false

none

none

Enumerated Values

Property

Value

type

String

type

LongString

type

MaxString

type

Date

type

DateTime

type

Decimal

type

Int

type

Long

type

Float

type

BLOB

type

Identity

type

CLOB

type

RowVersion

type

UID

type

VarCharMax

type

Boolean

json
{
  "type": "String",
  "id": 0,
  "order": 0,
  "columnName": "string",
  "formula": "string"
}

Varicent.RESTAPI.v1.DTOs.CalculationDefinitionDTO

Properties

Name

Type

Required

Restrictions

Description

calculationId

integer(int32)

false

none

none

calculationType

string

false

none

none

planBuilderCalculationId

string¦null

false

none

none

Enumerated Values

Property

Value

calculationType

Mathematical

calculationType

Sorting

calculationType

TimeShift

calculationType

Category

calculationType

Symon

json
{
  "calculationId": 0,
  "calculationType": "Mathematical",
  "planBuilderCalculationId": "string"
}

Varicent.RESTAPI.v1.DTOs.Calculations.CalculationCategoryDTO

Properties

Name

Type

Required

Restrictions

Description

categoryId

integer(int32)

false

none

none

name

string¦null

false

none

none

clause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

json
{
  "categoryId": 0,
  "name": "string",
  "clause": {
    "constraintType": "clause",
    "op": "string",
    "dataFieldLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "caseSensitive": true,
    "constraints": [
      {}
    ],
    "literalRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "dataFieldRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "right": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "isPreciseDecimal": true,
    "like": "string",
    "escapeWildcards": true,
    "rowVersion": {
      "rowVersion": 0
    },
    "table": "string",
    "queryDefinitionRight": null
  }
}

Varicent.RESTAPI.v1.DTOs.Calculations.CalculationDTO

Properties

Name

Type

Required

Restrictions

Description

calculationId

integer(int32)

false

none

none

calculationType

string

false

none

none

name

string¦null

false

none

none

comment

string¦null

false

none

none

hasOutputGroups

boolean

false

none

none

source

string¦null

false

none

none

usesLeftJoin

boolean

false

none

none

calendar

string¦null

false

none

none

timePartitionPath

string¦null

false

none

none

timeLevel

string¦null

false

none

none

resetLevel

string¦null

false

none

none

timeStart

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

timeEnd

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

isCurrent

boolean

false

none

none

outputTable

string¦null

false

none

none

previewId

integer(int32)

false

none

none

previewTable

string¦null

false

none

none

rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

restrictions

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

mainSourceRestrictions

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

partitions

[Varicent.RESTAPI.v1.DTOs.Calculations.PartitionDefinitionDTO]¦null

false

none

none

lookups

[Varicent.RESTAPI.v1.DTOs.Calculations.LookupDTO]¦null

false

none

none

unions

[Varicent.RESTAPI.v1.DTOs.Calculations.UnionDefinitionDTO]¦null

false

none

none

traceColumns

[Varicent.RESTAPI.v1.DTOs.Calculations.TraceColumnDTO]¦null

false

none

none

executionPaths

[string]¦null

false

none

none

references

object¦null

false

none

none

» additionalProperties

Varicent.RESTAPI.v1.DTOs.DataItemDTO

false

none

none

timeReferences

object¦null

false

none

none

» additionalProperties

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

none

sourceColumns

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

none

sourceKeyColumns

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

none

outputColumns

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

none

calculationDataId

integer(int32)¦null

false

none

none

formulas

object¦null

false

none

none

» additionalProperties

string¦null

false

none

none

formulaOrder

object¦null

false

none

none

» additionalProperties

integer(int32)¦null

false

none

none

pipeConnection

Varicent.RESTAPI.v1.DTOs.Symon.PipeConnectionDTO

false

none

none

sortColumns

[Varicent.RESTAPI.v1.DTOs.DataItemDTO]¦null

false

none

none

limit

integer(int32)

false

none

none

sortDirection

string

false

none

none

rankType

string

false

none

none

timeColumn

string¦null

false

none

none

timeId

string¦null

false

none

none

levelId

string¦null

false

none

none

shift

integer(int32)

false

none

none

categories

[Varicent.RESTAPI.v1.DTOs.Calculations.CalculationCategoryDTO]¦null

false

none

none

timeLockStart

string(date-time)

false

none

none

timeLockEnd

string(date-time)

false

none

none

timeLockCalendar

string¦null

false

none

none

Enumerated Values

Property

Value

calculationType

Mathematical

calculationType

Sorting

calculationType

TimeShift

calculationType

Category

calculationType

Symon

sortDirection

Ascending

sortDirection

Descending

rankType

Standard

rankType

Sequential

rankType

Dense

json
{
  "calculationId": 0,
  "calculationType": "Mathematical",
  "name": "string",
  "comment": "string",
  "hasOutputGroups": true,
  "source": "string",
  "usesLeftJoin": true,
  "calendar": "string",
  "timePartitionPath": "string",
  "timeLevel": "string",
  "resetLevel": "string",
  "timeStart": {},
  "timeEnd": {},
  "isCurrent": true,
  "outputTable": "string",
  "previewId": 0,
  "previewTable": "string",
  "rowVersion": {
    "rowVersion": 0
  },
  "restrictions": {
    "constraintType": "clause",
    "op": "string",
    "dataFieldLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "caseSensitive": true,
    "constraints": [
      {}
    ],
    "literalRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "dataFieldRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "right": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "isPreciseDecimal": true,
    "like": "string",
    "escapeWildcards": true,
    "rowVersion": {
      "rowVersion": 0
    },
    "table": "string",
    "queryDefinitionRight": null
  },
  "mainSourceRestrictions": {
    "constraintType": "clause",
    "op": "string",
    "dataFieldLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "caseSensitive": true,
    "constraints": [
      {}
    ],
    "literalRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "dataFieldRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "right": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "isPreciseDecimal": true,
    "like": "string",
    "escapeWildcards": true,
    "rowVersion": {
      "rowVersion": 0
    },
    "table": "string",
    "queryDefinitionRight": null
  },
  "partitions": [
    {
      "source": "string",
      "outputGroup": "string",
      "isAccumulating": true,
      "userDefinedColumnName": "string"
    }
  ],
  "lookups": [
    {
      "name": "string",
      "source": "string",
      "restrictions": {}
    }
  ],
  "unions": [
    {
      "sourceAlias": "string",
      "sourceColumns": [],
      "unionTable": "string",
      "unionColumns": []
    }
  ],
  "traceColumns": [
    {
      "table": "string",
      "column": "string",
      "type": "String"
    }
  ],
  "executionPaths": [
    "LimitAll"
  ],
  "references": {
    "property1": {
      "path": {},
      "column": "string",
      "alias": "string"
    },
    "property2": {
      "path": {},
      "column": "string",
      "alias": "string"
    }
  },
  "timeReferences": {
    "property1": {
      "levelId": "string",
      "timeId": "string"
    },
    "property2": {
      "levelId": "string",
      "timeId": "string"
    }
  },
  "sourceColumns": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "sourceKeyColumns": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "outputColumns": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "calculationDataId": 0,
  "formulas": {
    "property1": "string",
    "property2": "string"
  },
  "formulaOrder": {
    "property1": 0,
    "property2": 0
  },
  "pipeConnection": {
    "pipeID": "string",
    "inputID": "string",
    "outputID": "string",
    "outputName": "string",
    "lastValidated": "2019-08-24T14:15:22Z",
    "inputMapping": [
      {}
    ],
    "outputMapping": [
      {}
    ]
  },
  "sortColumns": [
    {
      "path": {},
      "column": "string",
      "alias": "string"
    }
  ],
  "limit": 0,
  "sortDirection": "Ascending",
  "rankType": "Standard",
  "timeColumn": "string",
  "timeId": "string",
  "levelId": "string",
  "shift": 0,
  "categories": [
    {
      "categoryId": 0,
      "name": "string",
      "clause": {}
    }
  ],
  "timeLockStart": "2019-08-24T14:15:22Z",
  "timeLockEnd": "2019-08-24T14:15:22Z",
  "timeLockCalendar": "string"
}

Varicent.RESTAPI.v1.DTOs.Calculations.LookupDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

source

string¦null

false

none

none

restrictions

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

json
{
  "name": "string",
  "source": "string",
  "restrictions": {
    "constraintType": "clause",
    "op": "string",
    "dataFieldLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "caseSensitive": true,
    "constraints": [
      {}
    ],
    "literalRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "dataFieldRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "right": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "isPreciseDecimal": true,
    "like": "string",
    "escapeWildcards": true,
    "rowVersion": {
      "rowVersion": 0
    },
    "table": "string",
    "queryDefinitionRight": null
  }
}

Varicent.RESTAPI.v1.DTOs.Calculations.PartitionDefinitionDTO

Properties

Name

Type

Required

Restrictions

Description

source

string¦null

false

none

none

outputGroup

string¦null

false

none

none

isAccumulating

boolean

false

none

none

userDefinedColumnName

string¦null

false

none

none

json
{
  "source": "string",
  "outputGroup": "string",
  "isAccumulating": true,
  "userDefinedColumnName": "string"
}

Varicent.RESTAPI.v1.DTOs.Calculations.TraceColumnDTO

Properties

Name

Type

Required

Restrictions

Description

table

string¦null

false

none

none

column

string¦null

false

none

none

type

string

false

none

none

Enumerated Values

Property

Value

type

String

type

LongString

type

MaxString

type

Date

type

DateTime

type

Decimal

type

Int

type

Long

type

Float

type

BLOB

type

Identity

type

CLOB

type

RowVersion

type

UID

type

VarCharMax

type

Boolean

json
{
  "table": "string",
  "column": "string",
  "type": "String"
}

Varicent.RESTAPI.v1.DTOs.Calculations.UnionDefinitionDTO

Properties

Name

Type

Required

Restrictions

Description

sourceAlias

string¦null

false

none

none

sourceColumns

[string]¦null

false

none

none

unionTable

string¦null

false

none

none

unionColumns

[string]¦null

false

none

none

json
{
  "sourceAlias": "string",
  "sourceColumns": [
    "string"
  ],
  "unionTable": "string",
  "unionColumns": [
    "string"
  ]
}

Varicent.RESTAPI.v1.DTOs.CellSpanDTO

Properties

Name

Type

Required

Restrictions

Description

row

integer(int32)

false

none

none

columnStart

integer(int32)

false

none

none

columnEnd

integer(int32)

false

none

none

json
{
  "row": 0,
  "columnStart": 0,
  "columnEnd": 0
}

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

Properties

Name

Type

Required

Restrictions

Description

alignment

string

false

none

none

backColor

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

none

font

Varicent.RESTAPI.v1.DTOs.FontDefinitionDTOVaricent.RESTAPI.v1.DTOs.FontDefinitionDTO

false

none

none

foreColor

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

none

Enumerated Values

Property

Value

alignment

Justify

alignment

Left

alignment

Center

alignment

Right

json
{
  "alignment": "Justify",
  "backColor": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "font": {
    "family": "string",
    "size": 0.1,
    "unit": "string",
    "bold": true,
    "italic": true,
    "underline": true,
    "strikeout": true
  },
  "foreColor": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  }
}

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

Properties

Name

Type

Required

Restrictions

Description

a

integer(int32)

false

none

none

b

integer(int32)

false

none

none

g

integer(int32)

false

none

none

r

integer(int32)

false

none

none

json
{
  "a": 0,
  "b": 0,
  "g": 0,
  "r": 0
}

Varicent.RESTAPI.v1.DTOs.ColorValueRangeDTO

Properties

Name

Type

Required

Restrictions

Description

label

string¦null

false

none

none

min

number(double)

false

none

none

max

number(double)

false

none

none

color

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

none

json
{
  "label": "string",
  "min": 0.1,
  "max": 0.1,
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  }
}

Varicent.RESTAPI.v1.DTOs.ColumnActionDTO

Properties

Name

Type

Required

Restrictions

Description

action

string

false

none

none

customColumn

Varicent.RESTAPI.v1.DTOs.CustomColumnDTOVaricent.RESTAPI.v1.DTOs.CustomColumnDTO

false

none

none

Enumerated Values

Property

Value

action

Add

action

Remove

action

Edit

json
{
  "action": "Add",
  "customColumn": {
    "name": "string",
    "type": "Text",
    "referencedTable": "string",
    "referencedName": "string",
    "source": {
      "query": {},
      "sourceNames": {}
    },
    "pickListParams": [
      {}
    ],
    "isKey": true
  }
}

Varicent.RESTAPI.v1.DTOs.ColumnDefinitionDTO

Properties

Name

Type

Required

Restrictions

Description

column

Varicent.RESTAPI.v1.DTOs.CustomColumnDTO

false

none

none

isRemovable

boolean

false

none

none

isNullable

boolean

false

none

none

referencedColumn

string¦null

false

none

none

json
{
  "column": {
    "name": "string",
    "type": "Text",
    "referencedTable": "string",
    "referencedName": "string",
    "source": {
      "query": {},
      "sourceNames": {}
    },
    "pickListParams": [
      {}
    ],
    "isKey": true
  },
  "isRemovable": true,
  "isNullable": true,
  "referencedColumn": "string"
}

Varicent.RESTAPI.v1.DTOs.ColumnOptionsDTO

Properties

Name

Type

Required

Restrictions

Description

index

integer(int32)

false

none

none

width

integer(int32)

false

none

none

isRequired

boolean

false

none

none

json
{
  "index": 0,
  "width": 0,
  "isRequired": true
}

Varicent.RESTAPI.v1.DTOs.CompletedActivityDTO

Properties

Name

Type

Required

Restrictions

Description

progressId

integer(int32)

false

none

none

userId

string¦null

false

none

none

type

string

false

none

none

status

string

false

none

none

message

string¦null

false

none

none

time

string(date-time)

false

none

none

messageDetails

string¦null

false

none

none

apiServer

string¦null

false

none

none

Enumerated Values

Property

Value

type

Calculation

type

Import

type

Library

type

Migration

type

Task

type

Time

type

Optimization

type

Preview

type

BPMWorkflow

type

PurgePeriods

type

MakeEffective

type

Publication

type

Transformation

type

Scheduler

type

ScenarioPromote

type

NotifyUsers

type

HistoryPurge

type

PushAnalyticsData

type

ReapplyTemplate

type

UpdateHistoryTracking

type

ModifyCalendar

type

TableClear

type

IndexRebuild

type

PayeePublication

type

DeleteRows

type

GenerateTasks

type

QueryTool

type

BPMWorkflowAddMember

type

TableAlter

type

Sync

type

ModelEvaluation

type

CalcAndLock

type

Base64Conversion

type

AlterTableAdditionalData

type

BPMInquiryAutoAdjust

type

MaterializedView

type

PresenterReportThumbnail

type

PlanApprovalsPDF

type

CopyPaste

type

CutPaste

type

LGMConvert

type

CDWTableInitialization

type

CDWPopulateTable

type

DMSTransfer

type

PlanDocumentPDF

type

BPMWorkflowRemoveMember

type

ELTRun

type

Replication

status

Running

status

Completed

status

Failed

status

Cancelled

json
{
  "progressId": 0,
  "userId": "string",
  "type": "Calculation",
  "status": "Running",
  "message": "string",
  "time": "2019-08-24T14:15:22Z",
  "messageDetails": "string",
  "apiServer": "string"
}

Varicent.RESTAPI.v1.DTOs.Composer.CalculationCompactDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

id

integer(int32)

false

none

none

calcType

string

false

none

none

Enumerated Values

Property

Value

calcType

Mathematical

calcType

Sorting

calcType

TimeShift

calcType

Category

calcType

Symon

json
{
  "name": "string",
  "id": 0,
  "calcType": "Mathematical"
}

Varicent.RESTAPI.v1.DTOs.Composer.CalculationElementDTO

Properties

Name

Type

Required

Restrictions

Description

calculation

Varicent.RESTAPI.v1.DTOs.Calculations.CalculationDTO Varicent.RESTAPI.v1.DTOs.Calculations.CalculationDTO

false

none

none

elementId

integer(int32)

false

none

none

parentBlockId

integer(int32)¦null

false

none

none

bounds

System.Drawing.RectangleF

false

none

none

color

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

none

name

string¦null

false

none

none

parentBlock

Varicent.RESTAPI.v1.DTOs.Composer.ExpandableBlockElementDTO

false

none

none

isVisible

boolean

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "calculation": {
    "calculationId": 0,
    "calculationType": "Mathematical",
    "name": "string",
    "comment": "string",
    "hasOutputGroups": true,
    "source": "string",
    "usesLeftJoin": true,
    "calendar": "string",
    "timePartitionPath": "string",
    "timeLevel": "string",
    "resetLevel": "string",
    "timeStart": {},
    "timeEnd": {},
    "isCurrent": true,
    "outputTable": "string",
    "previewId": 0,
    "previewTable": "string",
    "rowVersion": {
      "rowVersion": 0
    },
    "restrictions": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "mainSourceRestrictions": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "partitions": [
      {}
    ],
    "lookups": [
      {}
    ],
    "unions": [
      {}
    ],
    "traceColumns": [
      {}
    ],
    "executionPaths": [
      "LimitAll"
    ],
    "references": {
      "property1": {},
      "property2": {}
    },
    "timeReferences": {
      "property1": {},
      "property2": {}
    },
    "sourceColumns": [
      {}
    ],
    "sourceKeyColumns": [
      {}
    ],
    "outputColumns": [
      {}
    ],
    "calculationDataId": 0,
    "formulas": {
      "property1": "string",
      "property2": "string"
    },
    "formulaOrder": {
      "property1": 0,
      "property2": 0
    },
    "pipeConnection": {
      "pipeID": "string",
      "inputID": "string",
      "outputID": "string",
      "outputName": "string",
      "lastValidated": "2019-08-24T14:15:22Z",
      "inputMapping": [],
      "outputMapping": []
    },
    "sortColumns": [
      {}
    ],
    "limit": 0,
    "sortDirection": "Ascending",
    "rankType": "Standard",
    "timeColumn": "string",
    "timeId": "string",
    "levelId": "string",
    "shift": 0,
    "categories": [
      {}
    ],
    "timeLockStart": "2019-08-24T14:15:22Z",
    "timeLockEnd": "2019-08-24T14:15:22Z",
    "timeLockCalendar": "string"
  },
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "isEmpty": true,
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1,
    "left": 0.1,
    "top": 0.1,
    "right": 0.1,
    "bottom": 0.1,
    "isEmpty": true
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.Composer.ComponentScopeDTO

Properties

Name

Type

Required

Restrictions

Description

elements

object¦null

false

none

none

» additionalProperties

Varicent.RESTAPI.v1.DTOs.Composer.TypedElements.TypedElementDTO

false

none

none

dependencies

object¦null

false

none

none

» additionalProperties

Varicent.RESTAPI.v1.DTOs.Graph.DirectedGraphNodeDTO

false

none

none

breadcrumb

Varicent.RESTAPI.v1.DTOs.Composer.ExpandedParentElementDTO

false

none

none

json
{
  "elements": {
    "property1": {
      "details": "string",
      "elements": "string",
      "type": "Block",
      "calculationType": "Mathematical",
      "comment": "string",
      "elementId": 0,
      "parentBlockId": 0,
      "bounds": {},
      "color": {},
      "name": "string",
      "parentBlock": {},
      "isVisible": true,
      "version": {}
    },
    "property2": {
      "details": "string",
      "elements": "string",
      "type": "Block",
      "calculationType": "Mathematical",
      "comment": "string",
      "elementId": 0,
      "parentBlockId": 0,
      "bounds": {},
      "color": {},
      "name": "string",
      "parentBlock": {},
      "isVisible": true,
      "version": {}
    }
  },
  "dependencies": {
    "property1": {
      "id": 0,
      "value": null,
      "children": {}
    },
    "property2": {
      "id": 0,
      "value": null,
      "children": {}
    }
  },
  "breadcrumb": {
    "parent": null,
    "elementId": 0,
    "parentBlockId": 0,
    "bounds": {
      "location": {},
      "size": "string",
      "x": 0.1,
      "y": 0.1,
      "width": 0.1,
      "height": 0.1,
      "left": 0.1,
      "top": 0.1,
      "right": 0.1,
      "bottom": 0.1,
      "isEmpty": true
    },
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "name": "string",
    "parentBlock": {
      "id": 0,
      "name": "string",
      "href": "string"
    },
    "isVisible": true,
    "version": {
      "rowVersion": 0
    }
  }
}

Varicent.RESTAPI.v1.DTOs.Composer.ComposerWebFormElementDTO

Properties

Name

Type

Required

Restrictions

Description

webForm

Varicent.RESTAPI.v1.DTOs.WebFormDefinitionDTO

false

none

none

elementId

integer(int32)

false

none

none

parentBlockId

integer(int32)¦null

false

none

none

bounds

System.Drawing.RectangleF

false

none

none

color

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

none

name

string¦null

false

none

none

parentBlock

Varicent.RESTAPI.v1.DTOs.Composer.ExpandableBlockElementDTO

false

none

none

isVisible

boolean

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "webForm": {
    "id": 0,
    "elementId": 0,
    "name": "string",
    "javaScript": "string",
    "protected": true,
    "filterFirst": true,
    "numRows": 0,
    "numColumns": 0,
    "exportFilter": 0,
    "elements": [
      {}
    ],
    "spans": [
      {}
    ],
    "workflowObjectId": 0,
    "element": {},
    "version": {
      "rowVersion": 0
    }
  },
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "isEmpty": true,
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1,
    "left": 0.1,
    "top": 0.1,
    "right": 0.1,
    "bottom": 0.1,
    "isEmpty": true
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.Composer.CreatedViewElementDTO

Properties

Name

Type

Required

Restrictions

Description

source

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

elementId

integer(int32)

false

none

none

parentBlockId

integer(int32)¦null

false

none

none

bounds

System.Drawing.RectangleF

false

none

none

color

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

none

name

string¦null

false

none

none

parentBlock

Varicent.RESTAPI.v1.DTOs.Composer.ExpandableBlockElementDTO

false

none

none

isVisible

boolean

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "source": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "isEmpty": true,
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1,
    "left": 0.1,
    "top": 0.1,
    "right": 0.1,
    "bottom": 0.1,
    "isEmpty": true
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.Composer.CustomColorDTO

Properties

Name

Type

Required

Restrictions

Description

colors

[string]¦null

false

none

none

json
{
  "colors": [
    "string"
  ]
}

Varicent.RESTAPI.v1.DTOs.Composer.CustomTableCompactDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

tableType

string

false

none

none

Enumerated Values

Property

Value

tableType

System

tableType

Dimension

tableType

Structural

tableType

Lookup

tableType

Data

tableType

View

tableType

Custom

tableType

StarSchema

tableType

ExportTable

tableType

CreditingRule

tableType

AssignTable

tableType

PlcmCustomTable

tableType

PlcmStructuralTable

tableType

PlcmTable

tableType

DataSource

tableType

Cached

tableType

MaterializedView

json
{
  "name": "string",
  "tableType": "System"
}

Varicent.RESTAPI.v1.DTOs.Composer.CustomTableElementDTO

Properties

Name

Type

Required

Restrictions

Description

table

Varicent.RESTAPI.v1.DTOs.CustomTableDTO

false

none

none

isWebEnabled

boolean

false

none

none

isHistoryEnabled

boolean

false

none

none

comment

string¦null

false

none

none

isGlobal

boolean

false

none

none

isWebDataViewable

boolean

false

none

none

elementId

integer(int32)

false

none

none

parentBlockId

integer(int32)¦null

false

none

none

bounds

System.Drawing.RectangleF

false

none

none

color

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

none

name

string¦null

false

none

none

parentBlock

Varicent.RESTAPI.v1.DTOs.Composer.ExpandableBlockElementDTO

false

none

none

isVisible

boolean

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "table": {
    "version": {
      "rowVersion": 0
    },
    "name": "string",
    "tableType": "System",
    "effectiveDated": true,
    "workflowObjectID": 0,
    "hierarchyMetadata": {
      "tableName": "string",
      "idColumnName": "string",
      "parentColumnName": "string"
    },
    "lastUpdatedTracking": true
  },
  "isWebEnabled": true,
  "isHistoryEnabled": true,
  "comment": "string",
  "isGlobal": true,
  "isWebDataViewable": true,
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "isEmpty": true,
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1,
    "left": 0.1,
    "top": 0.1,
    "right": 0.1,
    "bottom": 0.1,
    "isEmpty": true
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.Composer.DataSourceSchemaDTO

Properties

Name

Type

Required

Restrictions

Description

displayName

string¦null

false

none

none

details

Varicent.RESTAPI.v1.DTOs.ExpandableResourceDTO

false

none

none

type

string

false

none

none

fullTableSchema

Varicent.RESTAPI.v1.DTOs.FullTableSchemaDTO

false

none

none

tableDefinition

Varicent.RESTAPI.v1.DTOs.TableDefinitionDTO

false

none

none

calculationDefinition

Varicent.RESTAPI.v1.DTOs.CalculationDefinitionDTO

false

none

none

Enumerated Values

Property

Value

type

Table

type

Calculation

type

DataStore

type

Port

type

Symon

type

PlanBuilderCalculation

json
{
  "displayName": "string",
  "details": {
    "href": "string"
  },
  "type": "Table",
  "fullTableSchema": {
    "columns": [
      {}
    ],
    "table": "string",
    "name": "string",
    "referencedSources": [
      "string"
    ],
    "referencedTimes": [
      {}
    ],
    "referencedSourcesDictionary": {
      "property1": "string",
      "property2": "string"
    },
    "referencedTimesDictionary": {
      "property1": {},
      "property2": {}
    }
  },
  "tableDefinition": {
    "table": {
      "version": {},
      "name": "string",
      "tableType": "System",
      "effectiveDated": true,
      "workflowObjectID": 0,
      "hierarchyMetadata": {},
      "lastUpdatedTracking": true
    },
    "columns": [
      {}
    ],
    "time": {
      "timeId": "string",
      "dateColumn": "string",
      "lockedOn": {},
      "min": {},
      "max": {}
    }
  },
  "calculationDefinition": {
    "calculationId": 0,
    "calculationType": "Mathematical",
    "planBuilderCalculationId": "string"
  }
}

Varicent.RESTAPI.v1.DTOs.Composer.DataStoreElementDTO

Properties

Name

Type

Required

Restrictions

Description

dataStore

Varicent.RESTAPI.v1.DTOs.DataStoreDTO

false

none

none

isWebDataViewable

boolean

false

none

none

elementId

integer(int32)

false

none

none

parentBlockId

integer(int32)¦null

false

none

none

bounds

System.Drawing.RectangleF

false

none

none

color

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

none

name

string¦null

false

none

none

parentBlock

Varicent.RESTAPI.v1.DTOs.Composer.ExpandableBlockElementDTO

false

none

none

isVisible

boolean

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "dataStore": {
    "id": 0,
    "name": "string",
    "workflowObjectID": 0,
    "source": {
      "name": "string",
      "sourceDefinition": {},
      "dependencies": [],
      "columns": [],
      "references": {},
      "timeReferences": {}
    },
    "version": {
      "rowVersion": 0
    }
  },
  "isWebDataViewable": true,
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "isEmpty": true,
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1,
    "left": 0.1,
    "top": 0.1,
    "right": 0.1,
    "bottom": 0.1,
    "isEmpty": true
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.Composer.ElementDTO

Properties

Name

Type

Required

Restrictions

Description

elementId

integer(int32)

false

none

none

parentBlockId

integer(int32)¦null

false

none

none

bounds

System.Drawing.RectangleF

false

none

none

color

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

none

name

string¦null

false

none

none

parentBlock

Varicent.RESTAPI.v1.DTOs.Composer.ExpandableBlockElementDTO

false

none

none

isVisible

boolean

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "isEmpty": true,
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1,
    "left": 0.1,
    "top": 0.1,
    "right": 0.1,
    "bottom": 0.1,
    "isEmpty": true
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.Composer.ElementIDsDTO

Properties

Name

Type

Required

Restrictions

Description

elementIDs

[integer]¦null

false

none

none

json
{
  "elementIDs": [
    0
  ]
}

Varicent.RESTAPI.v1.DTOs.Composer.ExpandableBlockElementDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

name

string¦null

false

none

none

href

string¦null

false

none

none

json
{
  "id": 0,
  "name": "string",
  "href": "string"
}

Varicent.RESTAPI.v1.DTOs.Composer.ExpandedParentElementDTO

Properties

Name

Type

Required

Restrictions

Description

parent

Varicent.RESTAPI.v1.DTOs.Composer.ExpandedParentElementDTO

false

none

none

elementId

integer(int32)

false

none

none

parentBlockId

integer(int32)¦null

false

none

none

bounds

System.Drawing.RectangleF

false

none

none

color

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

none

name

string¦null

false

none

none

parentBlock

Varicent.RESTAPI.v1.DTOs.Composer.ExpandableBlockElementDTO

false

none

none

isVisible

boolean

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "parent": null,
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "isEmpty": true,
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1,
    "left": 0.1,
    "top": 0.1,
    "right": 0.1,
    "bottom": 0.1,
    "isEmpty": true
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.Composer.Ports.PortColumnPatchDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

sourceColumn

string¦null

false

none

none

json
{
  "name": "string",
  "sourceColumn": "string"
}

Varicent.RESTAPI.v1.DTOs.Composer.Ports.PortDefinitionPatchDTO

Properties

Name

Type

Required

Restrictions

Description

source

string¦null

false

none

none

columns

[Varicent.RESTAPI.v1.DTOs.Composer.Ports.PortColumnPatchDTO]¦null

false

none

none

portDefinitionVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "source": "string",
  "columns": [
    {
      "name": "string",
      "sourceColumn": "string"
    }
  ],
  "portDefinitionVersion": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.Composer.Ports.PortElementDTO

Properties

Name

Type

Required

Restrictions

Description

portDefinition

Varicent.RESTAPI.v1.DTOs.PortDefinitionDTO

false

none

none

connection

Varicent.RESTAPI.v1.DTOs.IExpandableResourceDTO

false

none

none

elementId

integer(int32)

false

none

none

parentBlockId

integer(int32)¦null

false

none

none

bounds

System.Drawing.RectangleF

false

none

none

color

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

none

name

string¦null

false

none

none

parentBlock

Varicent.RESTAPI.v1.DTOs.Composer.ExpandableBlockElementDTO

false

none

none

isVisible

boolean

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "portDefinition": {
    "portId": 0,
    "name": "string",
    "portType": "Input",
    "sourceTable": "string",
    "referencedTable": "string",
    "columns": [
      {}
    ],
    "references": {
      "property1": "string",
      "property2": "string"
    },
    "timeReferences": {
      "property1": {},
      "property2": {}
    },
    "isWaypoint": true,
    "migrationDisplayName": "string",
    "version": {
      "rowVersion": 0
    }
  },
  "connection": {},
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "isEmpty": true,
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1,
    "left": 0.1,
    "top": 0.1,
    "right": 0.1,
    "bottom": 0.1,
    "isEmpty": true
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.Composer.SelectedCalculationsDTO

Properties

Name

Type

Required

Restrictions

Description

calculationIds

[integer]¦null

false

none

none

componentIds

[integer]¦null

false

none

none

computeDependencies

boolean

false

none

none

json
{
  "calculationIds": [
    0
  ],
  "componentIds": [
    0
  ],
  "computeDependencies": true
}

Varicent.RESTAPI.v1.DTOs.Composer.TableElementDTO

Properties

Name

Type

Required

Restrictions

Description

table

Varicent.RESTAPI.v1.DTOs.TableDefinitionDTO

false

none

none

tableAdditionalData

Varicent.RESTAPI.v1.DTOs.IExpandableResourceDTO

false

none

none

comment

string¦null

false

none

none

elementId

integer(int32)

false

none

none

parentBlockId

integer(int32)¦null

false

none

none

bounds

System.Drawing.RectangleF

false

none

none

color

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

none

name

string¦null

false

none

none

parentBlock

Varicent.RESTAPI.v1.DTOs.Composer.ExpandableBlockElementDTO

false

none

none

isVisible

boolean

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "table": {
    "table": {
      "version": {},
      "name": "string",
      "tableType": "System",
      "effectiveDated": true,
      "workflowObjectID": 0,
      "hierarchyMetadata": {},
      "lastUpdatedTracking": true
    },
    "columns": [
      {}
    ],
    "time": {
      "timeId": "string",
      "dateColumn": "string",
      "lockedOn": {},
      "min": {},
      "max": {}
    }
  },
  "tableAdditionalData": {},
  "comment": "string",
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "isEmpty": true,
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1,
    "left": 0.1,
    "top": 0.1,
    "right": 0.1,
    "bottom": 0.1,
    "isEmpty": true
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.Composer.TypedElements.TypedElementDTO

Properties

Name

Type

Required

Restrictions

Description

details

string¦null

false

none

none

elements

string¦null

false

none

none

type

string

false

none

none

calculationType

string

false

none

none

comment

string¦null

false

none

none

elementId

integer(int32)

false

none

none

parentBlockId

integer(int32)¦null

false

none

none

bounds

System.Drawing.RectangleF

false

none

none

color

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

none

name

string¦null

false

none

none

parentBlock

Varicent.RESTAPI.v1.DTOs.Composer.ExpandableBlockElementDTO

false

none

none

isVisible

boolean

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

type

Block

type

Table

type

Calculation

type

Plan

type

TailoredReport

type

WebForm

type

WebReport

type

InputPort

type

OutputPort

type

Library

type

DataStore

type

AssignTable

type

Hub

type

Waypoint

type

InsertionPoint

calculationType

Mathematical

calculationType

Sorting

calculationType

TimeShift

calculationType

Category

calculationType

Symon

json
{
  "details": "string",
  "elements": "string",
  "type": "Block",
  "calculationType": "Mathematical",
  "comment": "string",
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "isEmpty": true,
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1,
    "left": 0.1,
    "top": 0.1,
    "right": 0.1,
    "bottom": 0.1,
    "isEmpty": true
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.ComputationChartDTO

Properties

Name

Type

Required

Restrictions

Description

status

integer(int32)

false

none

none

durationInMs

integer(int32)

false

none

none

computationChartTasks

[Varicent.RESTAPI.v1.DTOs.ComputationChartTaskDTO]¦null

false

none

none

json
{
  "status": 0,
  "durationInMs": 0,
  "computationChartTasks": [
    {
      "name": "string",
      "calcId": 0,
      "durationMilliseconds": 0,
      "startDate": 0,
      "endDate": 0,
      "taskName": "string",
      "status": 0,
      "taskStatus": 0,
      "elementId": 0,
      "parentBlockId": 0,
      "tableName": "string"
    }
  ]
}

Varicent.RESTAPI.v1.DTOs.ComputationChartTaskDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

calcId

integer(int32)

false

none

none

durationMilliseconds

integer(int32)

false

none

none

startDate

integer(int64)

false

none

none

endDate

integer(int64)

false

none

none

taskName

string¦null

false

none

none

status

integer(int32)

false

none

none

taskStatus

integer(int32)

false

none

none

elementId

integer(int32)¦null

false

none

none

parentBlockId

integer(int32)¦null

false

none

none

tableName

string¦null

false

none

none

json
{
  "name": "string",
  "calcId": 0,
  "durationMilliseconds": 0,
  "startDate": 0,
  "endDate": 0,
  "taskName": "string",
  "status": 0,
  "taskStatus": 0,
  "elementId": 0,
  "parentBlockId": 0,
  "tableName": "string"
}

Varicent.RESTAPI.v1.DTOs.ComputationLogEventDTO

Properties

Name

Type

Required

Restrictions

Description

batchId

integer(int32)

false

none

none

computationEventId

integer(int32)

false

none

none

name

string¦null

false

none

none

runningTime

integer(int32)

false

none

none

finished

boolean

false

none

none

calcId

integer(int32)

false

none

none

calcMethod

string¦null

false

none

none

status

string¦null

false

none

none

syncRunningTime

integer(int32)

false

none

none

skipped

boolean

false

none

none

details

[Varicent.RESTAPI.v1.DTOs.ComputationLogEventDetailDTO]¦null

false

none

none

start

string(date-time)¦null

false

read-only

none

end

string(date-time)¦null

false

read-only

none

duration

string(date-span)

false

read-only

none

syncDuration

string(date-span)

false

read-only

none

json
{
  "batchId": 0,
  "computationEventId": 0,
  "name": "string",
  "runningTime": 0,
  "finished": true,
  "calcId": 0,
  "calcMethod": "string",
  "status": "string",
  "syncRunningTime": 0,
  "skipped": true,
  "details": [
    {
      "computationEventId": 0,
      "value": 0,
      "start": "2019-08-24T14:15:22Z",
      "end": "2019-08-24T14:15:22Z",
      "processId": 0,
      "taskType": 0,
      "period": "string"
    }
  ],
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z",
  "duration": "string",
  "syncDuration": "string"
}

Varicent.RESTAPI.v1.DTOs.ComputationLogEventDetailDTO

Properties

Name

Type

Required

Restrictions

Description

computationEventId

integer(int32)

false

none

none

value

integer(int32)

false

none

none

start

string(date-time)

false

none

none

end

string(date-time)

false

none

none

processId

integer(int32)

false

none

none

taskType

integer(int32)

false

none

none

period

string¦null

false

none

none

json
{
  "computationEventId": 0,
  "value": 0,
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z",
  "processId": 0,
  "taskType": 0,
  "period": "string"
}

Varicent.RESTAPI.v1.DTOs.ComputationLogItemDTO

Properties

Name

Type

Required

Restrictions

Description

computationId

integer(int32)

false

none

none

clientVersion

string¦null

false

none

none

databaseVersion

integer(int32)

false

none

none

start

string(date-time)

false

none

none

duration

string(date-span)

false

none

none

incremental

integer(int32)

false

none

none

type

integer(int32)

false

none

none

status

integer(int32)

false

none

none

calcsCount

integer(int32)

false

none

none

events

[Varicent.RESTAPI.v1.DTOs.ComputationLogEventDTO]¦null

false

none

none

json
{
  "computationId": 0,
  "clientVersion": "string",
  "databaseVersion": 0,
  "start": "2019-08-24T14:15:22Z",
  "duration": "string",
  "incremental": 0,
  "type": 0,
  "status": 0,
  "calcsCount": 0,
  "events": [
    {
      "batchId": 0,
      "computationEventId": 0,
      "name": "string",
      "runningTime": 0,
      "finished": true,
      "calcId": 0,
      "calcMethod": "string",
      "status": "string",
      "syncRunningTime": 0,
      "skipped": true,
      "details": [],
      "start": "2019-08-24T14:15:22Z",
      "end": "2019-08-24T14:15:22Z",
      "duration": "string",
      "syncDuration": "string"
    }
  ]
}

Varicent.RESTAPI.v1.DTOs.ConditionalFormatDTO

Properties

Name

Type

Required

Restrictions

Description

formula

string¦null

false

none

none

numericFormat

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

none

style

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

none

json
{
  "formula": "string",
  "numericFormat": {
    "scale": 0,
    "style": "Number"
  },
  "style": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  }
}

Varicent.RESTAPI.v1.DTOs.ConditionalFormatRuleDTO

Properties

Name

Type

Required

Restrictions

Description

formats

[Varicent.RESTAPI.v1.DTOs.ConditionalFormatDTO]¦null

false

none

none

json
{
  "formats": [
    {
      "formula": "string",
      "numericFormat": {},
      "style": {}
    }
  ]
}

Varicent.RESTAPI.v1.DTOs.ControlDisplayStyleDTO

Properties

Name

Type

Required

Restrictions

Description

style

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

none

displayBorders

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

none

displayPadding

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

none

json
{
  "style": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "displayBorders": {
    "bottom": {
      "color": {},
      "width": 0.1
    },
    "left": {
      "color": {},
      "width": 0.1
    },
    "right": {
      "color": {},
      "width": 0.1
    },
    "top": {
      "color": {},
      "width": 0.1
    }
  },
  "displayPadding": {
    "bottom": 0.1,
    "left": 0.1,
    "right": 0.1,
    "top": 0.1
  }
}

Properties

Name

Type

Required

Restrictions

Description

itemsToAdd

[string]¦null

false

none

none

itemsToRemove

[string]¦null

false

none

none

json
{
  "itemsToAdd": [
    "string"
  ],
  "itemsToRemove": [
    "string"
  ]
}

Varicent.RESTAPI.v1.DTOs.CreateBPMFolderDTO

Properties

Name

Type

Required

Restrictions

Description

folder

RESTAPI.v1.DTOs.TreeNodeDTO

false

none

none

order

integer(int32)

false

none

none

parentFolderRowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

workflowType

string¦null

false

none

none

Enumerated Values

Property

Value

workflowType

PresenterReport

workflowType

Inquiry

workflowType

PlanApproval

workflowType

PresenterFlexReport

workflowType

PlanDocument

json
{
  "folder": {
    "node": null,
    "children": []
  },
  "order": 0,
  "parentFolderRowVersion": {
    "rowVersion": 0
  },
  "workflowType": "PresenterReport"
}

Varicent.RESTAPI.v1.DTOs.CreateBPMWorkflowDTO

Properties

Name

Type

Required

Restrictions

Description

workflow

Varicent.RESTAPI.v1.DTOs.BPMWorkflowDTO

false

none

none

swimLane

Varicent.RESTAPI.v1.DTOs.SwimLaneDTO

false

none

none

swimLaneMemberSetModification

[Varicent.RESTAPI.v1.DTOs.Core.CollectionModificationDTO1[System.String]](#schemavaricent.restapi.v1.dtos.core.collectionmodificationdto1[system.string])

false

none

none

parentFolderId

integer(int32)

false

none

none

order

integer(int32)

false

none

none

parentFolderRowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

webReportRowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

presenterflexReportRowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "workflow": {
    "id": 0,
    "name": "string",
    "description": "string",
    "isSingleInstance": true,
    "workflowState": "Stopped",
    "conditionalVars": [
      {}
    ],
    "columnCount": 0,
    "workflowConfig": {
      "pendingWorkflowEnabled": true
    },
    "runCount": 0,
    "runDate": "string",
    "runBy": "string",
    "lastActioned": "string",
    "workflowType": "PresenterReport",
    "webReport": {
      "parameters": [],
      "layoutAssignment": {},
      "webReportID": 0
    },
    "inquiry": {
      "hasRun": true,
      "components": []
    },
    "bpmWorkflowPresenterFlexReportDTO": {
      "reportId": 0,
      "parameters": [],
      "objectRestrictions": {}
    },
    "bpmWorkflowPlanDocPresenterFlexReportDTO": {
      "reportId": 0,
      "parameters": [],
      "templateType": "Payee"
    },
    "assignedReports": [
      "string"
    ],
    "numReportsAssigned": 0,
    "permissions": {
      "advanceToken": [],
      "viewDocuments": []
    },
    "parentFolder": {
      "folderID": 0,
      "folderName": "string",
      "rowVersion": {},
      "workflowType": "PresenterReport"
    },
    "parameters": [
      {}
    ],
    "layoutAssignment": {
      "property1": {},
      "property2": {}
    },
    "webReportID": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "swimLane": {
    "id": 0,
    "order": 0,
    "name": "string",
    "description": "string",
    "workflowID": 0,
    "isSystemLane": true,
    "isByRestriction": true,
    "isAdmin": true,
    "memberDefinition": {
      "query": {},
      "sourceNames": {}
    },
    "payeeIDs": [
      "string"
    ],
    "queryDelta": {
      "modification": {},
      "query": {},
      "selectAllRows": true
    },
    "adminIDs": [
      "string"
    ],
    "version": {
      "rowVersion": 0
    }
  },
  "swimLaneMemberSetModification": {
    "itemsToAdd": [
      "string"
    ],
    "itemsToRemove": [
      "string"
    ]
  },
  "parentFolderId": 0,
  "order": 0,
  "parentFolderRowVersion": {
    "rowVersion": 0
  },
  "webReportRowVersion": {
    "rowVersion": 0
  },
  "presenterflexReportRowVersion": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.CustomColumnDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

type

string

false

none

none

referencedTable

string¦null

false

none

none

referencedName

string¦null

false

none

none

source

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

pickListParams

[Varicent.RESTAPI.v1.DTOs.PickListParamDTO]¦nullVaricent.RESTAPI.v1.DTOs.PickListParamDTO

false

none

none

isKey

boolean

false

none

none

Enumerated Values

Property

Value

type

Text

type

Date

type

List

type

Numeric

type

Email

type

Url

type

Comment

type

DateTime

json
{
  "name": "string",
  "type": "Text",
  "referencedTable": "string",
  "referencedName": "string",
  "source": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "pickListParams": [
    {
      "joinAlias": "string",
      "joinColumn": "string",
      "op": "LessThan"
    }
  ],
  "isKey": true
}

Varicent.RESTAPI.v1.DTOs.CustomTableDTO

Properties

Name

Type

Required

Restrictions

Description

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

name

string¦null

false

none

none

tableType

string

false

none

none

effectiveDated

boolean

false

none

none

workflowObjectID

integer(int32)

false

none

none

hierarchyMetadata

RESTAPI.v1.DTOs.Hierarchy.HierarchyMetadataDTO

false

none

none

lastUpdatedTracking

boolean¦null

false

none

none

Enumerated Values

Property

Value

tableType

System

tableType

Dimension

tableType

Structural

tableType

Lookup

tableType

Data

tableType

View

tableType

Custom

tableType

StarSchema

tableType

ExportTable

tableType

CreditingRule

tableType

AssignTable

tableType

PlcmCustomTable

tableType

PlcmStructuralTable

tableType

PlcmTable

tableType

DataSource

tableType

Cached

tableType

MaterializedView

json
{
  "version": {
    "rowVersion": 0
  },
  "name": "string",
  "tableType": "System",
  "effectiveDated": true,
  "workflowObjectID": 0,
  "hierarchyMetadata": {
    "tableName": "string",
    "idColumnName": "string",
    "parentColumnName": "string"
  },
  "lastUpdatedTracking": true
}

Varicent.RESTAPI.v1.DTOs.CustomTablePatchDTO

Properties

Name

Type

Required

Restrictions

Description

description

string¦null

false

none

none

table

Varicent.RESTAPI.v1.DTOs.CustomTableDTO

false

none

none

columnChanges

[Varicent.RESTAPI.v1.DTOs.ColumnActionDTO]¦null

false

none

none

time

Varicent.RESTAPI.v1.DTOs.TableTimeDTO

false

none

none

json
{
  "description": "string",
  "table": {
    "version": {
      "rowVersion": 0
    },
    "name": "string",
    "tableType": "System",
    "effectiveDated": true,
    "workflowObjectID": 0,
    "hierarchyMetadata": {
      "tableName": "string",
      "idColumnName": "string",
      "parentColumnName": "string"
    },
    "lastUpdatedTracking": true
  },
  "columnChanges": [
    {
      "action": "Add",
      "customColumn": {}
    }
  ],
  "time": {
    "timeId": "string",
    "dateColumn": "string",
    "lockedOn": {},
    "min": {},
    "max": {}
  }
}

Varicent.RESTAPI.v1.DTOs.DBObjectsRenameLogDetailsDTO

Properties

Name

Type

Required

Restrictions

Description

logID

integer(int32)

false

none

none

actionType

string¦null

false

none

none

actionStatus

string¦null

false

none

none

updateCount

integer(int32)

false

none

none

itemToUpdate

string¦null

false

none

none

oldValue

string¦null

false

none

none

newValue

string¦null

false

none

none

errorMessage

string¦null

false

none

none

json
{
  "logID": 0,
  "actionType": "string",
  "actionStatus": "string",
  "updateCount": 0,
  "itemToUpdate": "string",
  "oldValue": "string",
  "newValue": "string",
  "errorMessage": "string"
}

Varicent.RESTAPI.v1.DTOs.DBObjectsRenameLogsDTO

Properties

Name

Type

Required

Restrictions

Description

logID

integer(int32)

false

none

none

actionTime

string(date-time)

false

none

none

inputValue

string¦null

false

none

none

json
{
  "logID": 0,
  "actionTime": "2019-08-24T14:15:22Z",
  "inputValue": "string"
}

Varicent.RESTAPI.v1.DTOs.DataDisplayDTO

Properties

Name

Type

Required

Restrictions

Description

gridType

string¦null

false

none

none

name

string¦null

false

none

none

source

Varicent.RESTAPI.v1.DTOs.DisplaySourceDTO

false

none

none

type

string

false

none

none

restrictSource

Varicent.RESTAPI.v1.DTOs.DisplaySourceDTO

false

none

none

restrictColumn

string¦null

false

none

none

style

Varicent.RESTAPI.v1.DTOs.DataDisplayStyleDTO

false

none

none

columnMap

object¦null

false

none

none

» additionalProperties

Varicent.RESTAPI.v1.DTOs.DataGridSourceColumnDTO

false

none

none

computedColumns

[Varicent.RESTAPI.v1.DTOs.DataGridComputedColumnDTO]¦null

false

none

none

computedRow

object¦null

false

none

none

» additionalProperties

Varicent.RESTAPI.v1.DTOs.DataGridComputedRowCellDTO

false

none

none

dataGridDisplayStyle

Varicent.RESTAPI.v1.DTOs.DataGridDisplayStyleDTO

false

none

none

dataGridInputRules

[Varicent.RESTAPI.v1.DTOs.DataGridInputRuleDTO]¦null

false

none

none

dateFormat

Varicent.RESTAPI.v1.DTOs.PRDateFormatDTO

false

none

none

defaultPageSize

integer(int32)¦null

false

none

none

enableExportToExcel

boolean¦null

false

none

none

enableInquiryCopy

boolean¦null

false

none

none

enableShowHideColumns

boolean¦null

false

none

none

freezeTopRow

boolean¦null

false

none

none

hiddenColumnAliasMap

object¦null

false

none

none

» additionalProperties

string¦null

false

none

none

hiddenColumns

[Varicent.RESTAPI.v1.DTOs.DataGridHiddenColumnDTO]¦null

false

none

none

hiddenInputRowColumnMap

object¦null

false

none

none

» additionalProperties

Varicent.RESTAPI.v1.DTOs.DataGridSourceColumnDTO

false

none

none

inputRowAtTop

boolean¦null

false

none

none

isVertical

boolean¦null

false

none

none

numericStyle

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

none

paginated

boolean¦null

false

none

none

sections

[Varicent.RESTAPI.v1.DTOs.SectionDisplayDTO]¦null

false

none

none

showOnlyInputRow

boolean¦null

false

none

none

showSectionHeader

boolean¦null

false

none

none

sortColumns

[Varicent.RESTAPI.v1.DTOs.DataGridSortColumnDTO]¦null

false

none

none

suppressHeader

boolean¦null

false

none

none

hideRowBorders

boolean¦null

false

none

none

disableRowHighlighting

boolean¦null

false

none

none

suppressRepeatPartitionValues

boolean¦null

false

none

none

timeId

string¦null

false

none

none

validationRules

[Varicent.RESTAPI.v1.DTOs.WebReportValidationRuleDTO]¦null

false

none

none

selectedTemplateId

integer(int32)¦null

false

none

none

columnWidths

[number]¦null

false

none

none

displays

[array]¦null

false

none

none

fixedGridDisplayStyle

Varicent.RESTAPI.v1.DTOs.FixedGridDisplayStyleDTO

false

none

none

imageType

string¦null

false

none

none

imageLink

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

none

imageId

integer(int32)¦null

false

none

none

imageByteArray

string(byte)¦null

false

none

none

hoverText

string¦null

false

none

none

imageUrl

string¦null

false

none

none

expiryDate

string(date-time)¦null

false

none

none

cosObjectName

string¦null

false

none

none

controlDisplayStyle

Varicent.RESTAPI.v1.DTOs.ControlDisplayStyleDTO

false

none

none

sortById

boolean¦null

false

none

none

sortAscending

boolean¦null

false

none

none

refParameter

string¦null

false

none

none

nameColumn

string¦null

false

none

none

idColumn

string¦null

false

none

none

hideValueForExport

boolean¦null

false

none

none

hideIdValues

boolean¦null

false

none

none

scalarDisplayStyle

Varicent.RESTAPI.v1.DTOs.ScalarDisplayStyleDTO

false

none

none

scalarLink

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

none

text

string¦null

false

none

none

documentId

integer(int32)¦null

false

none

none

buttonDisplayStyle

Varicent.RESTAPI.v1.DTOs.ButtonDisplayStyleDTO

false

none

none

cellStyle

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

none

agreementText

string¦null

false

none

none

format

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

none

conditionalFormatRule

Varicent.RESTAPI.v1.DTOs.ConditionalFormatRuleDTO

false

none

none

dateDisplayMode

string¦null

false

none

none

xAxisName

string¦null

false

none

none

yAxisName

string¦null

false

none

none

numberPrefix

string¦null

false

none

none

numberSuffix

string¦null

false

none

none

labelOrientation

string¦null

false

none

none

hideValues

boolean¦null

false

none

none

decimalSeparator

string¦null

false

none

none

thousandSeparator

string¦null

false

none

none

isPercentage

string¦null

false

none

none

numDecimals

string¦null

false

none

none

numberScaling

string¦null

false

none

none

showTitle

boolean¦null

false

none

none

yMinMax

boolean¦null

false

none

none

zMinMax

boolean¦null

false

none

none

yMin

string¦null

false

none

none

yMax

string¦null

false

none

none

zMin

string¦null

false

none

none

zMax

string¦null

false

none

none

dontTrimBarLabel

string¦null

false

none

none

defaultLink

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

none

entityLinkMap

object¦null

false

none

none

» additionalProperties

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

none

fusionSource

Varicent.RESTAPI.v1.DTOs.FusionSourceDTO

false

none

none

fusionStyles

Varicent.RESTAPI.v1.DTOs.FusionStyleSetDTO

false

none

none

fusionTheme

string¦null

false

none

none

height

integer(int32)¦null

false

none

none

legendPosition

string¦null

false

none

none

mapDisplayType

string¦null

false

none

none

mapValueRanges

[Varicent.RESTAPI.v1.DTOs.ColorValueRangeDTO]¦null

false

none

none

showLegend

boolean¦null

false

none

none

width

integer(int32)¦null

false

none

none

ssChartDisplayType

string¦null

false

none

none

chartLink

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

none

customColors

[Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO]¦null

false

none

none

msChartDisplayType

string¦null

false

none

none

syAxisName

string¦null

false

none

none

syNumberPrefix

string¦null

false

none

none

syNumberSuffix

string¦null

false

none

none

hideSyValues

boolean¦null

false

none

none

centerValues

boolean¦null

false

none

none

syDecimalSeparator

string¦null

false

none

none

syThousandSeparator

string¦null

false

none

none

isSyPercentage

string¦null

false

none

none

syNumDecimals

string¦null

false

none

none

syNumberScaling

string¦null

false

none

none

lowerLimitDisplayName

string¦null

false

none

none

upperLimitDisplayName

string¦null

false

none

none

valueToolTip

string¦null

false

none

none

gaugeDisplayType

string¦null

false

none

none

link

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

none

limitLabelFillColor

string¦null

false

none

none

gaugeValueRanges

[Varicent.RESTAPI.v1.DTOs.ColorValueRangeDTO]¦null

false

none

none

trendpoint

Varicent.RESTAPI.v1.DTOs.TrendpointDTO

false

none

none

gaugeStartAngle

number(double)¦null

false

none

none

gaugeEndAngle

number(double)¦null

false

none

none

fillColor

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

none

status

string¦null

false

none

none

enableHeaders

boolean¦null

false

none

none

workflowLinkDisplayStyle

Varicent.RESTAPI.v1.DTOs.WorkflowLinkDisplayStyleDTO

false

none

none

columns

[string]¦null

false

none

none

Enumerated Values

Property

Value

type

DataGridDisplay

type

FixedGridDisplay

type

ImageDisplay

type

MapDisplay

type

MultiSeriesChartDisplay

type

PickListControl

type

QuickTextDisplay

type

DocumentLinkDisplay

type

SingleSeriesChartDisplay

type

SubmitButtonDisplay

type

TextControl

type

SignatureControl

type

TextScalarDisplay

type

NumericScalarDisplay

type

DateScalarDisplay

type

CylinderGaugeDisplay

type

HLinearGaugeDisplay

type

AngularGaugeDisplay

type

WorkflowLinkControl

dateDisplayMode

ShortDate

dateDisplayMode

LongDate

labelOrientation

Horizontal

labelOrientation

Vertical

labelOrientation

Slanted

fusionTheme

Classic

fusionTheme

Solid

legendPosition

Bottom

legendPosition

Right

mapDisplayType

Afghanistan

mapDisplayType

Africa

mapDisplayType

Alabama

mapDisplayType

Alaska

mapDisplayType

Albania

mapDisplayType

Alberta

mapDisplayType

Algeria

mapDisplayType

Andorra

mapDisplayType

Angola

mapDisplayType

Antigua

mapDisplayType

Argentina

mapDisplayType

Arizona

mapDisplayType

Arkansas

mapDisplayType

Armenia

mapDisplayType

Asia

mapDisplayType

Asia3

mapDisplayType

AsiaGeorgia

mapDisplayType

Australia

mapDisplayType

Australia2

mapDisplayType

Austria

mapDisplayType

Azerbaijan

mapDisplayType

Bahamas

mapDisplayType

Bahrain

mapDisplayType

Bangladesh

mapDisplayType

Barbados

mapDisplayType

Belarus

mapDisplayType

Belgium

mapDisplayType

Belize

mapDisplayType

Benin

mapDisplayType

Bhutan

mapDisplayType

Bolivia

mapDisplayType

BosniaHerzegovina

mapDisplayType

Botswana

mapDisplayType

Brazil

mapDisplayType

BrazilRegion

mapDisplayType

BritishColumbia

mapDisplayType

Brunei

mapDisplayType

Bulgaria

mapDisplayType

BurkinaFaso

mapDisplayType

Burma

mapDisplayType

Burundi

mapDisplayType

California

mapDisplayType

Cambodia

mapDisplayType

Cameroon

mapDisplayType

Canada

mapDisplayType

CapeVerde

mapDisplayType

CaymanIslands

mapDisplayType

CentralAfricanRepublic

mapDisplayType

CentralAmerica

mapDisplayType

CentralAmerica2

mapDisplayType

CentralAmericawithCaribbean

mapDisplayType

CentralEuropeanRegion

mapDisplayType

Chad

mapDisplayType

Chile

mapDisplayType

China

mapDisplayType

China2

mapDisplayType

Colombia

mapDisplayType

Colorado

mapDisplayType

Comoros

mapDisplayType

Congo

mapDisplayType

Connecticut

mapDisplayType

CostaRica

mapDisplayType

CoteDivoire

mapDisplayType

Croatia

mapDisplayType

Cuba

mapDisplayType

Cyprus

mapDisplayType

Cyprus2

mapDisplayType

CzechRepublic

mapDisplayType

Delaware

mapDisplayType

DemocraticRepublicofCongo

mapDisplayType

Denmark

mapDisplayType

DenmarkRegion

mapDisplayType

DistrictofColumbia

mapDisplayType

Djibouti

mapDisplayType

Dominica

mapDisplayType

DominicanRepublic

mapDisplayType

EastEuropeanRegion

mapDisplayType

EastTimor

mapDisplayType

Ecuador

mapDisplayType

Egypt

mapDisplayType

ElSalvador

mapDisplayType

England

mapDisplayType

EnglandRegion

mapDisplayType

EquatorialGuinea

mapDisplayType

Eritrea

mapDisplayType

Estonia

mapDisplayType

Ethiopia

mapDisplayType

Europe

mapDisplayType

Europe2

mapDisplayType

EuropeRegion

mapDisplayType

Europewithcountries

mapDisplayType

FalklandIsland

mapDisplayType

Fiji

mapDisplayType

Finland

mapDisplayType

Florida

mapDisplayType

France

mapDisplayType

FranceDepartment

mapDisplayType

FrenchGuiana

mapDisplayType

Gabon

mapDisplayType

Gambia

mapDisplayType

Georgia

mapDisplayType

Germany

mapDisplayType

Ghana

mapDisplayType

Greece

mapDisplayType

Greenland

mapDisplayType

Grenada

mapDisplayType

Guatemala

mapDisplayType

Guinea

mapDisplayType

GuineaBissau

mapDisplayType

Guyana

mapDisplayType

Haiti

mapDisplayType

Hawaii

mapDisplayType

Honduras

mapDisplayType

HongKong

mapDisplayType

Hungary

mapDisplayType

HungaryRegions

mapDisplayType

Iceland

mapDisplayType

Idaho

mapDisplayType

Illinois

mapDisplayType

India

mapDisplayType

Indiana

mapDisplayType

Indonesia

mapDisplayType

Iowa

mapDisplayType

Iran

mapDisplayType

Iraq

mapDisplayType

Ireland

mapDisplayType

Israel

mapDisplayType

Italy

mapDisplayType

Jamaica

mapDisplayType

Japan

mapDisplayType

Jordan

mapDisplayType

Kansas

mapDisplayType

Kazakhstan

mapDisplayType

Kentucky

mapDisplayType

Kenya

mapDisplayType

Kiribati

mapDisplayType

KosovoDistricts

mapDisplayType

Kuwait

mapDisplayType

Kyrgyzstan

mapDisplayType

Laos

mapDisplayType

Latvia

mapDisplayType

Lebanon

mapDisplayType

Lesotho

mapDisplayType

Liberia

mapDisplayType

Libya

mapDisplayType

Liechtenstein

mapDisplayType

Lithuania

mapDisplayType

Louisiana

mapDisplayType

Luxembourg

mapDisplayType

Macau

mapDisplayType

Macedonia

mapDisplayType

Madagascar

mapDisplayType

MadagascarRegions

mapDisplayType

Maine

mapDisplayType

Malawi

mapDisplayType

Malaysia

mapDisplayType

Mali

mapDisplayType

Malta

mapDisplayType

Manitoba

mapDisplayType

MarshallIsland

mapDisplayType

Maryland

mapDisplayType

Massachusetts

mapDisplayType

Mauritania

mapDisplayType

Mauritius

mapDisplayType

Mexico

mapDisplayType

Michigan

mapDisplayType

Micronesia

mapDisplayType

MiddleEast

mapDisplayType

Minnesota

mapDisplayType

Mississippi

mapDisplayType

Missouri

mapDisplayType

Moldova

mapDisplayType

Monaco

mapDisplayType

Mongolia

mapDisplayType

Montana

mapDisplayType

Montenegro

mapDisplayType

Morocco

mapDisplayType

Mozambique

mapDisplayType

Namibia

mapDisplayType

Nauru

mapDisplayType

Nebraska

mapDisplayType

Nepal

mapDisplayType

Netherlands

mapDisplayType

Nevada

mapDisplayType

NewBrunswick

mapDisplayType

NewCaledonia

mapDisplayType

NewfoundlandandLabrador

mapDisplayType

NewHampshire

mapDisplayType

NewJersey

mapDisplayType

NewMexico

mapDisplayType

NewYork

mapDisplayType

NewZealand

mapDisplayType

Nicaragua

mapDisplayType

Niger

mapDisplayType

Nigeria

mapDisplayType

NorthAmerica

mapDisplayType

NorthAmericaWOCentral

mapDisplayType

NorthCarolina

mapDisplayType

NorthDakota

mapDisplayType

NorthEuropeanRegion

mapDisplayType

NorthernIreland

mapDisplayType

NorthKorea

mapDisplayType

NorthWestTerritories

mapDisplayType

Norway

mapDisplayType

NorwayRegion

mapDisplayType

NovaScotia

mapDisplayType

Nunavut

mapDisplayType

Oceania

mapDisplayType

Ohio

mapDisplayType

Oklahoma

mapDisplayType

Oman

mapDisplayType

Ontario

mapDisplayType

Oregon

mapDisplayType

Pakistan

mapDisplayType

Palau

mapDisplayType

Panama

mapDisplayType

PapuaNewGuinea

mapDisplayType

Paraguay

mapDisplayType

Pennsylvania

mapDisplayType

Peru

mapDisplayType

Philippines

mapDisplayType

Poland

mapDisplayType

PolandCounties

mapDisplayType

Portugal

mapDisplayType

PrinceEdwardIsland

mapDisplayType

PuertoRico

mapDisplayType

Qatar

mapDisplayType

Quebec

mapDisplayType

RhodeIsland

mapDisplayType

Romania

mapDisplayType

Russia

mapDisplayType

Rwanda

mapDisplayType

SaintKittsandNevis

mapDisplayType

SaintLucia

mapDisplayType

SaintVincentandtheGrenadines

mapDisplayType

Samoa

mapDisplayType

SanMarino

mapDisplayType

SaoTomeandPrincipe

mapDisplayType

Saskatchewan

mapDisplayType

SaudiArabia

mapDisplayType

Scotland

mapDisplayType

ScotlandRegion

mapDisplayType

Senegal

mapDisplayType

Serbia

mapDisplayType

SerbiaWoKosovo

mapDisplayType

Seychelles

mapDisplayType

SierraLeone

mapDisplayType

Singapore

mapDisplayType

Slovakia

mapDisplayType

Slovenia

mapDisplayType

SolomonIsland

mapDisplayType

Somalia

mapDisplayType

SouthAfrica

mapDisplayType

SouthAmerica

mapDisplayType

SouthCarolina

mapDisplayType

SouthDakota

mapDisplayType

SouthEuropeanRegion

mapDisplayType

SouthKorea

mapDisplayType

SouthSudan

mapDisplayType

Spain

mapDisplayType

SpainProvinces

mapDisplayType

SriLanka

mapDisplayType

Sudan

mapDisplayType

SudanWoSouthSudan

mapDisplayType

Suriname

mapDisplayType

Swaziland

mapDisplayType

Sweden

mapDisplayType

Switzerland

mapDisplayType

Syria

mapDisplayType

Taiwan

mapDisplayType

Tajikistan

mapDisplayType

Tanzania

mapDisplayType

Tennessee

mapDisplayType

Texas

mapDisplayType

Thailand

mapDisplayType

Tibet

mapDisplayType

Togo

mapDisplayType

Tonga

mapDisplayType

TrinidadandTobago

mapDisplayType

Tunisia

mapDisplayType

Turkey

mapDisplayType

Turkmenistan

mapDisplayType

Tuvalu

mapDisplayType

UAE

mapDisplayType

Uganda

mapDisplayType

UK

mapDisplayType

UK7

mapDisplayType

Ukraine

mapDisplayType

Uruguay

mapDisplayType

USA

mapDisplayType

USACentralRegion

mapDisplayType

USANorthEastRegion

mapDisplayType

USANorthWestRegion

mapDisplayType

USARegion

mapDisplayType

USASouthEastRegion

mapDisplayType

USASouthWestRegion

mapDisplayType

Utah

mapDisplayType

Uzbekistan

mapDisplayType

Vanuatu

mapDisplayType

VaticanCity

mapDisplayType

Venezuela

mapDisplayType

Vermont

mapDisplayType

Vietnam

mapDisplayType

Virginia

mapDisplayType

Wales

mapDisplayType

Washington

mapDisplayType

WesternSahara

mapDisplayType

WestEuropeanRegion

mapDisplayType

WestVirginia

mapDisplayType

Wisconsin

mapDisplayType

World

mapDisplayType

World8

mapDisplayType

World8WithAntarctica

mapDisplayType

WorldWithAntarctica

mapDisplayType

WorldwithCountries

mapDisplayType

Wyoming

mapDisplayType

Yemen

mapDisplayType

YukonTerritory

mapDisplayType

Zambia

mapDisplayType

Zimbabwe

ssChartDisplayType

Area2D

ssChartDisplayType

Bar2D

ssChartDisplayType

Column2D

ssChartDisplayType

Column3D

ssChartDisplayType

Doughnut2D

ssChartDisplayType

Doughnut3D

ssChartDisplayType

Funnel

ssChartDisplayType

Pyramid

ssChartDisplayType

Line

ssChartDisplayType

Pie2D

ssChartDisplayType

Pie3D

ssChartDisplayType

Spline

ssChartDisplayType

SplineArea

ssChartDisplayType

Waterfall2D

ssChartDisplayType

Kagi

msChartDisplayType

MSArea

msChartDisplayType

InverseMSArea

msChartDisplayType

ScrollArea2D

msChartDisplayType

MSBar2D

msChartDisplayType

MSColumn2D

msChartDisplayType

InverseMSColumn2D

msChartDisplayType

ScrollColumn2D

msChartDisplayType

LogMSColumn2D

msChartDisplayType

MSColumn3D

msChartDisplayType

MSLine

msChartDisplayType

InverseMSLine

msChartDisplayType

ScrollLine2D

msChartDisplayType

LogMSLine

msChartDisplayType

StackedArea2D

msChartDisplayType

StackedBar2D

msChartDisplayType

StackedBar3D

msChartDisplayType

StackedColumn2D

msChartDisplayType

ScrollStackedColumn2D

msChartDisplayType

StackedColumn3D

msChartDisplayType

MSSpline

msChartDisplayType

MSSplineArea

msChartDisplayType

Radar

msChartDisplayType

Scatter

msChartDisplayType

Bubble

msChartDisplayType

MSCombi2D

msChartDisplayType

MSCombi3D

msChartDisplayType

MSColumnLine3D

msChartDisplayType

MSCombiDY2D

msChartDisplayType

MSColumn3DLineDY

msChartDisplayType

StackedColumn3DLineDY

gaugeDisplayType

AngularGauge

gaugeDisplayType

Cylinder

gaugeDisplayType

HLinearGauge

status

Available

status

Pending

status

Closed

json
{
  "gridType": "string",
  "name": "string",
  "source": {
    "name": "string"
  },
  "type": "DataGridDisplay",
  "restrictSource": {
    "name": "string"
  },
  "restrictColumn": "string",
  "style": {
    "displayBorders": {
      "bottom": {},
      "left": {},
      "right": {},
      "top": {}
    },
    "displayPadding": {
      "bottom": 0.1,
      "left": 0.1,
      "right": 0.1,
      "top": 0.1
    }
  },
  "columnMap": {
    "property1": {
      "displayName": {},
      "dateFormat": {},
      "pickListFilter": {},
      "defaultValue": "string",
      "referencedFrequency": {},
      "isEditable": true,
      "picklistDisplayOptions": {},
      "order": 0,
      "headerStyle": {},
      "formatRule": {},
      "columnLink": {},
      "numericFormat": {},
      "width": 0.1,
      "initiallyShow": true,
      "useRowTextAlignment": true,
      "wrapText": true,
      "maxWidth": 0,
      "verticalAlignment": "Top"
    },
    "property2": {
      "displayName": {},
      "dateFormat": {},
      "pickListFilter": {},
      "defaultValue": "string",
      "referencedFrequency": {},
      "isEditable": true,
      "picklistDisplayOptions": {},
      "order": 0,
      "headerStyle": {},
      "formatRule": {},
      "columnLink": {},
      "numericFormat": {},
      "width": 0.1,
      "initiallyShow": true,
      "useRowTextAlignment": true,
      "wrapText": true,
      "maxWidth": 0,
      "verticalAlignment": "Top"
    }
  },
  "computedColumns": [
    {
      "name": "string",
      "formula": "string",
      "order": 0,
      "headerStyle": {},
      "formatRule": {},
      "columnLink": {},
      "numericFormat": {},
      "width": 0.1,
      "initiallyShow": true,
      "useRowTextAlignment": true,
      "wrapText": true,
      "maxWidth": 0,
      "verticalAlignment": "Top"
    }
  ],
  "computedRow": {
    "property1": {
      "columnDisplayName": "string",
      "cellValue": "string",
      "valueType": "Text",
      "numericFormat": {}
    },
    "property2": {
      "columnDisplayName": "string",
      "cellValue": "string",
      "valueType": "Text",
      "numericFormat": {}
    }
  },
  "dataGridDisplayStyle": {
    "headerStyle": {
      "alignment": "Justify",
      "backColor": {},
      "font": {},
      "foreColor": {}
    },
    "evenRowStyle": {
      "alignment": "Justify",
      "backColor": {},
      "font": {},
      "foreColor": {}
    },
    "oddRowStyle": {
      "alignment": "Justify",
      "backColor": {},
      "font": {},
      "foreColor": {}
    },
    "allowAlternateRowFont": true,
    "isHeaderVerticalAlignmentBottom": true,
    "computedRowStyle": {
      "alignment": "Justify",
      "backColor": {},
      "font": {},
      "foreColor": {}
    },
    "borderWidth": 0,
    "displayBorders": {
      "bottom": {},
      "left": {},
      "right": {},
      "top": {}
    },
    "displayPadding": {
      "bottom": 0.1,
      "left": 0.1,
      "right": 0.1,
      "top": 0.1
    }
  },
  "dataGridInputRules": [
    {
      "id": 0,
      "dataGrid": "string",
      "table": "string",
      "column": "string",
      "operatorType": "LessThan",
      "valueType": "String",
      "value": null
    }
  ],
  "dateFormat": {
    "style": "Date"
  },
  "defaultPageSize": 0,
  "enableExportToExcel": true,
  "enableInquiryCopy": true,
  "enableShowHideColumns": true,
  "freezeTopRow": true,
  "hiddenColumnAliasMap": {
    "property1": "string",
    "property2": "string"
  },
  "hiddenColumns": [
    {
      "order": 0,
      "name": "string",
      "type": "string"
    }
  ],
  "hiddenInputRowColumnMap": {
    "property1": {
      "displayName": {},
      "dateFormat": {},
      "pickListFilter": {},
      "defaultValue": "string",
      "referencedFrequency": {},
      "isEditable": true,
      "picklistDisplayOptions": {},
      "order": 0,
      "headerStyle": {},
      "formatRule": {},
      "columnLink": {},
      "numericFormat": {},
      "width": 0.1,
      "initiallyShow": true,
      "useRowTextAlignment": true,
      "wrapText": true,
      "maxWidth": 0,
      "verticalAlignment": "Top"
    },
    "property2": {
      "displayName": {},
      "dateFormat": {},
      "pickListFilter": {},
      "defaultValue": "string",
      "referencedFrequency": {},
      "isEditable": true,
      "picklistDisplayOptions": {},
      "order": 0,
      "headerStyle": {},
      "formatRule": {},
      "columnLink": {},
      "numericFormat": {},
      "width": 0.1,
      "initiallyShow": true,
      "useRowTextAlignment": true,
      "wrapText": true,
      "maxWidth": 0,
      "verticalAlignment": "Top"
    }
  },
  "inputRowAtTop": true,
  "isVertical": true,
  "numericStyle": {
    "scale": 0,
    "style": "Number"
  },
  "paginated": true,
  "sections": [
    {
      "name": "string",
      "frequency": {},
      "sources": [],
      "sectionDisplayStyle": {}
    }
  ],
  "showOnlyInputRow": true,
  "showSectionHeader": true,
  "sortColumns": [
    {
      "column": "string",
      "sortDescending": true,
      "columnFrequency": {}
    }
  ],
  "suppressHeader": true,
  "hideRowBorders": true,
  "disableRowHighlighting": true,
  "suppressRepeatPartitionValues": true,
  "timeId": "string",
  "validationRules": [
    {
      "formula": "string",
      "errorMessage": "string"
    }
  ],
  "selectedTemplateId": 0,
  "columnWidths": [
    0.1
  ],
  "displays": [
    []
  ],
  "fixedGridDisplayStyle": {
    "rowStyle": {
      "alignment": "Justify",
      "backColor": {},
      "font": {},
      "foreColor": {}
    },
    "borderWidth": 0,
    "displayBorders": {
      "bottom": {},
      "left": {},
      "right": {},
      "top": {}
    },
    "displayPadding": {
      "bottom": 0.1,
      "left": 0.1,
      "right": 0.1,
      "top": 0.1
    }
  },
  "imageType": "string",
  "imageLink": {
    "document": "string",
    "openInNewWindow": true,
    "parameters": {
      "property1": {},
      "property2": {}
    },
    "reportId": 0,
    "targetId": 0,
    "targetType": "WebReport",
    "webFormId": 0,
    "webTabId": 0
  },
  "imageId": 0,
  "imageByteArray": "string",
  "hoverText": "string",
  "imageUrl": "string",
  "expiryDate": "2019-08-24T14:15:22Z",
  "cosObjectName": "string",
  "controlDisplayStyle": {
    "style": {
      "alignment": "Justify",
      "backColor": {},
      "font": {},
      "foreColor": {}
    },
    "displayBorders": {
      "bottom": {},
      "left": {},
      "right": {},
      "top": {}
    },
    "displayPadding": {
      "bottom": 0.1,
      "left": 0.1,
      "right": 0.1,
      "top": 0.1
    }
  },
  "sortById": true,
  "sortAscending": true,
  "refParameter": "string",
  "nameColumn": "string",
  "idColumn": "string",
  "hideValueForExport": true,
  "hideIdValues": true,
  "scalarDisplayStyle": {
    "style": {
      "alignment": "Justify",
      "backColor": {},
      "font": {},
      "foreColor": {}
    },
    "displayBorders": {
      "bottom": {},
      "left": {},
      "right": {},
      "top": {}
    },
    "displayPadding": {
      "bottom": 0.1,
      "left": 0.1,
      "right": 0.1,
      "top": 0.1
    }
  },
  "scalarLink": {
    "document": "string",
    "openInNewWindow": true,
    "parameters": {
      "property1": {},
      "property2": {}
    },
    "reportId": 0,
    "targetId": 0,
    "targetType": "WebReport",
    "webFormId": 0,
    "webTabId": 0
  },
  "text": "string",
  "documentId": 0,
  "buttonDisplayStyle": {
    "style": {
      "alignment": "Justify",
      "backColor": {},
      "font": {},
      "foreColor": {}
    },
    "displayBorders": {
      "bottom": {},
      "left": {},
      "right": {},
      "top": {}
    },
    "displayPadding": {
      "bottom": 0.1,
      "left": 0.1,
      "right": 0.1,
      "top": 0.1
    }
  },
  "cellStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "agreementText": "string",
  "format": {
    "scale": 0,
    "style": "Number"
  },
  "conditionalFormatRule": {
    "formats": [
      {}
    ]
  },
  "dateDisplayMode": "ShortDate",
  "xAxisName": "string",
  "yAxisName": "string",
  "numberPrefix": "string",
  "numberSuffix": "string",
  "labelOrientation": "Horizontal",
  "hideValues": true,
  "decimalSeparator": "string",
  "thousandSeparator": "string",
  "isPercentage": "string",
  "numDecimals": "string",
  "numberScaling": "string",
  "showTitle": true,
  "yMinMax": true,
  "zMinMax": true,
  "yMin": "string",
  "yMax": "string",
  "zMin": "string",
  "zMax": "string",
  "dontTrimBarLabel": "string",
  "defaultLink": {
    "document": "string",
    "openInNewWindow": true,
    "parameters": {
      "property1": {},
      "property2": {}
    },
    "reportId": 0,
    "targetId": 0,
    "targetType": "WebReport",
    "webFormId": 0,
    "webTabId": 0
  },
  "entityLinkMap": {
    "property1": {
      "document": "string",
      "openInNewWindow": true,
      "parameters": {},
      "reportId": 0,
      "targetId": 0,
      "targetType": "WebReport",
      "webFormId": 0,
      "webTabId": 0
    },
    "property2": {
      "document": "string",
      "openInNewWindow": true,
      "parameters": {},
      "reportId": 0,
      "targetId": 0,
      "targetType": "WebReport",
      "webFormId": 0,
      "webTabId": 0
    }
  },
  "fusionSource": {
    "type": "ComboSource",
    "sorted": true,
    "descending": true,
    "sortedByName": true,
    "sourceName": "string",
    "chartLink": {
      "document": "string",
      "openInNewWindow": true,
      "parameters": {},
      "reportId": 0,
      "targetId": 0,
      "targetType": "WebReport",
      "webFormId": 0,
      "webTabId": 0
    },
    "displayColumn": "string",
    "valueColumn": "string",
    "sourceAlias": "string",
    "sortingInfo": {
      "levelId": "string",
      "sortDescending": true,
      "timeId": "string",
      "sortedByName": true
    },
    "xColumn": "string",
    "yColumn": "string",
    "zColumn": "string",
    "renderAs": "Column",
    "isPrimaryAxis": true,
    "entityColumn": "string",
    "sources": [],
    "minValueSourceName": "string",
    "maxValueSourceName": "string",
    "currentValueSourceName": "string",
    "trendpointValueSourceName": "string"
  },
  "fusionStyles": {
    "type": "SingleSeriesChartStyleSet",
    "title": {
      "color": {},
      "font": {}
    },
    "xAxisName": {
      "color": {},
      "font": {}
    },
    "yAxisName": {
      "color": {},
      "font": {}
    },
    "xAxisValues": {
      "color": {},
      "font": {}
    },
    "yAxisValues": {
      "color": {},
      "font": {}
    },
    "legend": {
      "color": {},
      "font": {}
    },
    "syAxisName": {
      "color": {},
      "font": {}
    },
    "syAxisValues": {
      "color": {},
      "font": {}
    },
    "labels": {
      "color": {},
      "font": {}
    },
    "tickValues": {
      "color": {},
      "font": {}
    },
    "pointerOrFill": {
      "color": {},
      "font": {}
    }
  },
  "fusionTheme": "Classic",
  "height": 0,
  "legendPosition": "Bottom",
  "mapDisplayType": "Afghanistan",
  "mapValueRanges": [
    {
      "label": "string",
      "min": 0.1,
      "max": 0.1,
      "color": {}
    }
  ],
  "showLegend": true,
  "width": 0,
  "ssChartDisplayType": "Area2D",
  "chartLink": {
    "document": "string",
    "openInNewWindow": true,
    "parameters": {
      "property1": {},
      "property2": {}
    },
    "reportId": 0,
    "targetId": 0,
    "targetType": "WebReport",
    "webFormId": 0,
    "webTabId": 0
  },
  "customColors": [
    {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  ],
  "msChartDisplayType": "MSArea",
  "syAxisName": "string",
  "syNumberPrefix": "string",
  "syNumberSuffix": "string",
  "hideSyValues": true,
  "centerValues": true,
  "syDecimalSeparator": "string",
  "syThousandSeparator": "string",
  "isSyPercentage": "string",
  "syNumDecimals": "string",
  "syNumberScaling": "string",
  "lowerLimitDisplayName": "string",
  "upperLimitDisplayName": "string",
  "valueToolTip": "string",
  "gaugeDisplayType": "AngularGauge",
  "link": {
    "document": "string",
    "openInNewWindow": true,
    "parameters": {
      "property1": {},
      "property2": {}
    },
    "reportId": 0,
    "targetId": 0,
    "targetType": "WebReport",
    "webFormId": 0,
    "webTabId": 0
  },
  "limitLabelFillColor": "string",
  "gaugeValueRanges": [
    {
      "label": "string",
      "min": 0.1,
      "max": 0.1,
      "color": {}
    }
  ],
  "trendpoint": {
    "label": "string",
    "labelStyle": {
      "color": {},
      "font": {}
    },
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "gaugeStartAngle": 0.1,
  "gaugeEndAngle": 0.1,
  "fillColor": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "status": "Available",
  "enableHeaders": true,
  "workflowLinkDisplayStyle": {
    "headerStyle": {
      "alignment": "Justify",
      "backColor": {},
      "font": {},
      "foreColor": {}
    },
    "primaryStyle": {
      "alignment": "Justify",
      "backColor": {},
      "font": {},
      "foreColor": {}
    },
    "secondaryStyle": {
      "alignment": "Justify",
      "backColor": {},
      "font": {},
      "foreColor": {}
    },
    "displayBorders": {
      "bottom": {},
      "left": {},
      "right": {},
      "top": {}
    },
    "displayPadding": {
      "bottom": 0.1,
      "left": 0.1,
      "right": 0.1,
      "top": 0.1
    }
  },
  "columns": [
    "WorkflowID"
  ]
}

Varicent.RESTAPI.v1.DTOs.DataDisplayStyleDTO

Properties

Name

Type

Required

Restrictions

Description

displayBorders

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

none

displayPadding

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

none

json
{
  "displayBorders": {
    "bottom": {
      "color": {},
      "width": 0.1
    },
    "left": {
      "color": {},
      "width": 0.1
    },
    "right": {
      "color": {},
      "width": 0.1
    },
    "top": {
      "color": {},
      "width": 0.1
    }
  },
  "displayPadding": {
    "bottom": 0.1,
    "left": 0.1,
    "right": 0.1,
    "top": 0.1
  }
}

Varicent.RESTAPI.v1.DTOs.DataGridColumnDisplayNameDTO

Properties

Name

Type

Required

Restrictions

Description

displayName

string¦null

false

none

none

json
{
  "displayName": "string"
}

Varicent.RESTAPI.v1.DTOs.DataGridComputedColumnDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

formula

string¦null

false

none

none

order

integer(int32)

false

none

none

headerStyle

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

none

formatRule

Varicent.RESTAPI.v1.DTOs.ConditionalFormatRuleDTO

false

none

none

columnLink

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

none

numericFormat

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

none

width

number(double)

false

none

none

initiallyShow

boolean

false

none

none

useRowTextAlignment

boolean

false

none

none

wrapText

boolean

false

none

none

maxWidth

integer(int32)

false

none

none

verticalAlignment

string

false

none

none

Enumerated Values

Property

Value

verticalAlignment

Top

verticalAlignment

Middle

verticalAlignment

Bottom

json
{
  "name": "string",
  "formula": "string",
  "order": 0,
  "headerStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "formatRule": {
    "formats": [
      {}
    ]
  },
  "columnLink": {
    "document": "string",
    "openInNewWindow": true,
    "parameters": {
      "property1": {},
      "property2": {}
    },
    "reportId": 0,
    "targetId": 0,
    "targetType": "WebReport",
    "webFormId": 0,
    "webTabId": 0
  },
  "numericFormat": {
    "scale": 0,
    "style": "Number"
  },
  "width": 0.1,
  "initiallyShow": true,
  "useRowTextAlignment": true,
  "wrapText": true,
  "maxWidth": 0,
  "verticalAlignment": "Top"
}

Varicent.RESTAPI.v1.DTOs.DataGridComputedRowCellDTO

Properties

Name

Type

Required

Restrictions

Description

columnDisplayName

string¦null

false

none

none

cellValue

string¦null

false

none

none

valueType

string

false

none

none

numericFormat

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

none

Enumerated Values

Property

Value

valueType

Text

valueType

Formula

json
{
  "columnDisplayName": "string",
  "cellValue": "string",
  "valueType": "Text",
  "numericFormat": {
    "scale": 0,
    "style": "Number"
  }
}

Varicent.RESTAPI.v1.DTOs.DataGridDisplayStyleDTO

Properties

Name

Type

Required

Restrictions

Description

headerStyle

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

none

evenRowStyle

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

none

oddRowStyle

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

none

allowAlternateRowFont

boolean

false

none

none

isHeaderVerticalAlignmentBottom

boolean

false

none

none

computedRowStyle

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

none

borderWidth

integer(int32)

false

none

none

displayBorders

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

none

displayPadding

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

none

json
{
  "headerStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "evenRowStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "oddRowStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "allowAlternateRowFont": true,
  "isHeaderVerticalAlignmentBottom": true,
  "computedRowStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "borderWidth": 0,
  "displayBorders": {
    "bottom": {
      "color": {},
      "width": 0.1
    },
    "left": {
      "color": {},
      "width": 0.1
    },
    "right": {
      "color": {},
      "width": 0.1
    },
    "top": {
      "color": {},
      "width": 0.1
    }
  },
  "displayPadding": {
    "bottom": 0.1,
    "left": 0.1,
    "right": 0.1,
    "top": 0.1
  }
}

Varicent.RESTAPI.v1.DTOs.DataGridHiddenColumnDTO

Properties

Name

Type

Required

Restrictions

Description

order

integer(int32)

false

none

none

name

string¦null

false

none

none

type

string¦null

false

none

none

json
{
  "order": 0,
  "name": "string",
  "type": "string"
}

Varicent.RESTAPI.v1.DTOs.DataGridInputRuleDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

dataGrid

string¦null

false

none

none

table

string¦null

false

none

none

column

string¦null

false

none

none

operatorType

string

false

none

none

valueType

string

false

none

none

value

any

false

none

none

Enumerated Values

Property

Value

operatorType

LessThan

operatorType

LessThanEquals

operatorType

Equals

operatorType

NotEquals

operatorType

GreaterThan

operatorType

GreaterThanEquals

operatorType

IsNull

operatorType

IsNotNull

valueType

String

valueType

Numeric

valueType

Date

valueType

Field

valueType

Scalar

json
{
  "id": 0,
  "dataGrid": "string",
  "table": "string",
  "column": "string",
  "operatorType": "LessThan",
  "valueType": "String",
  "value": null
}

Varicent.RESTAPI.v1.DTOs.DataGridItemDTO

Properties

Name

Type

Required

Restrictions

Description

reportID

integer(int32)

false

none

none

reportName

string¦null

false

none

none

dataGridName

string¦null

false

none

none

json
{
  "reportID": 0,
  "reportName": "string",
  "dataGridName": "string"
}

Varicent.RESTAPI.v1.DTOs.DataGridPicklistFilterDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

source

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

column

string¦null

false

none

none

json
{
  "name": "string",
  "source": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "column": "string"
}

Varicent.RESTAPI.v1.DTOs.DataGridSortColumnDTO

Properties

Name

Type

Required

Restrictions

Description

column

string¦null

false

none

none

sortDescending

boolean

false

none

none

columnFrequency

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

none

json
{
  "column": "string",
  "sortDescending": true,
  "columnFrequency": {
    "levelId": "string",
    "timeId": "string"
  }
}

Varicent.RESTAPI.v1.DTOs.DataGridSourceColumnDTO

Properties

Name

Type

Required

Restrictions

Description

displayName

Varicent.RESTAPI.v1.DTOs.DataGridColumnDisplayNameDTO

false

none

none

dateFormat

Varicent.RESTAPI.v1.DTOs.PRDateFormatDTO

false

none

none

pickListFilter

Varicent.RESTAPI.v1.DTOs.DataGridPicklistFilterDTO

false

none

none

defaultValue

string¦null

false

none

none

referencedFrequency

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

none

isEditable

boolean

false

none

none

picklistDisplayOptions

Varicent.RESTAPI.v1.DTOs.InputRowPicklistOptionsDTO

false

none

none

order

integer(int32)

false

none

none

headerStyle

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

none

formatRule

Varicent.RESTAPI.v1.DTOs.ConditionalFormatRuleDTO

false

none

none

columnLink

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

none

numericFormat

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

none

width

number(double)

false

none

none

initiallyShow

boolean

false

none

none

useRowTextAlignment

boolean

false

none

none

wrapText

boolean

false

none

none

maxWidth

integer(int32)

false

none

none

verticalAlignment

string

false

none

none

Enumerated Values

Property

Value

verticalAlignment

Top

verticalAlignment

Middle

verticalAlignment

Bottom

json
{
  "displayName": {
    "displayName": "string"
  },
  "dateFormat": {
    "style": "Date"
  },
  "pickListFilter": {
    "name": "string",
    "source": {
      "query": {},
      "sourceNames": {}
    },
    "column": "string"
  },
  "defaultValue": "string",
  "referencedFrequency": {
    "levelId": "string",
    "timeId": "string"
  },
  "isEditable": true,
  "picklistDisplayOptions": {
    "description": "string",
    "order": "Ascending",
    "hideKey": true,
    "hideDescription": true,
    "sortById": true
  },
  "order": 0,
  "headerStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "formatRule": {
    "formats": [
      {}
    ]
  },
  "columnLink": {
    "document": "string",
    "openInNewWindow": true,
    "parameters": {
      "property1": {},
      "property2": {}
    },
    "reportId": 0,
    "targetId": 0,
    "targetType": "WebReport",
    "webFormId": 0,
    "webTabId": 0
  },
  "numericFormat": {
    "scale": 0,
    "style": "Number"
  },
  "width": 0.1,
  "initiallyShow": true,
  "useRowTextAlignment": true,
  "wrapText": true,
  "maxWidth": 0,
  "verticalAlignment": "Top"
}

Varicent.RESTAPI.v1.DTOs.DataGridTemplateDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

name

string¦null

false

none

none

headerStyle

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

none

evenRowStyle

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

none

oddRowStyle

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

none

computedRowStyle

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

none

sectionStyle

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

none

allowAlternateRowStyle

boolean

false

none

none

isHeaderVerticalAlignmentBottom

boolean

false

none

none

showGridLines

boolean

false

none

none

suppressHeader

boolean

false

none

none

showSectionHeader

boolean

false

none

none

isDefaultTemplate

boolean

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "id": 0,
  "name": "string",
  "headerStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "evenRowStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "oddRowStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "computedRowStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "sectionStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "allowAlternateRowStyle": true,
  "isHeaderVerticalAlignmentBottom": true,
  "showGridLines": true,
  "suppressHeader": true,
  "showSectionHeader": true,
  "isDefaultTemplate": true,
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.DataItemDTO

Properties

Name

Type

Required

Restrictions

Description

path

RESTAPI.v1.DTOs.DataPathDTO

false

none

none

column

string¦null

false

none

none

alias

string¦null

false

none

none

json
{
  "path": {
    "path": [
      "string"
    ]
  },
  "column": "string",
  "alias": "string"
}

Varicent.RESTAPI.v1.DTOs.DataModule.DataModuleTableElementDTO

Properties

Name

Type

Required

Restrictions

Description

tableName

string¦null

false

none

none

hasScheduleImport

boolean

false

none

none

importType

string¦null

false

none

none

dateModified

string(date-time)¦null

false

none

none

dateCreated

string(date-time)

false

none

none

tableType

string¦null

false

none

none

parentBlockID

integer(int32)

false

none

none

records

integer(int32)¦null

false

none

none

importTime

string(date-time)¦null

false

none

none

tableAudit

Varicent.Domain.DataModule.TableAudit Varicent.Domain.DataModule.TableAudit

false

none

none

effectiveDated

boolean

false

none

none

description

string¦null

false

none

none

calculationCount

integer(int32)

false

none

none

isReadOnly

boolean

false

none

none

Enumerated Values

Property

Value

importType

None

importType

Text

importType

Excel

importType

DBImport

importType

Salesforce

importType

MSCRM

importType

EBCDICText

importType

TerrAlign

importType

XML

importType

ODBCImport

importType

SymonImport

importType

SymonConnectorImport

importType

Cos

importType

SQLServer

importType

Dynamics

importType

GoogleSheets

importType

MySql

importType

AmazonAurora

importType

AmazonS3

importType

Snowflake

importType

Shopify

importType

Hubspot

importType

Oracle

importType

AmazonRedshift

importType

Workday

json
{
  "tableName": "string",
  "hasScheduleImport": true,
  "importType": "None",
  "dateModified": "2019-08-24T14:15:22Z",
  "dateCreated": "2019-08-24T14:15:22Z",
  "tableType": "string",
  "parentBlockID": 0,
  "records": 0,
  "importTime": "2019-08-24T14:15:22Z",
  "tableAudit": {
    "tableName": "string",
    "userID": "string",
    "inserts": 0,
    "updates": 0,
    "deletes": 0,
    "eventType": "RowAdd",
    "importType": "None",
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z"
  },
  "effectiveDated": true,
  "description": "string",
  "calculationCount": 0,
  "isReadOnly": true
}

Varicent.RESTAPI.v1.DTOs.DataModuleTableRowsDTO

Properties

Name

Type

Required

Restrictions

Description

tables

[Varicent.RESTAPI.v1.DTOs.DataModule.DataModuleTableElementDTO]¦null

false

none

none

total

integer(int32)

false

none

none

json
{
  "tables": [
    {
      "tableName": "string",
      "hasScheduleImport": true,
      "importType": "None",
      "dateModified": "2019-08-24T14:15:22Z",
      "dateCreated": "2019-08-24T14:15:22Z",
      "tableType": "string",
      "parentBlockID": 0,
      "records": 0,
      "importTime": "2019-08-24T14:15:22Z",
      "tableAudit": {},
      "effectiveDated": true,
      "description": "string",
      "calculationCount": 0,
      "isReadOnly": true
    }
  ],
  "total": 0
}

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

Properties

Name

Type

Required

Restrictions

Description

namespaceTable

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

false

none

none

query

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

alias

string¦null

false

none

none

sourceType

string

false

none

none

Enumerated Values

Property

Value

sourceType

Table

sourceType

Query

json
{
  "namespaceTable": {
    "m_namespace": "string",
    "name": "string"
  },
  "query": null,
  "alias": "string",
  "sourceType": "Table"
}

Varicent.RESTAPI.v1.DTOs.DataStoreDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

name

string¦null

false

none

none

workflowObjectID

integer(int32)

false

none

none

source

Varicent.RESTAPI.v1.DTOs.QuerySourceDefinitionDTO Varicent.RESTAPI.v1.DTOs.QuerySourceDefinitionDTO

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "id": 0,
  "name": "string",
  "workflowObjectID": 0,
  "source": {
    "name": "string",
    "sourceDefinition": {
      "query": {},
      "sourceNames": {}
    },
    "dependencies": [
      "string"
    ],
    "columns": [
      {}
    ],
    "references": {
      "property1": "string",
      "property2": "string"
    },
    "timeReferences": {
      "property1": {},
      "property2": {}
    }
  },
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.DefaultValueDTO

Properties

Name

Type

Required

Restrictions

Description

table

string¦null

false

none

none

column

string¦null

false

none

none

dataType

string

false

none

none

value

any

false

none

none

valid

boolean

false

none

none

Enumerated Values

Property

Value

dataType

Text

dataType

Date

dataType

List

dataType

Numeric

dataType

Email

dataType

Url

dataType

Comment

dataType

DateTime

json
{
  "table": "string",
  "column": "string",
  "dataType": "Text",
  "value": null,
  "valid": true
}

Varicent.RESTAPI.v1.DTOs.DeleteBPMFolderDTO

Properties

Name

Type

Required

Restrictions

Description

folder

RESTAPI.v1.DTOs.TreeNodeDTO

false

none

none

parentFolderRowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "folder": {
    "node": null,
    "children": []
  },
  "parentFolderRowVersion": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.DeleteBPMWorkflowDTO

Properties

Name

Type

Required

Restrictions

Description

workflow

Varicent.RESTAPI.v1.DTOs.BPMWorkflowChildNodeDTO

false

none

none

parentFolderRowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "workflow": {
    "workflow": {
      "id": 0,
      "name": "string",
      "description": "string",
      "isSingleInstance": true,
      "workflowState": "Stopped",
      "conditionalVars": [],
      "columnCount": 0,
      "workflowConfig": {},
      "runCount": 0,
      "runDate": "string",
      "runBy": "string",
      "lastActioned": "string",
      "workflowType": "PresenterReport",
      "webReport": {},
      "inquiry": {},
      "bpmWorkflowPresenterFlexReportDTO": {},
      "bpmWorkflowPlanDocPresenterFlexReportDTO": {},
      "assignedReports": [],
      "numReportsAssigned": 0,
      "permissions": {},
      "parentFolder": {},
      "parameters": [],
      "layoutAssignment": {},
      "webReportID": 0,
      "version": {}
    },
    "parentFolderId": 0
  },
  "parentFolderRowVersion": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.DisplaySourceDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

json
{
  "name": "string"
}

Varicent.RESTAPI.v1.DTOs.DocumentDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

name

string¦null

false

none

none

date

string(date-time)

false

none

none

json
{
  "id": 0,
  "name": "string",
  "date": "2019-08-24T14:15:22Z"
}

Varicent.RESTAPI.v1.DTOs.DocumentUploadDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

content

string¦null

false

none

none

portalTreeName

string¦null

false

none

none

uploaderName

string¦null

false

none

none

isInitiatedWorkflow

boolean¦null

false

none

none

json
{
  "name": "string",
  "content": "string",
  "portalTreeName": "string",
  "uploaderName": "string",
  "isInitiatedWorkflow": true
}

Varicent.RESTAPI.v1.DTOs.DuplicateBPMWorkflowDTO

Properties

Name

Type

Required

Restrictions

Description

workflow

Varicent.RESTAPI.v1.DTOs.BPMWorkflowDTO

false

none

none

parentFolderId

integer(int32)

false

none

none

parentFolderRowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

source

integer(int32)

false

none

none

json
{
  "workflow": {
    "id": 0,
    "name": "string",
    "description": "string",
    "isSingleInstance": true,
    "workflowState": "Stopped",
    "conditionalVars": [
      {}
    ],
    "columnCount": 0,
    "workflowConfig": {
      "pendingWorkflowEnabled": true
    },
    "runCount": 0,
    "runDate": "string",
    "runBy": "string",
    "lastActioned": "string",
    "workflowType": "PresenterReport",
    "webReport": {
      "parameters": [],
      "layoutAssignment": {},
      "webReportID": 0
    },
    "inquiry": {
      "hasRun": true,
      "components": []
    },
    "bpmWorkflowPresenterFlexReportDTO": {
      "reportId": 0,
      "parameters": [],
      "objectRestrictions": {}
    },
    "bpmWorkflowPlanDocPresenterFlexReportDTO": {
      "reportId": 0,
      "parameters": [],
      "templateType": "Payee"
    },
    "assignedReports": [
      "string"
    ],
    "numReportsAssigned": 0,
    "permissions": {
      "advanceToken": [],
      "viewDocuments": []
    },
    "parentFolder": {
      "folderID": 0,
      "folderName": "string",
      "rowVersion": {},
      "workflowType": "PresenterReport"
    },
    "parameters": [
      {}
    ],
    "layoutAssignment": {
      "property1": {},
      "property2": {}
    },
    "webReportID": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "parentFolderId": 0,
  "parentFolderRowVersion": {
    "rowVersion": 0
  },
  "source": 0
}

Varicent.RESTAPI.v1.DTOs.ELearningCategoryDTO

Properties

Name

Type

Required

Restrictions

Description

categoryID

string¦null

false

none

none

name

string¦null

false

none

none

parentCategoryID

string¦null

false

none

none

parentName

string¦null

false

none

none

courses

[Varicent.RESTAPI.v1.DTOs.ELearningCourseDTO]¦null

false

none

none

json
{
  "categoryID": "string",
  "name": "string",
  "parentCategoryID": "string",
  "parentName": "string",
  "courses": [
    {
      "courseID": "string",
      "name": "string",
      "description": "string",
      "category": "string"
    }
  ]
}

Varicent.RESTAPI.v1.DTOs.ELearningCourseDTO

Properties

Name

Type

Required

Restrictions

Description

courseID

string¦null

false

none

none

name

string¦null

false

none

none

description

string¦null

false

none

none

category

string¦null

false

none

none

json
{
  "courseID": "string",
  "name": "string",
  "description": "string",
  "category": "string"
}

Varicent.RESTAPI.v1.DTOs.ELearningCoursesInfoDTO

Properties

Name

Type

Required

Restrictions

Description

categories

[Varicent.RESTAPI.v1.DTOs.ELearningCategoryDTO]¦null

false

none

none

json
{
  "categories": [
    {
      "categoryID": "string",
      "name": "string",
      "parentCategoryID": "string",
      "parentName": "string",
      "courses": []
    }
  ]
}

Varicent.RESTAPI.v1.DTOs.ELearningUnitDTO

Properties

Name

Type

Required

Restrictions

Description

unitID

string¦null

false

none

none

name

string¦null

false

none

none

type

string¦null

false

none

none

completionStatus

string¦null

false

none

none

json
{
  "unitID": "string",
  "name": "string",
  "type": "string",
  "completionStatus": "string"
}

Varicent.RESTAPI.v1.DTOs.EditableColumnDTO

Properties

Name

Type

Required

Restrictions

Description

column

Varicent.RESTAPI.v1.DTOs.DataItemDTO

false

none

none

index

integer(int32)

false

none

none

table

string¦null

false

none

none

json
{
  "column": {
    "path": {
      "path": []
    },
    "column": "string",
    "alias": "string"
  },
  "index": 0,
  "table": "string"
}

Varicent.RESTAPI.v1.DTOs.EmailDTO

Properties

Name

Type

Required

Restrictions

Description

severityLevel

integer(int32)

false

none

none

summary

string¦null

false

none

none

description

string¦null

false

none

none

json
{
  "severityLevel": 0,
  "summary": "string",
  "description": "string"
}

Varicent.RESTAPI.v1.DTOs.Exceptions.ErrorListDTO

Properties

Name

Type

Required

Restrictions

Description

errors

integer(int32)

false

none

none

warnings

integer(int32)

false

none

none

messages

[string]¦null

false

none

none

json
{
  "errors": 0,
  "warnings": 0,
  "messages": [
    "string"
  ]
}

Varicent.RESTAPI.v1.DTOs.ExpandableResourceDTO

Properties

Name

Type

Required

Restrictions

Description

href

string¦null

false

none

none

json
{
  "href": "string"
}

Varicent.RESTAPI.v1.DTOs.ExtendedTableCalculatedColumnInfoDTO

Properties

Name

Type

Required

Restrictions

Description

formula

string¦null

false

none

none

json
{
  "formula": "string"
}

Varicent.RESTAPI.v1.DTOs.ExtendedTableColumnInfoDTO

Properties

Name

Type

Required

Restrictions

Description

columnType

string

false

none

none

id

integer(int32)

false

none

none

tableName

string¦null

false

none

none

columnName

string¦null

false

none

none

order

integer(int32)

false

none

none

type

string

false

none

none

lookupColumn

Varicent.RESTAPI.v1.DTOs.ExtendedTableLookupColumnInfoDTO

false

none

none

calculatedColumn

Varicent.RESTAPI.v1.DTOs.ExtendedTableCalculatedColumnInfoDTO

false

none

none

Enumerated Values

Property

Value

columnType

Calc

columnType

Lookup

type

String

type

LongString

type

MaxString

type

Date

type

DateTime

type

Decimal

type

Int

type

Long

type

Float

type

BLOB

type

Identity

type

CLOB

type

RowVersion

type

UID

type

VarCharMax

type

Boolean

json
{
  "columnType": "Calc",
  "id": 0,
  "tableName": "string",
  "columnName": "string",
  "order": 0,
  "type": "String",
  "lookupColumn": {
    "lookupTable": "string",
    "lookupColumnName": "string",
    "lookupColumnMappings": [
      {}
    ]
  },
  "calculatedColumn": {
    "formula": "string"
  }
}

Varicent.RESTAPI.v1.DTOs.ExtendedTableLookupColumnInfoDTO

Properties

Name

Type

Required

Restrictions

Description

lookupTable

string¦null

false

none

none

lookupColumnName

string¦null

false

none

none

lookupColumnMappings

[Varicent.RESTAPI.v1.DTOs.ExtendedTableLookupColumnMappingInfoDTO]¦null

false

none

none

json
{
  "lookupTable": "string",
  "lookupColumnName": "string",
  "lookupColumnMappings": [
    {
      "sourceColumn": "string",
      "destinationColumn": "string",
      "operator": "string",
      "sourceColumnTypeCast": "Text",
      "destinationColumnTypeCast": "Text",
      "matchCase": true
    }
  ]
}

Varicent.RESTAPI.v1.DTOs.ExtendedTableLookupColumnMappingInfoDTO

Properties

Name

Type

Required

Restrictions

Description

sourceColumn

string¦null

false

none

none

destinationColumn

string¦null

false

none

none

operator

string¦null

false

none

none

sourceColumnTypeCast

string¦null

false

none

none

destinationColumnTypeCast

string¦null

false

none

none

matchCase

boolean

false

none

none

Enumerated Values

Property

Value

sourceColumnTypeCast

Text

sourceColumnTypeCast

Date

sourceColumnTypeCast

List

sourceColumnTypeCast

Numeric

sourceColumnTypeCast

Email

sourceColumnTypeCast

Url

sourceColumnTypeCast

Comment

sourceColumnTypeCast

DateTime

destinationColumnTypeCast

Text

destinationColumnTypeCast

Date

destinationColumnTypeCast

List

destinationColumnTypeCast

Numeric

destinationColumnTypeCast

Email

destinationColumnTypeCast

Url

destinationColumnTypeCast

Comment

destinationColumnTypeCast

DateTime

json
{
  "sourceColumn": "string",
  "destinationColumn": "string",
  "operator": "string",
  "sourceColumnTypeCast": "Text",
  "destinationColumnTypeCast": "Text",
  "matchCase": true
}

Varicent.RESTAPI.v1.DTOs.ExternalEmailDTO

Properties

Name

Type

Required

Restrictions

Description

email

string¦null

false

none

none

isCC

boolean

false

none

none

json
{
  "email": "string",
  "isCC": true
}

Varicent.RESTAPI.v1.DTOs.FavoriteFolderDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

folderName

string¦null

false

none

none

parentFolderId

integer(int32)¦null

false

none

none

rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

type

string¦null

false

none

none

Enumerated Values

Property

Value

type

Block

type

Table

type

Calculation

type

Plan

type

TailoredReport

type

WebForm

type

WebReport

type

InputPort

type

OutputPort

type

Library

type

DataStore

type

AssignTable

type

Hub

type

Waypoint

type

InsertionPoint

json
{
  "id": 0,
  "folderName": "string",
  "parentFolderId": 0,
  "rowVersion": {
    "rowVersion": 0
  },
  "type": "Block"
}

Varicent.RESTAPI.v1.DTOs.FileContentDTO

Properties

Name

Type

Required

Restrictions

Description

filename

string¦null

false

none

none

data64

string¦null

false

none

none

json
{
  "filename": "string",
  "data64": "string"
}

Varicent.RESTAPI.v1.DTOs.FixedGridDisplayStyleDTO

Properties

Name

Type

Required

Restrictions

Description

rowStyle

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

none

borderWidth

integer(int32)

false

none

none

displayBorders

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

none

displayPadding

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

none

json
{
  "rowStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "borderWidth": 0,
  "displayBorders": {
    "bottom": {
      "color": {},
      "width": 0.1
    },
    "left": {
      "color": {},
      "width": 0.1
    },
    "right": {
      "color": {},
      "width": 0.1
    },
    "top": {
      "color": {},
      "width": 0.1
    }
  },
  "displayPadding": {
    "bottom": 0.1,
    "left": 0.1,
    "right": 0.1,
    "top": 0.1
  }
}

Varicent.RESTAPI.v1.DTOs.FontDefinitionDTO

Properties

Name

Type

Required

Restrictions

Description

family

string¦null

false

none

none

size

number(float)

false

none

none

unit

string¦null

false

none

none

bold

boolean

false

none

none

italic

boolean

false

none

none

underline

boolean

false

none

none

strikeout

boolean

false

none

none

json
{
  "family": "string",
  "size": 0.1,
  "unit": "string",
  "bold": true,
  "italic": true,
  "underline": true,
  "strikeout": true
}

Varicent.RESTAPI.v1.DTOs.FrameableDTO

Properties

Name

Type

Required

Restrictions

Description

horizontalAlign

string

false

none

none

verticalAlign

string

false

none

none

type

string

false

none

none

childHeightPercents

[number]¦null

false

none

none

childWidthPercents

[number]¦null

false

none

none

frames

[array]¦null

false

none

none

name

string¦null

false

none

none

numColumns

integer(int32)

false

none

none

numRows

integer(int32)

false

none

none

display

Varicent.RESTAPI.v1.DTOs.DataDisplayDTO

false

none

none

Enumerated Values

Property

Value

horizontalAlign

Left

horizontalAlign

Middle

horizontalAlign

Right

verticalAlign

Top

verticalAlign

Middle

verticalAlign

Bottom

type

Frame

type

Content

json
{
  "horizontalAlign": "Left",
  "verticalAlign": "Top",
  "type": "Frame",
  "childHeightPercents": [
    0.1
  ],
  "childWidthPercents": [
    0.1
  ],
  "frames": [
    []
  ],
  "name": "string",
  "numColumns": 0,
  "numRows": 0,
  "display": {
    "gridType": "string",
    "name": "string",
    "source": {
      "name": "string"
    },
    "type": "DataGridDisplay",
    "restrictSource": {
      "name": "string"
    },
    "restrictColumn": "string",
    "style": {
      "displayBorders": {},
      "displayPadding": {}
    },
    "columnMap": {
      "property1": {},
      "property2": {}
    },
    "computedColumns": [
      {}
    ],
    "computedRow": {
      "property1": {},
      "property2": {}
    },
    "dataGridDisplayStyle": {
      "headerStyle": {},
      "evenRowStyle": {},
      "oddRowStyle": {},
      "allowAlternateRowFont": true,
      "isHeaderVerticalAlignmentBottom": true,
      "computedRowStyle": {},
      "borderWidth": 0,
      "displayBorders": {},
      "displayPadding": {}
    },
    "dataGridInputRules": [
      {}
    ],
    "dateFormat": {
      "style": "Date"
    },
    "defaultPageSize": 0,
    "enableExportToExcel": true,
    "enableInquiryCopy": true,
    "enableShowHideColumns": true,
    "freezeTopRow": true,
    "hiddenColumnAliasMap": {
      "property1": "string",
      "property2": "string"
    },
    "hiddenColumns": [
      {}
    ],
    "hiddenInputRowColumnMap": {
      "property1": {},
      "property2": {}
    },
    "inputRowAtTop": true,
    "isVertical": true,
    "numericStyle": {
      "scale": 0,
      "style": "Number"
    },
    "paginated": true,
    "sections": [
      {}
    ],
    "showOnlyInputRow": true,
    "showSectionHeader": true,
    "sortColumns": [
      {}
    ],
    "suppressHeader": true,
    "hideRowBorders": true,
    "disableRowHighlighting": true,
    "suppressRepeatPartitionValues": true,
    "timeId": "string",
    "validationRules": [
      {}
    ],
    "selectedTemplateId": 0,
    "columnWidths": [
      0.1
    ],
    "displays": [
      []
    ],
    "fixedGridDisplayStyle": {
      "rowStyle": {},
      "borderWidth": 0,
      "displayBorders": {},
      "displayPadding": {}
    },
    "imageType": "string",
    "imageLink": {
      "document": "string",
      "openInNewWindow": true,
      "parameters": {},
      "reportId": 0,
      "targetId": 0,
      "targetType": "WebReport",
      "webFormId": 0,
      "webTabId": 0
    },
    "imageId": 0,
    "imageByteArray": "string",
    "hoverText": "string",
    "imageUrl": "string",
    "expiryDate": "2019-08-24T14:15:22Z",
    "cosObjectName": "string",
    "controlDisplayStyle": {
      "style": {},
      "displayBorders": {},
      "displayPadding": {}
    },
    "sortById": true,
    "sortAscending": true,
    "refParameter": "string",
    "nameColumn": "string",
    "idColumn": "string",
    "hideValueForExport": true,
    "hideIdValues": true,
    "scalarDisplayStyle": {
      "style": {},
      "displayBorders": {},
      "displayPadding": {}
    },
    "scalarLink": {
      "document": "string",
      "openInNewWindow": true,
      "parameters": {},
      "reportId": 0,
      "targetId": 0,
      "targetType": "WebReport",
      "webFormId": 0,
      "webTabId": 0
    },
    "text": "string",
    "documentId": 0,
    "buttonDisplayStyle": {
      "style": {},
      "displayBorders": {},
      "displayPadding": {}
    },
    "cellStyle": {
      "alignment": "Justify",
      "backColor": {},
      "font": {},
      "foreColor": {}
    },
    "agreementText": "string",
    "format": {
      "scale": 0,
      "style": "Number"
    },
    "conditionalFormatRule": {
      "formats": []
    },
    "dateDisplayMode": "ShortDate",
    "xAxisName": "string",
    "yAxisName": "string",
    "numberPrefix": "string",
    "numberSuffix": "string",
    "labelOrientation": "Horizontal",
    "hideValues": true,
    "decimalSeparator": "string",
    "thousandSeparator": "string",
    "isPercentage": "string",
    "numDecimals": "string",
    "numberScaling": "string",
    "showTitle": true,
    "yMinMax": true,
    "zMinMax": true,
    "yMin": "string",
    "yMax": "string",
    "zMin": "string",
    "zMax": "string",
    "dontTrimBarLabel": "string",
    "defaultLink": {
      "document": "string",
      "openInNewWindow": true,
      "parameters": {},
      "reportId": 0,
      "targetId": 0,
      "targetType": "WebReport",
      "webFormId": 0,
      "webTabId": 0
    },
    "entityLinkMap": {
      "property1": {},
      "property2": {}
    },
    "fusionSource": {
      "type": "ComboSource",
      "sorted": true,
      "descending": true,
      "sortedByName": true,
      "sourceName": "string",
      "chartLink": {},
      "displayColumn": "string",
      "valueColumn": "string",
      "sourceAlias": "string",
      "sortingInfo": {},
      "xColumn": "string",
      "yColumn": "string",
      "zColumn": "string",
      "renderAs": "Column",
      "isPrimaryAxis": true,
      "entityColumn": "string",
      "sources": [],
      "minValueSourceName": "string",
      "maxValueSourceName": "string",
      "currentValueSourceName": "string",
      "trendpointValueSourceName": "string"
    },
    "fusionStyles": {
      "type": "SingleSeriesChartStyleSet",
      "title": {},
      "xAxisName": {},
      "yAxisName": {},
      "xAxisValues": {},
      "yAxisValues": {},
      "legend": {},
      "syAxisName": {},
      "syAxisValues": {},
      "labels": {},
      "tickValues": {},
      "pointerOrFill": {}
    },
    "fusionTheme": "Classic",
    "height": 0,
    "legendPosition": "Bottom",
    "mapDisplayType": "Afghanistan",
    "mapValueRanges": [
      {}
    ],
    "showLegend": true,
    "width": 0,
    "ssChartDisplayType": "Area2D",
    "chartLink": {
      "document": "string",
      "openInNewWindow": true,
      "parameters": {},
      "reportId": 0,
      "targetId": 0,
      "targetType": "WebReport",
      "webFormId": 0,
      "webTabId": 0
    },
    "customColors": [
      {}
    ],
    "msChartDisplayType": "MSArea",
    "syAxisName": "string",
    "syNumberPrefix": "string",
    "syNumberSuffix": "string",
    "hideSyValues": true,
    "centerValues": true,
    "syDecimalSeparator": "string",
    "syThousandSeparator": "string",
    "isSyPercentage": "string",
    "syNumDecimals": "string",
    "syNumberScaling": "string",
    "lowerLimitDisplayName": "string",
    "upperLimitDisplayName": "string",
    "valueToolTip": "string",
    "gaugeDisplayType": "AngularGauge",
    "link": {
      "document": "string",
      "openInNewWindow": true,
      "parameters": {},
      "reportId": 0,
      "targetId": 0,
      "targetType": "WebReport",
      "webFormId": 0,
      "webTabId": 0
    },
    "limitLabelFillColor": "string",
    "gaugeValueRanges": [
      {}
    ],
    "trendpoint": {
      "label": "string",
      "labelStyle": {},
      "color": {}
    },
    "gaugeStartAngle": 0.1,
    "gaugeEndAngle": 0.1,
    "fillColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "status": "Available",
    "enableHeaders": true,
    "workflowLinkDisplayStyle": {
      "headerStyle": {},
      "primaryStyle": {},
      "secondaryStyle": {},
      "displayBorders": {},
      "displayPadding": {}
    },
    "columns": [
      "WorkflowID"
    ]
  }
}

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

Properties

Name

Type

Required

Restrictions

Description

levelId

string¦null

false

none

none

timeId

string¦null

false

none

none

json
{
  "levelId": "string",
  "timeId": "string"
}

Varicent.RESTAPI.v1.DTOs.FullTableSchemaDTO

Properties

Name

Type

Required

Restrictions

Description

columns

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

none

table

string¦null

false

none

none

name

string¦null

false

none

none

referencedSources

[string]¦null

false

none

none

referencedTimes

[Varicent.RESTAPI.v1.DTOs.FrequencyDTO]¦null

false

none

none

referencedSourcesDictionary

object¦null

false

none

none

» additionalProperties

string

false

none

none

referencedTimesDictionary

object¦null

false

none

none

» additionalProperties

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

none

json
{
  "columns": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "table": "string",
  "name": "string",
  "referencedSources": [
    "string"
  ],
  "referencedTimes": [
    {
      "levelId": "string",
      "timeId": "string"
    }
  ],
  "referencedSourcesDictionary": {
    "property1": "string",
    "property2": "string"
  },
  "referencedTimesDictionary": {
    "property1": {
      "levelId": "string",
      "timeId": "string"
    },
    "property2": {
      "levelId": "string",
      "timeId": "string"
    }
  }
}

Varicent.RESTAPI.v1.DTOs.FullWebUserDTO

Properties

Name

Type

Required

Restrictions

Description

created

string(date-time)

false

none

none

lastLogin

string(date-time)¦null

false

none

none

failedLogOnAttempts

integer(int32)¦null

false

none

none

lastPasswordExpirePrompt

string(date-time)¦null

false

none

none

lastPasswordExpireEmail

string(date-time)¦null

false

none

none

rowVersion

integer(int64)¦null

false

none

none

isWebEnabled

boolean

false

none

none

isLocked

boolean¦null

false

none

none

changePasswordOnNextLogin

boolean¦null

false

none

none

password

string¦null

false

none

none

title

string¦null

false

none

none

email

string¦null

false

none

none

phone

string¦null

false

none

none

reportsTo

string¦null

false

none

none

name

string¦null

false

none

none

id

string¦null

false

none

none

json
{
  "created": "2019-08-24T14:15:22Z",
  "lastLogin": "2019-08-24T14:15:22Z",
  "failedLogOnAttempts": 0,
  "lastPasswordExpirePrompt": "2019-08-24T14:15:22Z",
  "lastPasswordExpireEmail": "2019-08-24T14:15:22Z",
  "rowVersion": 0,
  "isWebEnabled": true,
  "isLocked": true,
  "changePasswordOnNextLogin": true,
  "password": "string",
  "title": "string",
  "email": "string",
  "phone": "string",
  "reportsTo": "string",
  "name": "string",
  "id": "string"
}

Varicent.RESTAPI.v1.DTOs.FullWebUserPatchDTO

Properties

Name

Type

Required

Restrictions

Description

payeeId

string¦null

false

none

none

lastLogin

string(date-time)¦null

false

none

none

failedLogOnAttempts

integer(int32)¦null

false

none

none

isLocked

boolean¦null

false

none

none

changePasswordOnNextLogin

boolean¦null

false

none

none

rowVersion

integer(int64)¦null

false

none

none

json
{
  "payeeId": "string",
  "lastLogin": "2019-08-24T14:15:22Z",
  "failedLogOnAttempts": 0,
  "isLocked": true,
  "changePasswordOnNextLogin": true,
  "rowVersion": 0
}

Varicent.RESTAPI.v1.DTOs.FusionSourceDTO

Properties

Name

Type

Required

Restrictions

Description

type

string

false

none

none

sorted

boolean

false

none

none

descending

boolean

false

none

none

sortedByName

boolean

false

none

none

sourceName

string¦null

false

none

none

chartLink

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

none

displayColumn

string¦null

false

none

none

valueColumn

string¦null

false

none

none

sourceAlias

string¦null

false

none

none

sortingInfo

Varicent.RESTAPI.v1.DTOs.SortingInfoDTO

false

none

none

xColumn

string¦null

false

none

none

yColumn

string¦null

false

none

none

zColumn

string¦null

false

none

none

renderAs

string¦null

false

none

none

isPrimaryAxis

boolean¦null

false

none

none

entityColumn

string¦null

false

none

none

sources

[Varicent.RESTAPI.v1.DTOs.FusionSourceDTO]¦null

false

none

none

minValueSourceName

string¦null

false

none

none

maxValueSourceName

string¦null

false

none

none

currentValueSourceName

string¦null

false

none

none

trendpointValueSourceName

string¦null

false

none

none

Enumerated Values

Property

Value

type

ComboSource

type

DisplayValueSource

type

DYComboSource

type

MapSource

type

MSComboSource

type

MSDisplayValueSource

type

MSDYComboSource

type

MSXYSource

type

MSXYZSource

type

AngularGaugeSource

type

HLinearGaugeSource

type

CylinderGaugeSource

type

XYSource

type

XYZSource

renderAs

Column

renderAs

Area

renderAs

Line

json
{
  "type": "ComboSource",
  "sorted": true,
  "descending": true,
  "sortedByName": true,
  "sourceName": "string",
  "chartLink": {
    "document": "string",
    "openInNewWindow": true,
    "parameters": {
      "property1": {},
      "property2": {}
    },
    "reportId": 0,
    "targetId": 0,
    "targetType": "WebReport",
    "webFormId": 0,
    "webTabId": 0
  },
  "displayColumn": "string",
  "valueColumn": "string",
  "sourceAlias": "string",
  "sortingInfo": {
    "levelId": "string",
    "sortDescending": true,
    "timeId": "string",
    "sortedByName": true
  },
  "xColumn": "string",
  "yColumn": "string",
  "zColumn": "string",
  "renderAs": "Column",
  "isPrimaryAxis": true,
  "entityColumn": "string",
  "sources": [],
  "minValueSourceName": "string",
  "maxValueSourceName": "string",
  "currentValueSourceName": "string",
  "trendpointValueSourceName": "string"
}

Varicent.RESTAPI.v1.DTOs.FusionStyleSetDTO

Properties

Enumerated Values

Property

Value

type

SingleSeriesChartStyleSet

type

MultiSeriesChartStyleSet

type

MapStyleSet

type

GaugeStyleSet

json
{
  "type": "SingleSeriesChartStyleSet",
  "title": {
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    }
  },
  "xAxisName": {
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    }
  },
  "yAxisName": {
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    }
  },
  "xAxisValues": {
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    }
  },
  "yAxisValues": {
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    }
  },
  "legend": {
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    }
  },
  "syAxisName": {
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    }
  },
  "syAxisValues": {
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    }
  },
  "labels": {
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    }
  },
  "tickValues": {
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    }
  },
  "pointerOrFill": {
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    }
  }
}

Varicent.RESTAPI.v1.DTOs.GetDataSourceSchemasDTO

Properties

Name

Type

Required

Restrictions

Description

sourceNames

[string]¦null

false

none

none

depth

integer(int32)

false

none

none

includeExtendedTableColumns

boolean

false

none

none

includeLastUpdatedTrackingColumns

boolean

false

none

none

json
{
  "sourceNames": [
    "string"
  ],
  "depth": 0,
  "includeExtendedTableColumns": true,
  "includeLastUpdatedTrackingColumns": true
}

Varicent.RESTAPI.v1.DTOs.GlobalAction.AggeregateTokenLocksDTO

Properties

Name

Type

Required

Restrictions

Description

numTokens

integer(int32)

false

none

none

hasExclusiveToken

boolean

false

none

none

locks

[Varicent.RESTAPI.v1.DTOs.GlobalAction.TokenLockDTO]¦null

false

none

none

json
{
  "numTokens": 0,
  "hasExclusiveToken": true,
  "locks": [
    {
      "id": 0,
      "objectType": "string",
      "objectName": "string",
      "isReadonly": true
    }
  ]
}

Varicent.RESTAPI.v1.DTOs.GlobalAction.GlobalTokenDTO

Properties

Name

Type

Required

Restrictions

Description

tokenID

integer(int32)

false

none

none

adminID

string¦null

false

none

none

action

string¦null

false

none

none

heldFor

string(date-span)

false

none

none

isExclusive

boolean

false

none

none

locks

[Varicent.RESTAPI.v1.DTOs.GlobalAction.TokenLockDTO]¦null

false

none

none

json
{
  "tokenID": 0,
  "adminID": "string",
  "action": "string",
  "heldFor": "string",
  "isExclusive": true,
  "locks": [
    {
      "id": 0,
      "objectType": "string",
      "objectName": "string",
      "isReadonly": true
    }
  ]
}

Varicent.RESTAPI.v1.DTOs.GlobalAction.TokenLockDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

objectType

string¦null

false

none

none

objectName

string¦null

false

none

none

isReadonly

boolean

false

none

none

json
{
  "id": 0,
  "objectType": "string",
  "objectName": "string",
  "isReadonly": true
}

Varicent.RESTAPI.v1.DTOs.Graph.DirectedGraphNodeDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

value

any

false

none

none

children

object¦null

false

none

none

» additionalProperties

Varicent.RESTAPI.v1.DTOs.Graph.DirectedGraphNodeDTO

false

none

none

json
{
  "id": 0,
  "value": null,
  "children": {}
}

Varicent.RESTAPI.v1.DTOs.GroupItemDTO

Properties

Name

Type

Required

Restrictions

Description

table

string¦null

false

none

none

column

string¦null

false

none

none

json
{
  "table": "string",
  "column": "string"
}

Varicent.RESTAPI.v1.DTOs.IExpandableResourceDTO

Properties

None

json
{}

Varicent.RESTAPI.v1.DTOs.ImageDisplayDTO

Properties

Name

Type

Required

Restrictions

Description

displayBorder

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

none

displayPadding

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

none

gridType

string¦null

false

none

none

hoverText

string¦null

false

none

none

imageByteArray

string(byte)¦null

false

none

none

imageId

integer(int32)

false

none

none

imageLink

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

none

imageType

string¦null

false

none

none

imageUrl

string¦null

false

none

none

expiryDate

string(date-time)¦null

false

none

none

cosObjectName

string¦null

false

none

none

name

string¦null

false

none

none

source

Varicent.RESTAPI.v1.DTOs.DisplaySourceDTO

false

none

none

style

Varicent.RESTAPI.v1.DTOs.DataDisplayStyleDTO

false

none

none

json
{
  "displayBorder": {
    "bottom": {
      "color": {},
      "width": 0.1
    },
    "left": {
      "color": {},
      "width": 0.1
    },
    "right": {
      "color": {},
      "width": 0.1
    },
    "top": {
      "color": {},
      "width": 0.1
    }
  },
  "displayPadding": {
    "bottom": 0.1,
    "left": 0.1,
    "right": 0.1,
    "top": 0.1
  },
  "gridType": "string",
  "hoverText": "string",
  "imageByteArray": "string",
  "imageId": 0,
  "imageLink": {
    "document": "string",
    "openInNewWindow": true,
    "parameters": {
      "property1": {},
      "property2": {}
    },
    "reportId": 0,
    "targetId": 0,
    "targetType": "WebReport",
    "webFormId": 0,
    "webTabId": 0
  },
  "imageType": "string",
  "imageUrl": "string",
  "expiryDate": "2019-08-24T14:15:22Z",
  "cosObjectName": "string",
  "name": "string",
  "source": {
    "name": "string"
  },
  "style": {
    "displayBorders": {
      "bottom": {},
      "left": {},
      "right": {},
      "top": {}
    },
    "displayPadding": {
      "bottom": 0.1,
      "left": 0.1,
      "right": 0.1,
      "top": 0.1
    }
  }
}

Varicent.RESTAPI.v1.DTOs.InputFormColumnDTO

Properties

Name

Type

Required

Restrictions

Description

column

Varicent.RESTAPI.v1.DTOs.ColumnDefinitionDTO

false

none

none

defaultValue

Varicent.RESTAPI.v1.DTOs.DefaultValueDTO

false

none

none

isReadOnly

boolean

false

none

none

alias

string¦null

false

none

none

referenceOptions

[Varicent.RESTAPI.v1.DTOs.ReferenceOptionDTO]¦null

false

none

none

json
{
  "column": {
    "column": {
      "name": "string",
      "type": "Text",
      "referencedTable": "string",
      "referencedName": "string",
      "source": {},
      "pickListParams": [],
      "isKey": true
    },
    "isRemovable": true,
    "isNullable": true,
    "referencedColumn": "string"
  },
  "defaultValue": {
    "table": "string",
    "column": "string",
    "dataType": "Text",
    "value": null,
    "valid": true
  },
  "isReadOnly": true,
  "alias": "string",
  "referenceOptions": [
    {
      "type": "ReferenceOptionInputForm",
      "referencedColumn": "string",
      "isJumpTo": true,
      "tabName": "string",
      "referencedInputFormName": "string",
      "referencedInputFormId": 0,
      "referencedTable": "string"
    }
  ]
}

Varicent.RESTAPI.v1.DTOs.InputFormDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

basedOnTable

string¦null

false

none

none

query

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

columns

[Varicent.RESTAPI.v1.DTOs.InputFormColumnDTO]¦null

false

none

none

rules

[Varicent.RESTAPI.v1.DTOs.ValidationRuleDTO]¦null

false

none

none

name

string¦null

false

none

none

table

Varicent.RESTAPI.v1.DTOs.CustomTableDTO

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "id": 0,
  "basedOnTable": "string",
  "query": {
    "selectItems": [
      {}
    ],
    "source": {
      "namespaceTable": {},
      "query": null,
      "alias": "string",
      "sourceType": "Table"
    },
    "joins": [
      {}
    ],
    "whereClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "order": [
      {}
    ],
    "group": [
      {}
    ],
    "havingClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "distinct": true,
    "unionWith": null,
    "exceptWith": null
  },
  "columns": [
    {
      "column": {},
      "defaultValue": {},
      "isReadOnly": true,
      "alias": "string",
      "referenceOptions": []
    }
  ],
  "rules": [
    {
      "name": "string",
      "table": "string",
      "column": "string",
      "comment": "string",
      "rule": "string",
      "type": "Text"
    }
  ],
  "name": "string",
  "table": {
    "version": {
      "rowVersion": 0
    },
    "name": "string",
    "tableType": "System",
    "effectiveDated": true,
    "workflowObjectID": 0,
    "hierarchyMetadata": {
      "tableName": "string",
      "idColumnName": "string",
      "parentColumnName": "string"
    },
    "lastUpdatedTracking": true
  },
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.InputFormNameDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

currentName

string¦null

false

none

none

basedOnTable

string¦null

false

none

none

json
{
  "id": 0,
  "currentName": "string",
  "basedOnTable": "string"
}

Varicent.RESTAPI.v1.DTOs.InputRowPicklistOptionsDTO

Properties

Name

Type

Required

Restrictions

Description

description

string¦null

false

none

none

order

string

false

none

none

hideKey

boolean

false

none

none

hideDescription

boolean

false

none

none

sortById

boolean

false

none

none

Enumerated Values

Property

Value

order

Ascending

order

Descending

json
{
  "description": "string",
  "order": "Ascending",
  "hideKey": true,
  "hideDescription": true,
  "sortById": true
}

Varicent.RESTAPI.v1.DTOs.InputRuleDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

elementId

integer(int32)

false

none

none

table

string¦null

false

none

none

column

string¦null

false

none

none

operatorType

string

false

none

none

valueType

string

false

none

none

value

any

false

none

none

Enumerated Values

Property

Value

operatorType

LessThan

operatorType

LessThanEquals

operatorType

Equals

operatorType

NotEquals

operatorType

GreaterThan

operatorType

GreaterThanEquals

operatorType

IsNull

operatorType

IsNotNull

valueType

String

valueType

Numeric

valueType

Date

valueType

Field

json
{
  "id": 0,
  "elementId": 0,
  "table": "string",
  "column": "string",
  "operatorType": "LessThan",
  "valueType": "String",
  "value": null
}

Varicent.RESTAPI.v1.DTOs.JoinDTO

Properties

Name

Type

Required

Restrictions

Description

source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

joinType

string

false

none

none

onClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

Enumerated Values

Property

Value

joinType

Inner

joinType

Left

joinType

Right

joinType

Cross

joinType

CrossApply

joinType

OuterApply

json
{
  "source": {
    "namespaceTable": {
      "m_namespace": "string",
      "name": "string"
    },
    "query": null,
    "alias": "string",
    "sourceType": "Table"
  },
  "joinType": "Inner",
  "onClause": {
    "constraintType": "clause",
    "op": "string",
    "dataFieldLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "caseSensitive": true,
    "constraints": [
      {}
    ],
    "literalRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "dataFieldRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "right": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "isPreciseDecimal": true,
    "like": "string",
    "escapeWildcards": true,
    "rowVersion": {
      "rowVersion": 0
    },
    "table": "string",
    "queryDefinitionRight": null
  }
}

Varicent.RESTAPI.v1.DTOs.JumpDestinationDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

destination

string¦null

false

none

none

json
{
  "name": "string",
  "destination": "string"
}

Varicent.RESTAPI.v1.DTOs.LinkDTO

Properties

Name

Type

Required

Restrictions

Description

document

string¦null

false

none

none

openInNewWindow

boolean

false

none

none

parameters

object¦null

false

none

none

» additionalProperties

Varicent.RESTAPI.v1.DTOs.LinkParameterValueDTO

false

none

none

reportId

integer(int32)¦null

false

none

none

targetId

integer(int32)

false

none

none

targetType

string

false

none

none

webFormId

integer(int32)¦null

false

none

none

webTabId

integer(int32)¦null

false

none

none

Enumerated Values

Property

Value

targetType

WebReport

targetType

WebForm

targetType

URL

json
{
  "document": "string",
  "openInNewWindow": true,
  "parameters": {
    "property1": {
      "dataType": "Report",
      "source": "string",
      "type": "Scalar",
      "value": "string"
    },
    "property2": {
      "dataType": "Report",
      "source": "string",
      "type": "Scalar",
      "value": "string"
    }
  },
  "reportId": 0,
  "targetId": 0,
  "targetType": "WebReport",
  "webFormId": 0,
  "webTabId": 0
}

Varicent.RESTAPI.v1.DTOs.LinkParameterValueDTO

Properties

Name

Type

Required

Restrictions

Description

dataType

string

false

none

none

source

string¦null

false

none

none

type

string

false

none

none

value

string¦null

false

none

none

Enumerated Values

Property

Value

dataType

Report

dataType

Form

dataType

String

dataType

DateTime

dataType

Decimal

dataType

Integer

type

Scalar

type

RowValue

type

Constant

json
{
  "dataType": "Report",
  "source": "string",
  "type": "Scalar",
  "value": "string"
}

Varicent.RESTAPI.v1.DTOs.ListViewRowDTO

Properties

Name

Type

Required

Restrictions

Description

compId

integer(int32)

false

none

none

start

string(date-time)¦null

false

none

none

end

string(date-time)¦null

false

none

none

duration

string¦null

false

none

none

inc

string¦null

false

none

none

calcType

string¦null

false

none

none

status

string¦null

false

none

none

numOfCalcs

integer(int32)¦null

false

none

none

calcId

integer(int32)

false

none

none

method

string¦null

false

none

none

calcName

string¦null

false

none

none

json
{
  "compId": 0,
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z",
  "duration": "string",
  "inc": "string",
  "calcType": "string",
  "status": "string",
  "numOfCalcs": 0,
  "calcId": 0,
  "method": "string",
  "calcName": "string"
}

Varicent.RESTAPI.v1.DTOs.LiveActivityDTO

Properties

Name

Type

Required

Restrictions

Description

progressId

integer(int32)

false

none

none

userId

string¦null

false

none

none

type

string

false

none

none

status

string

false

none

none

message

string¦null

false

none

none

time

string(date-time)

false

none

none

messageDetails

string¦null

false

none

none

apiServer

string¦null

false

none

none

percent

integer(int32)

false

none

none

description

string¦null

false

none

none

hasDescription

boolean

false

none

none

expiresAt

string(date-time)

false

none

none

isCancellable

boolean

false

none

none

isInitialization

boolean

false

none

none

computationId

integer(int32)

false

none

none

parentProgressId

integer(int32)¦null

false

none

none

Enumerated Values

Property

Value

type

Calculation

type

Import

type

Library

type

Migration

type

Task

type

Time

type

Optimization

type

Preview

type

BPMWorkflow

type

PurgePeriods

type

MakeEffective

type

Publication

type

Transformation

type

Scheduler

type

ScenarioPromote

type

NotifyUsers

type

HistoryPurge

type

PushAnalyticsData

type

ReapplyTemplate

type

UpdateHistoryTracking

type

ModifyCalendar

type

TableClear

type

IndexRebuild

type

PayeePublication

type

DeleteRows

type

GenerateTasks

type

QueryTool

type

BPMWorkflowAddMember

type

TableAlter

type

Sync

type

ModelEvaluation

type

CalcAndLock

type

Base64Conversion

type

AlterTableAdditionalData

type

BPMInquiryAutoAdjust

type

MaterializedView

type

PresenterReportThumbnail

type

PlanApprovalsPDF

type

CopyPaste

type

CutPaste

type

LGMConvert

type

CDWTableInitialization

type

CDWPopulateTable

type

DMSTransfer

type

PlanDocumentPDF

type

BPMWorkflowRemoveMember

type

ELTRun

type

Replication

status

Running

status

Completed

status

Failed

status

Cancelled

json
{
  "progressId": 0,
  "userId": "string",
  "type": "Calculation",
  "status": "Running",
  "message": "string",
  "time": "2019-08-24T14:15:22Z",
  "messageDetails": "string",
  "apiServer": "string",
  "percent": 0,
  "description": "string",
  "hasDescription": true,
  "expiresAt": "2019-08-24T14:15:22Z",
  "isCancellable": true,
  "isInitialization": true,
  "computationId": 0,
  "parentProgressId": 0
}

Varicent.RESTAPI.v1.DTOs.LookupColumnDTO

Properties

Name

Type

Required

Restrictions

Description

type

string¦null

false

none

none

id

integer(int32)¦null

false

none

none

order

integer(int32)¦null

false

none

none

columnName

string¦null

false

none

none

lookupTable

string¦null

false

none

none

lookupColumn

string¦null

false

none

none

lookupColumnMappings

[Varicent.RESTAPI.v1.DTOs.LookupColumnMappingDTO]¦null

false

none

none

Enumerated Values

Property

Value

type

String

type

LongString

type

MaxString

type

Date

type

DateTime

type

Decimal

type

Int

type

Long

type

Float

type

BLOB

type

Identity

type

CLOB

type

RowVersion

type

UID

type

VarCharMax

type

Boolean

json
{
  "type": "String",
  "id": 0,
  "order": 0,
  "columnName": "string",
  "lookupTable": "string",
  "lookupColumn": "string",
  "lookupColumnMappings": [
    {
      "sourceColumn": "string",
      "destinationColumn": "string",
      "operator": "string",
      "sourceColumnTypeCast": "Text",
      "destinationColumnTypeCast": "Text",
      "matchCase": true
    }
  ]
}

Varicent.RESTAPI.v1.DTOs.LookupColumnMappingDTO

Properties

Name

Type

Required

Restrictions

Description

sourceColumn

string¦null

false

none

none

destinationColumn

string¦null

false

none

none

operator

string¦null

false

none

none

sourceColumnTypeCast

string¦null

false

none

none

destinationColumnTypeCast

string¦null

false

none

none

matchCase

boolean

false

none

none

Enumerated Values

Property

Value

sourceColumnTypeCast

Text

sourceColumnTypeCast

Date

sourceColumnTypeCast

List

sourceColumnTypeCast

Numeric

sourceColumnTypeCast

Email

sourceColumnTypeCast

Url

sourceColumnTypeCast

Comment

sourceColumnTypeCast

DateTime

destinationColumnTypeCast

Text

destinationColumnTypeCast

Date

destinationColumnTypeCast

List

destinationColumnTypeCast

Numeric

destinationColumnTypeCast

Email

destinationColumnTypeCast

Url

destinationColumnTypeCast

Comment

destinationColumnTypeCast

DateTime

json
{
  "sourceColumn": "string",
  "destinationColumn": "string",
  "operator": "string",
  "sourceColumnTypeCast": "Text",
  "destinationColumnTypeCast": "Text",
  "matchCase": true
}

Varicent.RESTAPI.v1.DTOs.Migration.CalendarMappingDTO

Properties

Name

Type

Required

Restrictions

Description

sourceTimeId

string¦null

false

none

none

destinationTimeId

string¦null

false

none

none

levelIdMappings

object¦null

false

none

none

» additionalProperties

string¦null

false

none

none

json
{
  "sourceTimeId": "string",
  "destinationTimeId": "string",
  "levelIdMappings": {
    "property1": "string",
    "property2": "string"
  }
}

Varicent.RESTAPI.v1.DTOs.Migration.MappingInfoDTO

Properties

Name

Type

Required

Restrictions

Description

sourceTables

[Varicent.RESTAPI.v1.DTOs.Migration.SourceTableMappingInfoDTO]¦null

false

none

none

calendars

[Varicent.RESTAPI.v1.DTOs.Time.CalendarDTO]¦null

false

none

none

json
{
  "sourceTables": [
    {
      "destination": "string",
      "source": "string",
      "candidates": []
    }
  ],
  "calendars": [
    {
      "definition": {},
      "tree": {},
      "locked": "string",
      "version": {}
    }
  ]
}

Varicent.RESTAPI.v1.DTOs.Migration.MigratableItemsDTO

Properties

Name

Type

Required

Restrictions

Description

blockIds

[integer]¦null

false

none

none

importNames

[string]¦null

false

none

none

workflowTreeIds

[integer]¦null

false

none

none

webTabIds

[integer]¦null

false

none

none

webFormFilterIds

[integer]¦null

false

none

none

selectedCalendars

[string]¦null

false

none

none

processMaps

[integer]¦null

false

none

none

bpmWorkflows

[integer]¦null

false

none

none

roleIds

[integer]¦null

false

none

none

hierarchyIds

[integer]¦null

false

none

none

presenterFlexReportIds

[integer]¦null

false

none

none

adaptiveFormIds

[integer]¦null

false

none

none

reportDataModelIds

[integer]¦null

false

none

none

planDocumentIds

[integer]¦null

false

none

none

hiddenBpmWorkflowIDs

[integer]¦null

false

none

none

hiddenPresenterFlexReportIDs

[integer]¦null

false

none

none

planBuilderFolderIds

[string]¦null

false

none

none

tableNames

[string]¦null

false

none

none

dataStoreIds

[integer]¦null

false

none

none

requirementIds

[string]¦null

false

none

none

requirementDocumentIds

[string]¦null

false

none

none

reusableLogicToolIds

[string]¦null

false

none

none

json
{
  "blockIds": [
    0
  ],
  "importNames": [
    "string"
  ],
  "workflowTreeIds": [
    0
  ],
  "webTabIds": [
    0
  ],
  "webFormFilterIds": [
    0
  ],
  "selectedCalendars": [
    "string"
  ],
  "processMaps": [
    0
  ],
  "bpmWorkflows": [
    0
  ],
  "roleIds": [
    0
  ],
  "hierarchyIds": [
    0
  ],
  "presenterFlexReportIds": [
    0
  ],
  "adaptiveFormIds": [
    0
  ],
  "reportDataModelIds": [
    0
  ],
  "planDocumentIds": [
    0
  ],
  "hiddenBpmWorkflowIDs": [
    0
  ],
  "hiddenPresenterFlexReportIDs": [
    0
  ],
  "planBuilderFolderIds": [
    "string"
  ],
  "tableNames": [
    "string"
  ],
  "dataStoreIds": [
    0
  ],
  "requirementIds": [
    "string"
  ],
  "requirementDocumentIds": [
    "string"
  ],
  "reusableLogicToolIds": [
    "string"
  ]
}

Varicent.RESTAPI.v1.DTOs.Migration.MigrationComparisonDataDTO

Properties

Name

Type

Required

Restrictions

Description

duplicateItemNameLocal

boolean

false

none

none

duplicateItemNameSource

boolean

false

none

none

localSchedulerFolders

[Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO]¦null

false

none

none

migrationItemsMap

object¦null

false

none

none

» WebReports

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» WebForms

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» WebFormFilters

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» Tables

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» TaskGroups

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» Views

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» Imports

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» Accounts

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» Calendars

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» Calculations

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» PayeeIDs

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» Plans

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» TailoredReports

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» WorkflowGroups

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» WorkflowTrees

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» ComposerBlocks

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» ComposerPorts

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» WebTabs

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» Roles

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» Users

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» ProcessMap

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» DataStores

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» BPMWorkflows

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» BPMSwimLanes

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» BPMNodes

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» BPMComponents

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» InputForms

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» Pulse

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» Hierarchies

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» PresenterFlexReports

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» AdaptiveForms

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» ExtendedTableColumns

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» ReportDataModels

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» PlanDocuments

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» PlanBuilderFolders

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» PlanBuilderTableReferences

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» PlanBuilderCalculationItems

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» Requirements

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» RequirementDocuments

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

» ReusableLogicTools

[Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO]

false

none

none

payeeGroupsRequired

[[System.Collections.Generic.KeyValuePair2[System.String,System.String]](#schemasystem.collections.generic.keyvaluepair2[system.string,system.string])]¦null

false

none

none

revisions

Varicent.RESTAPI.v1.DTOs.Migration.RevisionsDTO

false

none

none

json
{
  "duplicateItemNameLocal": true,
  "duplicateItemNameSource": true,
  "localSchedulerFolders": [
    {
      "id": 0,
      "name": "string",
      "scheduleItemType": "Folder",
      "order": 0,
      "lastRun": "2019-08-24T14:15:22Z",
      "lastRunStatus": "Success",
      "activation": "Enabled",
      "nextRun": "2019-08-24T14:15:22Z",
      "parent": 0,
      "scheduledTime": {},
      "parentItem": null,
      "childScheduleItems": [],
      "settings": {},
      "version": {},
      "previousName": "string",
      "runInParallel": true,
      "externalItemID": "string",
      "ptzId": "string"
    }
  ],
  "migrationItemsMap": {
    "WebReports": [
      {}
    ],
    "WebForms": [
      {}
    ],
    "WebFormFilters": [
      {}
    ],
    "Tables": [
      {}
    ],
    "TaskGroups": [
      {}
    ],
    "Views": [
      {}
    ],
    "Imports": [
      {}
    ],
    "Accounts": [
      {}
    ],
    "Calendars": [
      {}
    ],
    "Calculations": [
      {}
    ],
    "PayeeIDs": [
      {}
    ],
    "Plans": [
      {}
    ],
    "TailoredReports": [
      {}
    ],
    "WorkflowGroups": [
      {}
    ],
    "WorkflowTrees": [
      {}
    ],
    "ComposerBlocks": [
      {}
    ],
    "ComposerPorts": [
      {}
    ],
    "WebTabs": [
      {}
    ],
    "Roles": [
      {}
    ],
    "Users": [
      {}
    ],
    "ProcessMap": [
      {}
    ],
    "DataStores": [
      {}
    ],
    "BPMWorkflows": [
      {}
    ],
    "BPMSwimLanes": [
      {}
    ],
    "BPMNodes": [
      {}
    ],
    "BPMComponents": [
      {}
    ],
    "InputForms": [
      {}
    ],
    "Pulse": [
      {}
    ],
    "Hierarchies": [
      {}
    ],
    "PresenterFlexReports": [
      {}
    ],
    "AdaptiveForms": [
      {}
    ],
    "ExtendedTableColumns": [
      {}
    ],
    "ReportDataModels": [
      {}
    ],
    "PlanDocuments": [
      {}
    ],
    "PlanBuilderFolders": [
      {}
    ],
    "PlanBuilderTableReferences": [
      {}
    ],
    "PlanBuilderCalculationItems": [
      {}
    ],
    "Requirements": [
      {}
    ],
    "RequirementDocuments": [
      {}
    ],
    "ReusableLogicTools": [
      {}
    ]
  },
  "payeeGroupsRequired": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "revisions": {
    "source": 0,
    "destination": 0
  }
}

Varicent.RESTAPI.v1.DTOs.Migration.MigrationComparisonDataQueryDTO

Properties

Name

Type

Required

Restrictions

Description

calendarMappingInfo

[Varicent.RESTAPI.v1.DTOs.Migration.CalendarMappingDTO]¦null

false

none

none

sourceTableMappingInfo

[Varicent.RESTAPI.v1.DTOs.Migration.SourceTableMappingInfoDTO]¦null

false

none

none

overwrite

boolean

false

none

none

model

string¦null

false

none

none

items

Varicent.RESTAPI.v1.DTOs.Migration.MigratableItemsDTO

false

none

none

json
{
  "calendarMappingInfo": [
    {
      "sourceTimeId": "string",
      "destinationTimeId": "string",
      "levelIdMappings": {}
    }
  ],
  "sourceTableMappingInfo": [
    {
      "destination": "string",
      "source": "string",
      "candidates": []
    }
  ],
  "overwrite": true,
  "model": "string",
  "items": {
    "blockIds": [
      0
    ],
    "importNames": [
      "string"
    ],
    "workflowTreeIds": [
      0
    ],
    "webTabIds": [
      0
    ],
    "webFormFilterIds": [
      0
    ],
    "selectedCalendars": [
      "string"
    ],
    "processMaps": [
      0
    ],
    "bpmWorkflows": [
      0
    ],
    "roleIds": [
      0
    ],
    "hierarchyIds": [
      0
    ],
    "presenterFlexReportIds": [
      0
    ],
    "adaptiveFormIds": [
      0
    ],
    "reportDataModelIds": [
      0
    ],
    "planDocumentIds": [
      0
    ],
    "hiddenBpmWorkflowIDs": [
      0
    ],
    "hiddenPresenterFlexReportIDs": [
      0
    ],
    "planBuilderFolderIds": [
      "string"
    ],
    "tableNames": [
      "string"
    ],
    "dataStoreIds": [
      0
    ],
    "requirementIds": [
      "string"
    ],
    "requirementDocumentIds": [
      "string"
    ],
    "reusableLogicToolIds": [
      "string"
    ]
  }
}

Varicent.RESTAPI.v1.DTOs.Migration.MigrationItemDTO

Properties

Name

Type

Required

Restrictions

Description

messages

[string]¦null

false

none

none

type

string

false

none

none

name

string¦null

false

none

none

status

string

false

none

none

source

any

false

none

none

Enumerated Values

Property

Value

type

Information

type

Conflicts

status

New

status

Exists

status

Conflicted

status

Modifying

status

Invalid

status

Overwriting

status

Deleting

status

Remapping

status

Required

status

InvalidLink

status

OverwritingInvalidLink

json
{
  "messages": [
    "string"
  ],
  "type": "Information",
  "name": "string",
  "status": "New",
  "source": null
}

Varicent.RESTAPI.v1.DTOs.Migration.MigrationRequiredMappingsQueryDTO

Properties

Name

Type

Required

Restrictions

Description

model

string¦null

false

none

none

items

Varicent.RESTAPI.v1.DTOs.Migration.MigratableItemsDTO

false

none

none

json
{
  "model": "string",
  "items": {
    "blockIds": [
      0
    ],
    "importNames": [
      "string"
    ],
    "workflowTreeIds": [
      0
    ],
    "webTabIds": [
      0
    ],
    "webFormFilterIds": [
      0
    ],
    "selectedCalendars": [
      "string"
    ],
    "processMaps": [
      0
    ],
    "bpmWorkflows": [
      0
    ],
    "roleIds": [
      0
    ],
    "hierarchyIds": [
      0
    ],
    "presenterFlexReportIds": [
      0
    ],
    "adaptiveFormIds": [
      0
    ],
    "reportDataModelIds": [
      0
    ],
    "planDocumentIds": [
      0
    ],
    "hiddenBpmWorkflowIDs": [
      0
    ],
    "hiddenPresenterFlexReportIDs": [
      0
    ],
    "planBuilderFolderIds": [
      "string"
    ],
    "tableNames": [
      "string"
    ],
    "dataStoreIds": [
      0
    ],
    "requirementIds": [
      "string"
    ],
    "requirementDocumentIds": [
      "string"
    ],
    "reusableLogicToolIds": [
      "string"
    ]
  }
}

Varicent.RESTAPI.v1.DTOs.Migration.ProcessMapTaskLinkMappingDTO

Properties

Name

Type

Required

Restrictions

Description

taskId

integer(int32)

false

none

none

processMapId

integer(int32)

false

none

none

linkName

string¦null

false

none

none

url

Varicent.RESTAPI.v1.DTOs.VaricentUrlDTO

false

none

none

json
{
  "taskId": 0,
  "processMapId": 0,
  "linkName": "string",
  "url": {
    "moduleType": "home",
    "actionType": "None",
    "elementType": "none",
    "moduleTab": "string",
    "args": {
      "property1": "string",
      "property2": "string"
    }
  }
}

Varicent.RESTAPI.v1.DTOs.Migration.RevisionsDTO

Properties

Name

Type

Required

Restrictions

Description

source

integer(int32)

false

none

none

destination

integer(int32)

false

none

none

json
{
  "source": 0,
  "destination": 0
}

Varicent.RESTAPI.v1.DTOs.Migration.RunMigrationQueryDTO

Properties

Name

Type

Required

Restrictions

Description

payeeGroupMapping

object¦null

false

none

none

» additionalProperties

string

false

none

none

processMapTaskLinkMappingInfo

[Varicent.RESTAPI.v1.DTOs.Migration.ProcessMapTaskLinkMappingDTO]¦null

false

none

none

revisions

Varicent.RESTAPI.v1.DTOs.Migration.RevisionsDTO

false

none

none

calendarMappingInfo

[Varicent.RESTAPI.v1.DTOs.Migration.CalendarMappingDTO]¦null

false

none

none

sourceTableMappingInfo

[Varicent.RESTAPI.v1.DTOs.Migration.SourceTableMappingInfoDTO]¦null

false

none

none

overwrite

boolean

false

none

none

model

string¦null

false

none

none

items

Varicent.RESTAPI.v1.DTOs.Migration.MigratableItemsDTO

false

none

none

json
{
  "payeeGroupMapping": {
    "property1": "string",
    "property2": "string"
  },
  "processMapTaskLinkMappingInfo": [
    {
      "taskId": 0,
      "processMapId": 0,
      "linkName": "string",
      "url": {}
    }
  ],
  "revisions": {
    "source": 0,
    "destination": 0
  },
  "calendarMappingInfo": [
    {
      "sourceTimeId": "string",
      "destinationTimeId": "string",
      "levelIdMappings": {}
    }
  ],
  "sourceTableMappingInfo": [
    {
      "destination": "string",
      "source": "string",
      "candidates": []
    }
  ],
  "overwrite": true,
  "model": "string",
  "items": {
    "blockIds": [
      0
    ],
    "importNames": [
      "string"
    ],
    "workflowTreeIds": [
      0
    ],
    "webTabIds": [
      0
    ],
    "webFormFilterIds": [
      0
    ],
    "selectedCalendars": [
      "string"
    ],
    "processMaps": [
      0
    ],
    "bpmWorkflows": [
      0
    ],
    "roleIds": [
      0
    ],
    "hierarchyIds": [
      0
    ],
    "presenterFlexReportIds": [
      0
    ],
    "adaptiveFormIds": [
      0
    ],
    "reportDataModelIds": [
      0
    ],
    "planDocumentIds": [
      0
    ],
    "hiddenBpmWorkflowIDs": [
      0
    ],
    "hiddenPresenterFlexReportIDs": [
      0
    ],
    "planBuilderFolderIds": [
      "string"
    ],
    "tableNames": [
      "string"
    ],
    "dataStoreIds": [
      0
    ],
    "requirementIds": [
      "string"
    ],
    "requirementDocumentIds": [
      "string"
    ],
    "reusableLogicToolIds": [
      "string"
    ]
  }
}

Varicent.RESTAPI.v1.DTOs.Migration.SourceTableMappingInfoDTO

Properties

Name

Type

Required

Restrictions

Description

destination

string¦null

false

none

none

source

string¦null

false

none

none

candidates

[string]¦null

false

none

none

json
{
  "destination": "string",
  "source": "string",
  "candidates": [
    "string"
  ]
}

Varicent.RESTAPI.v1.DTOs.MoveFavoriteDTO

Properties

Name

Type

Required

Restrictions

Description

originOrder

integer(int32)

false

none

none

originNodeId

integer(int32)

false

none

none

destinationOrder

integer(int32)

false

none

none

destinationNodeId

integer(int32)

false

none

none

json
{
  "originOrder": 0,
  "originNodeId": 0,
  "destinationOrder": 0,
  "destinationNodeId": 0
}

Varicent.RESTAPI.v1.DTOs.NavigationCalculationElementDTO

Properties

Name

Type

Required

Restrictions

Description

parentBlockId

integer(int32)

false

none

none

elementId

integer(int32)

false

none

none

calculationId

integer(int32)

false

none

none

calculationType

string¦null

false

none

none

name

string¦null

false

none

none

comment

string¦null

false

none

none

isFavourite

boolean

false

none

none

sourceTables

[string]¦null

false

none

none

json
{
  "parentBlockId": 0,
  "elementId": 0,
  "calculationId": 0,
  "calculationType": "string",
  "name": "string",
  "comment": "string",
  "isFavourite": true,
  "sourceTables": [
    "string"
  ]
}

Varicent.RESTAPI.v1.DTOs.NavigationDataStoreElementDTO

Properties

Name

Type

Required

Restrictions

Description

parentBlockId

integer(int32)

false

none

none

id

integer(int32)

false

none

none

name

string¦null

false

none

none

isFavorite

boolean

false

none

none

json
{
  "parentBlockId": 0,
  "id": 0,
  "name": "string",
  "isFavorite": true
}

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

Properties

Name

Type

Required

Restrictions

Description

scale

integer(int32)

false

none

none

style

string

false

none

none

Enumerated Values

Property

Value

style

Number

style

Percent

style

Dollars

style

FrenchCanadianDollars

style

Pounds

style

Euro

style

Yen

style

Yuan

style

Rand

style

BrazilianReal

style

Rupee

style

SingaporeanDollar

style

AustralianDollar

style

Won

json
{
  "scale": 0,
  "style": "Number"
}

Varicent.RESTAPI.v1.DTOs.OrderItemDTO

Properties

Name

Type

Required

Restrictions

Description

table

string¦null

false

none

none

column

string¦null

false

none

none

direction

string

false

none

none

Enumerated Values

Property

Value

direction

Ascending

direction

Descending

direction

AscendingNullsFirst

direction

DescendingNullsLast

json
{
  "table": "string",
  "column": "string",
  "direction": "Ascending"
}

Varicent.RESTAPI.v1.DTOs.PRDateFormatDTO

Properties

Name

Type

Required

Restrictions

Description

style

string

false

none

none

Enumerated Values

Property

Value

style

Date

style

DateTime

json
{
  "style": "Date"
}

Varicent.RESTAPI.v1.DTOs.PaddingDTO

Properties

Name

Type

Required

Restrictions

Description

bottom

number(float)

false

none

none

left

number(float)

false

none

none

right

number(float)

false

none

none

top

number(float)

false

none

none

json
{
  "bottom": 0.1,
  "left": 0.1,
  "right": 0.1,
  "top": 0.1
}

Varicent.RESTAPI.v1.DTOs.PasswordInformationDTO

Properties

Name

Type

Required

Restrictions

Description

password

string¦null

false

none

none

salt

string¦null

false

none

none

encryption

string

false

none

none

Enumerated Values

Property

Value

encryption

Version1

encryption

Version2

encryption

Version3

json
{
  "password": "string",
  "salt": "string",
  "encryption": "Version1"
}

Varicent.RESTAPI.v1.DTOs.Payee.GroupMemberDTO

Properties

Name

Type

Required

Restrictions

Description

payeeId

string¦null

false

none

none

name

string¦null

false

none

none

starting

string(date-time)

false

none

none

ending

string(date-time)

false

none

none

json
{
  "payeeId": "string",
  "name": "string",
  "starting": "2019-08-24T14:15:22Z",
  "ending": "2019-08-24T14:15:22Z"
}

Varicent.RESTAPI.v1.DTOs.Payee.PayeeGroupDTO

Properties

Name

Type

Required

Restrictions

Description

group

Varicent.RESTAPI.v1.DTOs.Payee.PayeeGroupNameDTO

false

none

none

members

[Varicent.RESTAPI.v1.DTOs.Payee.GroupMemberDTO]¦null

false

none

none

json
{
  "group": {
    "name": "string",
    "id": "string"
  },
  "members": [
    {
      "payeeId": "string",
      "name": "string",
      "starting": "2019-08-24T14:15:22Z",
      "ending": "2019-08-24T14:15:22Z"
    }
  ]
}

Varicent.RESTAPI.v1.DTOs.Payee.PayeeGroupDatesDTO

Properties

Name

Type

Required

Restrictions

Description

group

Varicent.RESTAPI.v1.DTOs.Payee.PayeeGroupNameDTO

false

none

none

payeeID

string¦null

false

none

none

start

string(date-time)

false

none

none

end

string(date-time)

false

none

none

startUpdated

string(date-time)

false

none

none

endUpdated

string(date-time)

false

none

none

json
{
  "group": {
    "name": "string",
    "id": "string"
  },
  "payeeID": "string",
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z",
  "startUpdated": "2019-08-24T14:15:22Z",
  "endUpdated": "2019-08-24T14:15:22Z"
}

Varicent.RESTAPI.v1.DTOs.Payee.PayeeGroupDefinitionDTO

Properties

Name

Type

Required

Restrictions

Description

group

Varicent.RESTAPI.v1.DTOs.Payee.PayeeGroupNameDTO

false

none

none

query

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

start

string(date-time)

false

none

none

end

string(date-time)

false

none

none

excludeList

[string]¦null

false

none

none

json
{
  "group": {
    "name": "string",
    "id": "string"
  },
  "query": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z",
  "excludeList": [
    "string"
  ]
}

Varicent.RESTAPI.v1.DTOs.Payee.PayeeGroupNameDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

id

string¦null

false

none

none

json
{
  "name": "string",
  "id": "string"
}

Varicent.RESTAPI.v1.DTOs.PayeeDetailsDTO

Properties

Name

Type

Required

Restrictions

Description

title

string¦null

false

none

none

email

string¦null

false

none

none

phone

string¦null

false

none

none

reportsTo

string¦null

false

none

none

name

string¦null

false

none

none

id

string¦null

false

none

none

json
{
  "title": "string",
  "email": "string",
  "phone": "string",
  "reportsTo": "string",
  "name": "string",
  "id": "string"
}

Varicent.RESTAPI.v1.DTOs.PayeeDetailsEffectiveDatedDTO

Properties

Name

Type

Required

Restrictions

Description

effectiveDatedInfo

Varicent.RESTAPI.v1.DTOs.PayeeEffectiveDatedInfoDTO

false

none

none

email

string¦null

false

none

none

reportsTo

string¦null

false

none

none

dateOfHire

string(date-time)¦null

false

none

none

terminationDate

string(date-time)¦null

false

none

none

name

string¦null

false

none

none

id

string¦null

false

none

none

json
{
  "effectiveDatedInfo": {
    "id": "string",
    "payeeID": "string",
    "currencyID": "string",
    "titleID": "string",
    "statusID": "string",
    "countryID": "string",
    "salary": 0.1,
    "payeeTypeID": "string",
    "effectiveStart": "2019-08-24T14:15:22Z",
    "effectiveEnd": "2019-08-24T14:15:22Z"
  },
  "email": "string",
  "reportsTo": "string",
  "dateOfHire": "2019-08-24T14:15:22Z",
  "terminationDate": "2019-08-24T14:15:22Z",
  "name": "string",
  "id": "string"
}

Varicent.RESTAPI.v1.DTOs.PayeeDocumentDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

name

string¦null

false

none

none

created

string(date-time)

false

none

none

treeName

string¦null

false

none

none

payeeID

string¦null

false

none

none

token

string¦null

false

none

none

json
{
  "id": 0,
  "name": "string",
  "created": "2019-08-24T14:15:22Z",
  "treeName": "string",
  "payeeID": "string",
  "token": "string"
}

Varicent.RESTAPI.v1.DTOs.PayeeDocumentUploadDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

content

string¦null

false

none

none

portalTreeName

string¦null

false

none

none

token

string¦null

false

none

none

generateToken

boolean

false

none

none

payeeID

string¦null

false

none

none

json
{
  "name": "string",
  "content": "string",
  "portalTreeName": "string",
  "token": "string",
  "generateToken": true,
  "payeeID": "string"
}

Varicent.RESTAPI.v1.DTOs.PayeeEffectiveDatedInfoDTO

Properties

Name

Type

Required

Restrictions

Description

id

string¦null

false

none

none

payeeID

string¦null

false

none

none

currencyID

string¦null

false

none

none

titleID

string¦null

false

none

none

statusID

string¦null

false

none

none

countryID

string¦null

false

none

none

salary

number(double)

false

none

none

payeeTypeID

string¦null

false

none

none

effectiveStart

string(date-time)

false

none

none

effectiveEnd

string(date-time)¦null

false

none

none

json
{
  "id": "string",
  "payeeID": "string",
  "currencyID": "string",
  "titleID": "string",
  "statusID": "string",
  "countryID": "string",
  "salary": 0.1,
  "payeeTypeID": "string",
  "effectiveStart": "2019-08-24T14:15:22Z",
  "effectiveEnd": "2019-08-24T14:15:22Z"
}

Varicent.RESTAPI.v1.DTOs.PayeeImageDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

payeeID

string¦null

false

none

none

image

string(byte)¦null

false

none

none

json
{
  "name": "string",
  "payeeID": "string",
  "image": "string"
}

Varicent.RESTAPI.v1.DTOs.PayeeIndepthDetailsDTO

Properties

Name

Type

Required

Restrictions

Description

title

string¦null

false

none

none

reportsToPayee

Varicent.RESTAPI.v1.DTOs.PayeeIndepthDetailsDTO

false

none

none

payeeProfilePicture

string(byte)¦null

false

none

none

groupIds

[integer]¦null

false

none

none

groupNames

[string]¦null

false

none

none

name

string¦null

false

none

none

id

string¦null

false

none

none

json
{
  "title": "string",
  "reportsToPayee": null,
  "payeeProfilePicture": "string",
  "groupIds": [
    0
  ],
  "groupNames": [
    "string"
  ],
  "name": "string",
  "id": "string"
}

Varicent.RESTAPI.v1.DTOs.PayeeNameDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

id

string¦null

false

none

none

json
{
  "name": "string",
  "id": "string"
}

Varicent.RESTAPI.v1.DTOs.PayeePersonalDetailsDTO

Properties

Name

Type

Required

Restrictions

Description

email

string¦null

false

none

none

reportsTo

string¦null

false

none

none

dateOfHire

string(date-time)¦null

false

none

none

terminationDate

string(date-time)¦null

false

none

none

name

string¦null

false

none

none

id

string¦null

false

none

none

json
{
  "email": "string",
  "reportsTo": "string",
  "dateOfHire": "2019-08-24T14:15:22Z",
  "terminationDate": "2019-08-24T14:15:22Z",
  "name": "string",
  "id": "string"
}

Varicent.RESTAPI.v1.DTOs.PayeeProfilePictureDTO

Properties

Name

Type

Required

Restrictions

Description

payeeID

string¦null

false

none

none

image

string(byte)¦null

false

none

none

json
{
  "payeeID": "string",
  "image": "string"
}

Varicent.RESTAPI.v1.DTOs.PayeeTitleDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

title

string¦null

false

none

none

json
{
  "name": "string",
  "title": "string"
}

Varicent.RESTAPI.v1.DTOs.PayeeTypeMoveDTO

Properties

Name

Type

Required

Restrictions

Description

payeeID

string¦null

false

none

none

from

string¦null

false

none

none

to

string¦null

false

none

none

json
{
  "payeeID": "string",
  "from": "string",
  "to": "string"
}

Varicent.RESTAPI.v1.DTOs.PayeeWebSalesforceAuthDTO

Properties

Name

Type

Required

Restrictions

Description

sessionID

string¦null

false

none

none

hostname

string¦null

false

none

none

serverURL

string¦null

false

none

none

json
{
  "sessionID": "string",
  "hostname": "string",
  "serverURL": "string"
}

Varicent.RESTAPI.v1.DTOs.People.TeamDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)¦null

false

none

none

name

string¦null

false

none

none

isActive

boolean

false

none

none

isFavorite

boolean

false

none

none

plans

[Varicent.RESTAPI.v1.DTOs.Plans.PlanDTO]¦null

false

none

none

payees

[Varicent.RESTAPI.v1.DTOs.PayeeNameDTO]¦null

false

none

none

json
{
  "id": 0,
  "name": "string",
  "isActive": true,
  "isFavorite": true,
  "plans": [
    {
      "id": 0,
      "name": "string",
      "isFavorite": true,
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "description": "string"
    }
  ],
  "payees": [
    {
      "name": "string",
      "id": "string"
    }
  ]
}

Varicent.RESTAPI.v1.DTOs.People.TeamPayeeAssignmentDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)¦null

false

none

none

teamId

integer(int32)¦null

false

none

none

payeeId

string¦null

false

none

none

role

string¦null

false

none

none

startDate

string(date-time)¦null

false

none

none

endDate

string(date-time)¦null

false

none

none

isFavorite

boolean

false

none

none

json
{
  "id": 0,
  "teamId": 0,
  "payeeId": "string",
  "role": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "isFavorite": true
}

Varicent.RESTAPI.v1.DTOs.People.TeamPayeeDetailsDTO

Properties

Name

Type

Required

Restrictions

Description

teamId

integer(int32)

false

none

none

role

string¦null

false

none

none

startDate

string(date-time)

false

none

none

endDate

string(date-time)

false

none

none

isFavorite

boolean

false

none

none

payeeCurrency

string¦null

false

none

none

dateOfHire

string(date-time)¦null

false

none

none

terminationDate

string(date-time)¦null

false

none

none

title

string¦null

false

none

none

email

string¦null

false

none

none

phone

string¦null

false

none

none

reportsTo

string¦null

false

none

none

name

string¦null

false

none

none

id

string¦null

false

none

none

json
{
  "teamId": 0,
  "role": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "isFavorite": true,
  "payeeCurrency": "string",
  "dateOfHire": "2019-08-24T14:15:22Z",
  "terminationDate": "2019-08-24T14:15:22Z",
  "title": "string",
  "email": "string",
  "phone": "string",
  "reportsTo": "string",
  "name": "string",
  "id": "string"
}

Varicent.RESTAPI.v1.DTOs.People.TeamPayeeDetailsEffectiveDatedDTO

Properties

Name

Type

Required

Restrictions

Description

teamPayeeAssignment

Varicent.RESTAPI.v1.DTOs.People.TeamPayeeAssignmentDTO

false

none

none

effectiveDatedInfo

Varicent.RESTAPI.v1.DTOs.PayeeEffectiveDatedInfoDTO

false

none

none

email

string¦null

false

none

none

reportsTo

string¦null

false

none

none

dateOfHire

string(date-time)¦null

false

none

none

terminationDate

string(date-time)¦null

false

none

none

name

string¦null

false

none

none

id

string¦null

false

none

none

json
{
  "teamPayeeAssignment": {
    "id": 0,
    "teamId": 0,
    "payeeId": "string",
    "role": "string",
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "isFavorite": true
  },
  "effectiveDatedInfo": {
    "id": "string",
    "payeeID": "string",
    "currencyID": "string",
    "titleID": "string",
    "statusID": "string",
    "countryID": "string",
    "salary": 0.1,
    "payeeTypeID": "string",
    "effectiveStart": "2019-08-24T14:15:22Z",
    "effectiveEnd": "2019-08-24T14:15:22Z"
  },
  "email": "string",
  "reportsTo": "string",
  "dateOfHire": "2019-08-24T14:15:22Z",
  "terminationDate": "2019-08-24T14:15:22Z",
  "name": "string",
  "id": "string"
}

Varicent.RESTAPI.v1.DTOs.People.TeamPlanAssignmentDTO

Properties

Name

Type

Required

Restrictions

Description

teamId

integer(int32)

false

none

none

planId

integer(int32)

false

none

none

startDate

string(date-time)

false

none

none

endDate

string(date-time)¦null

false

none

none

json
{
  "teamId": 0,
  "planId": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z"
}

Varicent.RESTAPI.v1.DTOs.PickListControlDTO

Properties

Name

Type

Required

Restrictions

Description

displayBorders

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

none

displayPadding

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

none

displayTypeLabel

string¦null

false

none

none

fontstyle

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

none

gridtype

string¦null

false

none

none

hideIdValues

boolean

false

none

none

hideValueForExport

boolean

false

none

none

idColumn

string¦null

false

none

none

name

string¦null

false

none

none

nameColumn

string¦null

false

none

none

refParameter

string¦null

false

none

none

sortascending

boolean

false

none

none

sortById

boolean

false

none

none

source

Varicent.RESTAPI.v1.DTOs.DisplaySourceDTO

false

none

none

style

Varicent.RESTAPI.v1.DTOs.ControlDisplayStyleDTO

false

none

none

json
{
  "displayBorders": {
    "bottom": {
      "color": {},
      "width": 0.1
    },
    "left": {
      "color": {},
      "width": 0.1
    },
    "right": {
      "color": {},
      "width": 0.1
    },
    "top": {
      "color": {},
      "width": 0.1
    }
  },
  "displayPadding": {
    "bottom": 0.1,
    "left": 0.1,
    "right": 0.1,
    "top": 0.1
  },
  "displayTypeLabel": "string",
  "fontstyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "gridtype": "string",
  "hideIdValues": true,
  "hideValueForExport": true,
  "idColumn": "string",
  "name": "string",
  "nameColumn": "string",
  "refParameter": "string",
  "sortascending": true,
  "sortById": true,
  "source": {
    "name": "string"
  },
  "style": {
    "style": {
      "alignment": "Justify",
      "backColor": {},
      "font": {},
      "foreColor": {}
    },
    "displayBorders": {
      "bottom": {},
      "left": {},
      "right": {},
      "top": {}
    },
    "displayPadding": {
      "bottom": 0.1,
      "left": 0.1,
      "right": 0.1,
      "top": 0.1
    }
  }
}

Varicent.RESTAPI.v1.DTOs.PickListParamDTO

Properties

Name

Type

Required

Restrictions

Description

joinAlias

string¦null

false

none

none

joinColumn

string¦null

false

none

none

op

string

false

none

none

Enumerated Values

Property

Value

op

LessThan

op

LessThanEquals

op

Equals

op

NotEquals

op

GreaterThan

op

GreaterThanEquals

op

IsNull

op

IsNotNull

op

In

op

NotIn

json
{
  "joinAlias": "string",
  "joinColumn": "string",
  "op": "LessThan"
}

Varicent.RESTAPI.v1.DTOs.PlanBuilderCalculationEventDTO

Properties

Name

Type

Required

Restrictions

Description

computationEventID

integer(int32)

false

none

none

computationID

integer(int32)

false

none

none

planBuilderCalculationID

string¦null

false

none

none

name

string¦null

false

none

none

finished

boolean

false

none

none

startDate

string(date-time)¦null

false

none

none

endDate

string(date-time)¦null

false

none

none

calculationDuration

integer(int32)

false

none

none

syncBackDuration

integer(int32)

false

none

none

method

string¦null

false

none

none

json
{
  "computationEventID": 0,
  "computationID": 0,
  "planBuilderCalculationID": "string",
  "name": "string",
  "finished": true,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "calculationDuration": 0,
  "syncBackDuration": 0,
  "method": "string"
}

Varicent.RESTAPI.v1.DTOs.Plans.PayeePlanAssignmentDTO

Properties

Name

Type

Required

Restrictions

Description

payeeId

string¦null

false

none

none

planId

integer(int32)

false

none

none

startDate

string(date-time)

false

none

none

endDate

string(date-time)¦null

false

none

none

json
{
  "payeeId": "string",
  "planId": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z"
}

Varicent.RESTAPI.v1.DTOs.Plans.PlanAcceleratorDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)¦null

false

none

none

minQuota

number(double)

false

none

none

maxQuota

number(double)

false

none

none

baseAccelerator

number(double)

false

none

none

accelerationMethod

string¦null

false

none

none

displayTierId

integer(int32)

false

none

none

json
{
  "id": 0,
  "minQuota": 0.1,
  "maxQuota": 0.1,
  "baseAccelerator": 0.1,
  "accelerationMethod": "string",
  "displayTierId": 0
}

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentCreditCriteriaDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)¦null

false

none

none

planComponentId

integer(int32)¦null

false

none

none

sourceFilterDTO

RESTAPI.v1.DTOs.PresenterFlex.PresenterFlexSourceFilterDTO

false

none

none

json
{
  "id": 0,
  "planComponentId": 0,
  "sourceFilterDTO": {
    "constraint": {
      "columnName": "string",
      "operator": {},
      "value": {},
      "caseSensitive": true
    },
    "and": {
      "filters": []
    },
    "or": {
      "filters": []
    },
    "not": {
      "filter": null
    },
    "metadata": {
      "property1": null,
      "property2": null
    }
  }
}

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentCreditQualifierOptionDTO

Properties

Name

Type

Required

Restrictions

Description

columnName

string¦null

false

none

none

columnDataType

string¦null

false

none

none

comparisonOperands

[string]¦null

false

none

none

logicOperands

[string]¦null

false

none

none

isKey

boolean

false

none

none

json
{
  "columnName": "string",
  "columnDataType": "string",
  "comparisonOperands": [
    "string"
  ],
  "logicOperands": [
    "string"
  ],
  "isKey": true
}

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentCustomFormulaDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)¦null

false

none

none

name

string¦null

false

none

none

type

string

false

none

none

planComponentType

string¦null

false

none

none

calculations

[Varicent.RESTAPI.v1.DTOs.NavigationCalculationElementDTO]¦null

false

none

none

Enumerated Values

Property

Value

type

Compensation

type

Credit

type

Quota

json
{
  "id": 0,
  "name": "string",
  "type": "Compensation",
  "planComponentType": "string",
  "calculations": [
    {
      "parentBlockId": 0,
      "elementId": 0,
      "calculationId": 0,
      "calculationType": "string",
      "name": "string",
      "comment": "string",
      "isFavourite": true,
      "sourceTables": []
    }
  ]
}

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentCustomFormulaDuplicateDTO

Properties

Name

Type

Required

Restrictions

Description

sourceFormulaId

integer(int32)

false

none

none

type

string

false

none

none

name

string¦null

false

none

none

suffix

string¦null

false

none

none

Enumerated Values

Property

Value

type

Compensation

type

Credit

type

Quota

json
{
  "sourceFormulaId": 0,
  "type": "Compensation",
  "name": "string",
  "suffix": "string"
}

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentCustomFormulaPatchDTO

Properties

Name

Type

Required

Restrictions

Description

customFormulaDTO

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentCustomFormulaDTO

false

none

none

isToBeLinked

boolean

false

none

none

unionColumns

[string]¦null

false

none

none

json
{
  "customFormulaDTO": {
    "id": 0,
    "name": "string",
    "type": "Compensation",
    "planComponentType": "string",
    "calculations": [
      {}
    ]
  },
  "isToBeLinked": true,
  "unionColumns": [
    "string"
  ]
}

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)¦null

false

none

none

planId

integer(int32)

false

none

none

name

string¦null

false

none

none

description

string¦null

false

none

none

type

string¦null

false

none

none

json

string¦null

false

none

none

weight

number(double)¦null

false

none

none

planDataDTO

Varicent.RESTAPI.v1.DTOs.Plans.PlanDataDTO

false

none

none

planQuotaDTO

Varicent.RESTAPI.v1.DTOs.Plans.PlanQuotaDTO

false

none

none

planAcceleratorDTOs

[Varicent.RESTAPI.v1.DTOs.Plans.PlanAcceleratorDTO]¦null

false

none

none

planPaymentDTOs

[Varicent.RESTAPI.v1.DTOs.Plans.PlanPaymentDTO]¦null

false

none

none

planPayoutDTO

Varicent.RESTAPI.v1.DTOs.Plans.PlanPayoutDTO

false

none

none

planQuotaAmountDTO

Varicent.RESTAPI.v1.DTOs.Plans.PlanQuotaAmountDTO

false

none

none

planPayeeEffectiveRangeDTO

[Varicent.RESTAPI.v1.DTOs.Plans.PlanPayeeEffectiveRangeDTO]¦null

false

none

none

rateCardConditionDTOs

[RESTAPI.v1.DTOs.Plans.RateCard.RateCardConditionDTO]¦null

false

none

none

planComponentCreditCriteriaDTO

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentCreditCriteriaDTO

false

none

none

basePayoutRateType

string¦null

false

none

none

json
{
  "id": 0,
  "planId": 0,
  "name": "string",
  "description": "string",
  "type": "string",
  "json": "string",
  "weight": 0.1,
  "planDataDTO": {
    "id": 0,
    "source": "string",
    "owner": "string",
    "additionalCriteria": "string",
    "earnedDate": "string",
    "trackSplits": true,
    "isUsingCustomFormula": true,
    "customFormula": {
      "id": 0,
      "name": "string",
      "type": "Compensation",
      "planComponentType": "string",
      "calculations": []
    },
    "payeeFilter": true
  },
  "planQuotaDTO": {
    "id": 0,
    "earningMeasure": "string",
    "earningType": "string",
    "rateType": "string",
    "hasRateCard": true,
    "isUsingCustomFormula": true,
    "customFormula": {
      "id": 0,
      "name": "string",
      "type": "Compensation",
      "planComponentType": "string",
      "calculations": []
    },
    "defaultCurrency": "string",
    "defaultQuota": 0.1
  },
  "planAcceleratorDTOs": [
    {
      "id": 0,
      "minQuota": 0.1,
      "maxQuota": 0.1,
      "baseAccelerator": 0.1,
      "accelerationMethod": "string",
      "displayTierId": 0
    }
  ],
  "planPaymentDTOs": [
    {
      "id": 0,
      "percentage": 0.1,
      "payPeriodMethod": "string",
      "releaseMethod": "string",
      "dataSourceId": "string",
      "dataField": "string",
      "dateField": "string",
      "isLessThanOrEqualTo": "string",
      "numerator": "string",
      "denominator": "string",
      "startDate": "string",
      "endDate": "string",
      "frequency": "string",
      "qualifierType": "string",
      "releaseType": "string",
      "conditionValue": "string",
      "comparisonOperand": "string",
      "releaseTerm": "string",
      "planComponentID": 0
    }
  ],
  "planPayoutDTO": {
    "id": 0,
    "earningDriver": "string",
    "frequency": "string",
    "defaultPayoutRate": 0.1,
    "useDefaults": "string",
    "lookupTable": "string",
    "lookupColumn": "string",
    "useLookup": "string",
    "isUsingCustomFormula": true,
    "customFormula": {
      "id": 0,
      "name": "string",
      "type": "Compensation",
      "planComponentType": "string",
      "calculations": []
    },
    "defaultPayoutRateMode": "None"
  },
  "planQuotaAmountDTO": {
    "id": 0,
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "frequency": "string"
  },
  "planPayeeEffectiveRangeDTO": [
    {
      "id": 0,
      "quotaCurrency": "string",
      "basePayoutRate": 0.1,
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "payeeId": "string",
      "quotaValue": 0.1
    }
  ],
  "rateCardConditionDTOs": [
    {
      "id": 0,
      "index": 0,
      "name": "string",
      "multiplier": 0.1,
      "rateCardOperators": []
    }
  ],
  "planComponentCreditCriteriaDTO": {
    "id": 0,
    "planComponentId": 0,
    "sourceFilterDTO": {
      "constraint": {},
      "and": {},
      "or": {},
      "not": {},
      "metadata": {}
    }
  },
  "basePayoutRateType": "string"
}

Varicent.RESTAPI.v1.DTOs.Plans.PlanCustomFormulaDownstreamDetailsDTO

Properties

Name

Type

Required

Restrictions

Description

downstreamUnionCalc

string¦null

false

none

none

downstreamCalcTemplateSource

string¦null

false

none

none

json
{
  "downstreamUnionCalc": "string",
  "downstreamCalcTemplateSource": "string"
}

Varicent.RESTAPI.v1.DTOs.Plans.PlanDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)¦null

false

none

none

name

string¦null

false

none

none

isFavorite

boolean

false

none

none

startDate

string(date-time)

false

none

none

endDate

string(date-time)

false

none

none

description

string¦null

false

none

none

json
{
  "id": 0,
  "name": "string",
  "isFavorite": true,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "description": "string"
}

Varicent.RESTAPI.v1.DTOs.Plans.PlanDataDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)¦null

false

none

none

source

string¦null

false

none

none

owner

string¦null

false

none

none

additionalCriteria

string¦null

false

none

none

earnedDate

string¦null

false

none

none

trackSplits

boolean

false

none

none

isUsingCustomFormula

boolean

false

none

none

customFormula

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentCustomFormulaDTO

false

none

none

payeeFilter

boolean

false

none

none

json
{
  "id": 0,
  "source": "string",
  "owner": "string",
  "additionalCriteria": "string",
  "earnedDate": "string",
  "trackSplits": true,
  "isUsingCustomFormula": true,
  "customFormula": {
    "id": 0,
    "name": "string",
    "type": "Compensation",
    "planComponentType": "string",
    "calculations": [
      {}
    ]
  },
  "payeeFilter": true
}

Varicent.RESTAPI.v1.DTOs.Plans.PlanPayeeDetailsDTO

Properties

Name

Type

Required

Restrictions

Description

startDate

string(date-time)

false

none

none

endDate

string(date-time)¦null

false

none

none

planId

integer(int32)

false

none

none

payeeCurrency

string¦null

false

none

none

name

string¦null

false

none

none

id

string¦null

false

none

none

json
{
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "planId": 0,
  "payeeCurrency": "string",
  "name": "string",
  "id": "string"
}

Varicent.RESTAPI.v1.DTOs.Plans.PlanPayeeEffectiveRangeDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)¦null

false

none

none

quotaCurrency

string¦null

false

none

none

basePayoutRate

number(double)

false

none

none

startDate

string(date-time)

false

none

none

endDate

string(date-time)

false

none

none

payeeId

string¦null

false

none

none

quotaValue

number(double)

false

none

none

json
{
  "id": 0,
  "quotaCurrency": "string",
  "basePayoutRate": 0.1,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "payeeId": "string",
  "quotaValue": 0.1
}

Varicent.RESTAPI.v1.DTOs.Plans.PlanPayeePayoutDetailsDTO

Properties

Name

Type

Required

Restrictions

Description

startDate

string(date-time)

false

none

none

endDate

string(date-time)¦null

false

none

none

planId

integer(int32)

false

none

none

attainment

number(double)¦null

false

none

none

quota

number(double)

false

none

none

percent

number(double)¦null

false

none

none

credit

number(double)¦null

false

none

none

currency

string¦null

false

none

none

estimatedPayout

number(double)

false

none

none

totalPaid

number(double)

false

none

none

totalScheduled

number(double)

false

none

none

totalHeld

number(double)

false

none

none

payroll

number(double)

false

none

none

name

string¦null

false

none

none

id

string¦null

false

none

none

json
{
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "planId": 0,
  "attainment": 0.1,
  "quota": 0.1,
  "percent": 0.1,
  "credit": 0.1,
  "currency": "string",
  "estimatedPayout": 0.1,
  "totalPaid": 0.1,
  "totalScheduled": 0.1,
  "totalHeld": 0.1,
  "payroll": 0.1,
  "name": "string",
  "id": "string"
}

Varicent.RESTAPI.v1.DTOs.Plans.PlanPaymentDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)¦null

false

none

none

percentage

number(double)

false

none

none

payPeriodMethod

string¦null

false

none

none

releaseMethod

string¦null

false

none

none

dataSourceId

string¦null

false

none

none

dataField

string¦null

false

none

none

dateField

string¦null

false

none

none

isLessThanOrEqualTo

string¦null

false

none

none

numerator

string¦null

false

none

none

denominator

string¦null

false

none

none

startDate

string¦null

false

none

none

endDate

string¦null

false

none

none

frequency

string¦null

false

none

none

qualifierType

string¦null

false

none

none

releaseType

string¦null

false

none

none

conditionValue

string¦null

false

none

none

comparisonOperand

string¦null

false

none

none

releaseTerm

string¦null

false

none

none

planComponentID

integer(int32)

false

none

none

json
{
  "id": 0,
  "percentage": 0.1,
  "payPeriodMethod": "string",
  "releaseMethod": "string",
  "dataSourceId": "string",
  "dataField": "string",
  "dateField": "string",
  "isLessThanOrEqualTo": "string",
  "numerator": "string",
  "denominator": "string",
  "startDate": "string",
  "endDate": "string",
  "frequency": "string",
  "qualifierType": "string",
  "releaseType": "string",
  "conditionValue": "string",
  "comparisonOperand": "string",
  "releaseTerm": "string",
  "planComponentID": 0
}

Varicent.RESTAPI.v1.DTOs.Plans.PlanPayoutDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)¦null

false

none

none

earningDriver

string¦null

false

none

none

frequency

string¦null

false

none

none

defaultPayoutRate

number(double)

false

none

none

useDefaults

string¦null

false

none

none

lookupTable

string¦null

false

none

none

lookupColumn

string¦null

false

none

none

useLookup

string¦null

false

none

none

isUsingCustomFormula

boolean

false

none

none

customFormula

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentCustomFormulaDTO

false

none

none

defaultPayoutRateMode

string

false

none

none

Enumerated Values

Property

Value

defaultPayoutRateMode

None

defaultPayoutRateMode

Default

defaultPayoutRateMode

Lookup

defaultPayoutRateMode

AutoCalculate

json
{
  "id": 0,
  "earningDriver": "string",
  "frequency": "string",
  "defaultPayoutRate": 0.1,
  "useDefaults": "string",
  "lookupTable": "string",
  "lookupColumn": "string",
  "useLookup": "string",
  "isUsingCustomFormula": true,
  "customFormula": {
    "id": 0,
    "name": "string",
    "type": "Compensation",
    "planComponentType": "string",
    "calculations": [
      {}
    ]
  },
  "defaultPayoutRateMode": "None"
}

Varicent.RESTAPI.v1.DTOs.Plans.PlanPerformanceDTO

Properties

Name

Type

Required

Restrictions

Description

planId

integer(int32)

false

none

none

componentId

integer(int32)

false

none

none

period

string¦null

false

none

none

credit

number(double)

false

none

none

payout

number(double)

false

none

none

currency

string¦null

false

none

none

json
{
  "planId": 0,
  "componentId": 0,
  "period": "string",
  "credit": 0.1,
  "payout": 0.1,
  "currency": "string"
}

Varicent.RESTAPI.v1.DTOs.Plans.PlanQuotaAmountDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)¦null

false

none

none

startDate

string(date-time)

false

none

none

endDate

string(date-time)

false

none

none

frequency

string¦null

false

none

none

json
{
  "id": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "frequency": "string"
}

Varicent.RESTAPI.v1.DTOs.Plans.PlanQuotaDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)¦null

false

none

none

earningMeasure

string¦null

false

none

none

earningType

string¦null

false

none

none

rateType

string¦null

false

none

none

hasRateCard

boolean

false

none

none

isUsingCustomFormula

boolean

false

none

none

customFormula

Varicent.RESTAPI.v1.DTOs.Plans.PlanComponentCustomFormulaDTO

false

none

none

defaultCurrency

string¦null

false

none

none

defaultQuota

number(double)

false

none

none

json
{
  "id": 0,
  "earningMeasure": "string",
  "earningType": "string",
  "rateType": "string",
  "hasRateCard": true,
  "isUsingCustomFormula": true,
  "customFormula": {
    "id": 0,
    "name": "string",
    "type": "Compensation",
    "planComponentType": "string",
    "calculations": [
      {}
    ]
  },
  "defaultCurrency": "string",
  "defaultQuota": 0.1
}

Varicent.RESTAPI.v1.DTOs.Plans.ReleaseTermDTO

Properties

Name

Type

Required

Restrictions

Description

releaseTermId

string¦null

false

none

none

releaseTermName

string¦null

false

none

none

json
{
  "releaseTermId": "string",
  "releaseTermName": "string"
}

Varicent.RESTAPI.v1.DTOs.PortDefinitionDTO

Properties

Name

Type

Required

Restrictions

Description

portId

integer(int32)

false

none

none

name

string¦null

false

none

none

portType

string

false

none

none

sourceTable

string¦null

false

none

none

referencedTable

string¦null

false

none

none

columns

[varicent.RESTAPI.v1.DTOs.PortColumnDTO]¦null

false

none

none

references

object¦null

false

none

none

» additionalProperties

string

false

none

none

timeReferences

object¦null

false

none

none

» additionalProperties

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

none

isWaypoint

boolean

false

none

none

migrationDisplayName

string¦null

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

portType

Input

portType

Output

json
{
  "portId": 0,
  "name": "string",
  "portType": "Input",
  "sourceTable": "string",
  "referencedTable": "string",
  "columns": [
    {
      "portId": 0,
      "name": "string",
      "dataType": "String",
      "order": 0,
      "isKey": true,
      "sourceColumn": "string"
    }
  ],
  "references": {
    "property1": "string",
    "property2": "string"
  },
  "timeReferences": {
    "property1": {
      "levelId": "string",
      "timeId": "string"
    },
    "property2": {
      "levelId": "string",
      "timeId": "string"
    }
  },
  "isWaypoint": true,
  "migrationDisplayName": "string",
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.PortalAccess.AttachmentItemDTO

Properties

Name

Type

Required

Restrictions

Description

bytes

string¦null

false

none

none

path

string¦null

false

none

none

json
{
  "bytes": "string",
  "path": "string"
}

Varicent.RESTAPI.v1.DTOs.PortalAccess.DisputeCategoryDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

name

string¦null

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "id": 0,
  "name": "string",
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.PortalAccess.DisputeCommentDTO

Properties

Name

Type

Required

Restrictions

Description

author

string¦null

false

none

none

created

string(date-time)

false

none

none

text

string¦null

false

none

none

json
{
  "author": "string",
  "created": "2019-08-24T14:15:22Z",
  "text": "string"
}

Varicent.RESTAPI.v1.DTOs.PortalAccess.DisputeDefinitionDTO

Properties

Name

Type

Required

Restrictions

Description

disputeId

integer(int32)

false

none

none

created

string(date-time)

false

none

none

updated

string(date-time)

false

none

none

creatorId

string¦null

false

none

none

creatorName

string¦null

false

none

none

status

string

false

none

none

category

integer(int32)

false

none

none

groupName

string¦null

false

none

none

groupId

integer(int32)

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

status

Open

status

Invalid

status

Fixed

status

Closed

json
{
  "disputeId": 0,
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z",
  "creatorId": "string",
  "creatorName": "string",
  "status": "Open",
  "category": 0,
  "groupName": "string",
  "groupId": 0,
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.PortalAccess.DisputePatchDTO

Properties

Name

Type

Required

Restrictions

Description

disputeId

integer(int32)

false

none

none

status

string

false

none

none

category

integer(int32)

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

status

Open

status

Invalid

status

Fixed

status

Closed

json
{
  "disputeId": 0,
  "status": "Open",
  "category": 0,
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.PortalAccess.EnableDisableInquiriesDTO

Properties

Name

Type

Required

Restrictions

Description

workflowTreeID

integer(int32)

false

none

none

objectType

string

false

none

none

objectID

string¦null

false

none

none

Enumerated Values

Property

Value

objectType

Data

objectType

CompensationPlan

objectType

TailoredReport

objectType

Document

objectType

WebForm

objectType

WebReport

objectType

WebTab

objectType

CompPlanManager

objectType

WebTabGroup

objectType

ExternalURL

objectType

RapidReport

objectType

Table

objectType

DataStore

objectType

DDE

objectType

DDEInfographic

objectType

PayeeDocument

objectType

PresenterAdaptive

objectType

DirectLink

objectType

AdaptiveForm

objectType

StandardReport

objectType

SalesPlanningMap

json
{
  "workflowTreeID": 0,
  "objectType": "Data",
  "objectID": "string"
}

Varicent.RESTAPI.v1.DTOs.PortalAccess.UpdateResubmitToReturnerDTO

Properties

Name

Type

Required

Restrictions

Description

objectType

string

false

none

none

objectID

string¦null

false

none

none

state

boolean

false

none

none

Enumerated Values

Property

Value

objectType

Data

objectType

CompensationPlan

objectType

TailoredReport

objectType

Document

objectType

WebForm

objectType

WebReport

objectType

WebTab

objectType

CompPlanManager

objectType

WebTabGroup

objectType

ExternalURL

objectType

RapidReport

objectType

Table

objectType

DataStore

objectType

DDE

objectType

DDEInfographic

objectType

PayeeDocument

objectType

PresenterAdaptive

objectType

DirectLink

objectType

AdaptiveForm

objectType

StandardReport

objectType

SalesPlanningMap

json
{
  "objectType": "Data",
  "objectID": "string",
  "state": true
}

Varicent.RESTAPI.v1.DTOs.Preview.BPMPreviewStateDTO

Properties

Name

Type

Required

Restrictions

Description

sourceDefinition

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

formInitiator

string¦null

false

none

none

restrictions

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

dependencies

[string]¦null

false

none

none

reportId

integer(int32)

false

none

none

selectedNames

[string]¦null

false

none

none

workflowId

integer(int32)

false

none

none

workflowType

string

false

none

none

Enumerated Values

Property

Value

workflowType

PresenterReport

workflowType

Inquiry

workflowType

PlanApproval

workflowType

PresenterFlexReport

workflowType

PlanDocument

json
{
  "sourceDefinition": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "formInitiator": "string",
  "restrictions": {
    "constraintType": "clause",
    "op": "string",
    "dataFieldLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "caseSensitive": true,
    "constraints": [
      {}
    ],
    "literalRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "dataFieldRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "right": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "isPreciseDecimal": true,
    "like": "string",
    "escapeWildcards": true,
    "rowVersion": {
      "rowVersion": 0
    },
    "table": "string",
    "queryDefinitionRight": null
  },
  "dependencies": [
    "string"
  ],
  "reportId": 0,
  "selectedNames": [
    "string"
  ],
  "workflowId": 0,
  "workflowType": "PresenterReport"
}

Varicent.RESTAPI.v1.DTOs.Preview.PreviewStateDTO

Properties

Name

Type

Required

Restrictions

Description

calculationToPreview

Varicent.RESTAPI.v1.DTOs.Calculations.CalculationDTO Varicent.RESTAPI.v1.DTOs.Calculations.CalculationDTO

false

none

none

parentBlockId

integer(int32)

false

none

none

validate

boolean

false

none

none

json
{
  "calculationToPreview": {
    "calculationId": 0,
    "calculationType": "Mathematical",
    "name": "string",
    "comment": "string",
    "hasOutputGroups": true,
    "source": "string",
    "usesLeftJoin": true,
    "calendar": "string",
    "timePartitionPath": "string",
    "timeLevel": "string",
    "resetLevel": "string",
    "timeStart": {},
    "timeEnd": {},
    "isCurrent": true,
    "outputTable": "string",
    "previewId": 0,
    "previewTable": "string",
    "rowVersion": {
      "rowVersion": 0
    },
    "restrictions": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "mainSourceRestrictions": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "partitions": [
      {}
    ],
    "lookups": [
      {}
    ],
    "unions": [
      {}
    ],
    "traceColumns": [
      {}
    ],
    "executionPaths": [
      "LimitAll"
    ],
    "references": {
      "property1": {},
      "property2": {}
    },
    "timeReferences": {
      "property1": {},
      "property2": {}
    },
    "sourceColumns": [
      {}
    ],
    "sourceKeyColumns": [
      {}
    ],
    "outputColumns": [
      {}
    ],
    "calculationDataId": 0,
    "formulas": {
      "property1": "string",
      "property2": "string"
    },
    "formulaOrder": {
      "property1": 0,
      "property2": 0
    },
    "pipeConnection": {
      "pipeID": "string",
      "inputID": "string",
      "outputID": "string",
      "outputName": "string",
      "lastValidated": "2019-08-24T14:15:22Z",
      "inputMapping": [],
      "outputMapping": []
    },
    "sortColumns": [
      {}
    ],
    "limit": 0,
    "sortDirection": "Ascending",
    "rankType": "Standard",
    "timeColumn": "string",
    "timeId": "string",
    "levelId": "string",
    "shift": 0,
    "categories": [
      {}
    ],
    "timeLockStart": "2019-08-24T14:15:22Z",
    "timeLockEnd": "2019-08-24T14:15:22Z",
    "timeLockCalendar": "string"
  },
  "parentBlockId": 0,
  "validate": true
}

Varicent.RESTAPI.v1.DTOs.Preview.PulseTagPreviewStateDTO

Properties

Name

Type

Required

Restrictions

Description

planId

integer(int32)

false

none

none

tagType

string

false

none

none

restrictionQuery

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

Enumerated Values

Property

Value

tagType

Transactions

tagType

CreditedTransactions

tagType

QualifiedTransactions

tagType

Earnings

tagType

Commission

tagType

Bonus

tagType

ManualPayoutAdjustments

tagType

QuotaTargets

tagType

Guarantees

tagType

Actuals

tagType

ClubQualification

tagType

Performance

tagType

PerformanceYTD

tagType

PayeeAttributes

tagType

Threshold

tagType

BalanceCarry

tagType

Plan

tagType

Territory

tagType

TransactionMapping

tagType

Projected

tagType

ScenarioResults

tagType

ICMDates

tagType

Roles

tagType

BenchmarkMapping

tagType

PayeeInfo

tagType

Payment

json
{
  "planId": 0,
  "tagType": "Transactions",
  "restrictionQuery": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  }
}

Varicent.RESTAPI.v1.DTOs.Preview.WebReportPreviewStateDTO

Properties

Name

Type

Required

Restrictions

Description

sourceDefinition

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

parameters

object¦null

false

none

none

» additionalProperties

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

webReport

Varicent.RESTAPI.v1.DTOs.WebReportDTO

false

none

none

dependencies

[string]¦null

false

none

none

selectNames

[string]¦null

false

none

none

restrictions

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

json
{
  "sourceDefinition": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "parameters": {
    "property1": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "property2": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    }
  },
  "webReport": {
    "allowPdfExport": true,
    "showInquiry": true,
    "batchExportDetails": {
      "canBatchExport": true,
      "picklistRefParam": "string"
    },
    "background": {
      "color": {},
      "image": {},
      "imageAttachment": "Scroll",
      "imagePosition": "Absolute",
      "imageTile": "None",
      "webreportId": 0,
      "x": 0,
      "y": 0,
      "opacity": 0
    },
    "defaultStyle": {
      "color": {},
      "font": {}
    },
    "directlyAccessible": true,
    "frameLayout": {
      "horizontalAlign": "Left",
      "verticalAlign": "Top",
      "type": "Frame",
      "childHeightPercents": [],
      "childWidthPercents": [],
      "frames": [],
      "name": "string",
      "numColumns": 0,
      "numRows": 0,
      "display": {}
    },
    "isLayoutLocked": true,
    "name": "string",
    "pdfOptions": {
      "autoScale": true,
      "customScaleValue": 0.1,
      "footerText": "string",
      "includePageNumber": true,
      "portraitOrientation": true,
      "showTotalPageNumber": true,
      "tableViewportWidth": 0.1
    },
    "sources": [
      {}
    ],
    "trees": [
      {}
    ],
    "version": {
      "rowVersion": 0
    },
    "webReportId": 0,
    "workflowObjectId": 0,
    "element": {},
    "styleCategory": "string"
  },
  "dependencies": [
    "string"
  ],
  "selectNames": [
    "string"
  ],
  "restrictions": {
    "constraintType": "clause",
    "op": "string",
    "dataFieldLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "caseSensitive": true,
    "constraints": [
      {}
    ],
    "literalRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "dataFieldRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "right": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "isPreciseDecimal": true,
    "like": "string",
    "escapeWildcards": true,
    "rowVersion": {
      "rowVersion": 0
    },
    "table": "string",
    "queryDefinitionRight": null
  }
}

Varicent.RESTAPI.v1.DTOs.ProcessListDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

name

string¦null

false

none

none

description

string¦null

false

none

none

type

string

false

none

none

order

integer(int32)

false

none

none

processMapTasks

[Varicent.RESTAPI.v1.DTOs.ProcessListTaskDTO]¦null

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

type

Ordered

type

Perpetual

json
{
  "id": 0,
  "name": "string",
  "description": "string",
  "type": "Ordered",
  "order": 0,
  "processMapTasks": [
    {
      "id": 0,
      "processMapId": 0,
      "parent": 0,
      "order": 0,
      "name": "string",
      "description": "string",
      "linkName": "string",
      "user": "string",
      "status": "NotStarted",
      "completionDate": "2019-08-24T14:15:22Z",
      "children": [],
      "varicentUrl": {},
      "rowVersion": {},
      "isValid": true,
      "showDetails": true,
      "editTask": true
    }
  ],
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.ProcessListTaskDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

processMapId

integer(int32)

false

none

none

parent

integer(int32)¦null

false

none

none

order

integer(int32)

false

none

none

name

string¦null

false

none

none

description

string¦null

false

none

none

linkName

string¦null

false

none

none

user

string¦null

false

none

none

status

string

false

none

none

completionDate

string(date-time)¦null

false

none

none

children

[Varicent.RESTAPI.v1.DTOs.ProcessListTaskDTO]¦null

false

none

none

varicentUrl

Varicent.RESTAPI.v1.DTOs.VaricentUrlDTO

false

none

none

rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

isValid

boolean¦null

false

none

none

showDetails

boolean

false

none

none

editTask

boolean

false

none

none

Enumerated Values

Property

Value

status

NotStarted

status

Completed

json
{
  "id": 0,
  "processMapId": 0,
  "parent": 0,
  "order": 0,
  "name": "string",
  "description": "string",
  "linkName": "string",
  "user": "string",
  "status": "NotStarted",
  "completionDate": "2019-08-24T14:15:22Z",
  "children": [],
  "varicentUrl": {
    "moduleType": "home",
    "actionType": "None",
    "elementType": "none",
    "moduleTab": "string",
    "args": {
      "property1": "string",
      "property2": "string"
    }
  },
  "rowVersion": {
    "rowVersion": 0
  },
  "isValid": true,
  "showDetails": true,
  "editTask": true
}

Varicent.RESTAPI.v1.DTOs.Publisher.PublisherColumnFormatDTO

Properties

Name

Type

Required

Restrictions

Description

column

string¦null

false

none

none

scale

integer(int32)

false

none

none

json
{
  "column": "string",
  "scale": 0
}

Varicent.RESTAPI.v1.DTOs.Publisher.PublisherDefinitionDTO

Properties

Name

Type

Required

Restrictions

Description

publisherId

integer(int32)

false

none

none

name

string¦null

false

none

none

publishType

string

false

none

none

location

string¦null

false

none

none

publisherParams

[Varicent.RESTAPI.v1.DTOs.Publisher.PublisherParamsDTO]¦null

false

none

none

isTemporary

boolean

false

none

none

enableScreenshot

boolean

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

publishType

CalculationExcel

publishType

CalculationMSCRM

publishType

CalculationPdf

publishType

CalculationSalesforce

publishType

CalculationText

publishType

CustomTableExcel

publishType

CustomTableMSCRM

publishType

CustomTablePdf

publishType

CustomTableSalesforce

publishType

CustomTableText

publishType

WebFormPdf

publishType

WebReportPdf

publishType

BPMExcel

publishType

PortExcel

publishType

PortPdf

publishType

PortSalesforce

publishType

PortText

publishType

PerformanceExcel

publishType

PerformancePdf

publishType

PerformanceSalesforce

publishType

PerformanceText

publishType

PayeeWebWebReportPdf

publishType

DataStoreText

publishType

DataStoreExcel

publishType

QueryToolText

publishType

QueryToolExcel

publishType

CalculationCOS

publishType

CustomTableCOS

publishType

PortCOS

publishType

PerformanceCOS

publishType

PresenterFlexPdf

publishType

PayeeWebPresenterFlexPdf

publishType

HealthDashboardExcel

publishType

PlanDocumentPdf

publishType

StandardReportPdf

publishType

BulkPlanDocumentsZip

publishType

MassPlanDocumentDownloadZip

publishType

AdminPresenterFlexPdf

publishType

PlanDocument2Pdf

publishType

PlanBuilderCalculationExcel

publishType

PlanBuilderCalculationMSCRM

publishType

PlanBuilderCalculationPdf

publishType

PlanBuilderCalculationSalesforce

publishType

PlanBuilderCalculationText

publishType

PlanBuilderCalculationCOS

publishType

RequirementPdf

json
{
  "publisherId": 0,
  "name": "string",
  "publishType": "CalculationExcel",
  "location": "string",
  "publisherParams": [
    {
      "type": "Calculation",
      "calculationId": 0,
      "calculationName": "string",
      "portId": 0,
      "columnMap": {},
      "customTableName": "string",
      "filter": "string",
      "inputFormID": 0,
      "columns": "string",
      "headerRow": "string",
      "compress": true,
      "customOrderBy": [],
      "columnFormat": [],
      "columnWithDescription": [],
      "dataStoreName": "string",
      "delimiter": "string",
      "compPlanId": "string",
      "payeeId": "string",
      "period": "string",
      "periodLevel": "string",
      "payeeMajorDim": true,
      "mailWebUsers": true,
      "recipients": [],
      "emailSubject": "string",
      "emailBody": "string",
      "singleWorkbook": true,
      "fileName": "string",
      "headerImage": "string",
      "numberPages": true,
      "showTotalPageNumber": true,
      "portraitOrientation": true,
      "autoScale": true,
      "customScaleValue": 0.1,
      "tableViewportWidth": 0.1,
      "footerText": "string",
      "mergePdfFiles": true,
      "expandAllTableGroups": true,
      "user": "string",
      "password": "string",
      "token": "string",
      "table": "string",
      "sandbox": true,
      "dateFormat": "Default",
      "header": {},
      "row": {},
      "altRow": {},
      "webFormId": 0,
      "workflowGroupId": 0,
      "filterValues": {},
      "webReportId": 0,
      "parameterValues": {},
      "currentUserId": "string",
      "isBatchExport": true,
      "batchExportPayeeList": [],
      "hiddenColumnMap": {},
      "batchPicklistRefParam": "string",
      "bpmPublishType": "History",
      "workflowId": 0,
      "tokenId": 0,
      "timezoneOffset": "string",
      "offset": 0,
      "limit": 0,
      "orderBy": "string",
      "queryToolId": 0,
      "name": "string",
      "fromDataServer": "QUERY_SQL",
      "queryString": "string",
      "description": "string",
      "timeout": 0,
      "presenterFlexReportId": 0,
      "webTabId": 0,
      "currentPayeeId": "string",
      "batchExportPayeeIds": [],
      "bpmTokenId": 0,
      "planApprovalTemplateId": 0,
      "planApprovalStatus": "Selected",
      "planDocumentId": 0,
      "payeeWorkflowStatus": "InProgress",
      "planBuilderCalculationId": "string",
      "planBuilderCalculationName": "string",
      "requirementIds": [],
      "requirementExportAll": true,
      "requirementExportTitle": "string",
      "requirementfilter": "string",
      "requirementOrderBy": "string"
    }
  ],
  "isTemporary": true,
  "enableScreenshot": true,
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.Publisher.PublisherNameDTO

Properties

Name

Type

Required

Restrictions

Description

id

string¦null

false

none

none

name

string¦null

false

none

none

parameterValues

object¦null

false

none

none

» additionalProperties

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

json
{
  "id": "string",
  "name": "string",
  "parameterValues": {
    "property1": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "property2": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    }
  }
}

Varicent.RESTAPI.v1.DTOs.Publisher.PublisherParamsDTO

Properties

Name

Type

Required

Restrictions

Description

type

string

false

none

none

calculationId

integer(int32)¦null

false

none

none

calculationName

string¦null

false

none

none

portId

integer(int32)¦null

false

none

none

columnMap

object¦null

false

none

none

» additionalProperties

string¦null

false

none

none

customTableName

string¦null

false

none

none

filter

string¦null

false

none

none

inputFormID

integer(int32)

false

none

none

columns

string¦null

false

none

none

headerRow

string¦null

false

none

none

compress

boolean¦null

false

none

none

customOrderBy

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

none

columnFormat

[Varicent.RESTAPI.v1.DTOs.Publisher.PublisherColumnFormatDTO]¦null

false

none

none

columnWithDescription

[string]¦null

false

none

none

dataStoreName

string¦null

false

none

none

delimiter

string¦null

false

none

none

compPlanId

string¦null

false

none

none

payeeId

string¦null

false

none

none

period

string¦null

false

none

none

periodLevel

string¦null

false

none

none

payeeMajorDim

boolean¦null

false

none

none

mailWebUsers

boolean¦null

false

none

none

recipients

[string]¦null

false

none

none

emailSubject

string¦null

false

none

none

emailBody

string¦null

false

none

none

singleWorkbook

boolean¦null

false

none

none

fileName

string¦null

false

none

none

headerImage

string¦null

false

none

none

numberPages

boolean¦null

false

none

none

showTotalPageNumber

boolean¦null

false

none

none

portraitOrientation

boolean¦null

false

none

none

autoScale

boolean¦null

false

none

none

customScaleValue

number(double)¦null

false

none

none

tableViewportWidth

number(double)¦null

false

none

none

footerText

string¦null

false

none

none

mergePdfFiles

boolean¦null

false

none

none

expandAllTableGroups

boolean¦null

false

none

none

user

string¦null

false

none

none

password

string¦null

false

none

none

token

string¦null

false

none

none

table

string¦null

false

none

none

sandbox

boolean¦null

false

none

none

dateFormat

string¦null

false

none

none

header

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

none

row

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

none

altRow

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

none

webFormId

integer(int32)

false

none

none

workflowGroupId

integer(int32)

false

none

none

filterValues

object¦null

false

none

none

» additionalProperties

string¦null

false

none

none

webReportId

integer(int32)¦null

false

none

none

parameterValues

object¦null

false

none

none

» additionalProperties

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

currentUserId

string¦null

false

none

none

isBatchExport

boolean

false

none

none

batchExportPayeeList

[string]¦null

false

none

none

hiddenColumnMap

object¦null

false

none

none

» additionalProperties

[string]¦null

false

none

none

batchPicklistRefParam

string¦null

false

none

none

bpmPublishType

string

false

none

none

workflowId

integer(int32)

false

none

none

tokenId

integer(int32)

false

none

none

timezoneOffset

string¦null

false

none

none

offset

integer(int32)

false

none

none

limit

integer(int32)

false

none

none

orderBy

string¦null

false

none

none

queryToolId

integer(int32)

false

none

none

name

string¦null

false

none

none

fromDataServer

string

false

none

none

queryString

string¦null

false

none

none

description

string¦null

false

none

none

timeout

integer(int32)

false

none

none

presenterFlexReportId

integer(int32)¦null

false

none

none

webTabId

integer(int32)¦null

false

none

none

currentPayeeId

string¦null

false

none

none

batchExportPayeeIds

[string]¦null

false

none

none

bpmTokenId

integer(int32)¦null

false

none

none

planApprovalTemplateId

integer(int32)

false

none

none

planApprovalStatus

string

false

none

none

planDocumentId

integer(int32)

false

none

none

payeeWorkflowStatus

string

false

none

none

planBuilderCalculationId

string¦null

false

none

none

planBuilderCalculationName

string¦null

false

none

none

requirementIds

[string]¦null

false

none

none

requirementExportAll

boolean

false

none

none

requirementExportTitle

string¦null

false

none

none

requirementfilter

string¦null

false

none

none

requirementOrderBy

string¦null

false

none

none

Enumerated Values

Property

Value

type

Calculation

type

ColumnMap

type

CustomTable

type

Delimited

type

Email

type

Excel

type

File

type

MSCRM

type

Pdf

type

Performance

type

Salesforce

type

TableStyle

type

WebForm

type

WebReport

type

WebReportView

type

BPM

type

Port

type

DataStore

type

QueryTool

type

PresenterFlex

type

PresenterFlexView

type

PlanDocument

type

StandardReport

type

BulkPlanDocuments

type

PlanDocumentDownload

type

PlanDocument2

type

PlanBuilderCalculation

type

Requirement

dateFormat

Default

dateFormat

DayFirst

dateFormat

MonthFirst

bpmPublishType

History

bpmPublishType

PendingActions

bpmPublishType

ActionNodeErrors

bpmPublishType

AlertNodeErrors

bpmPublishType

ServiceNodeErrors

bpmPublishType

SignNodeErrors

bpmPublishType

StatusReport

fromDataServer

QUERY_SQL

fromDataServer

QUERY_SPARK

fromDataServer

QUERY_PRESTO

planApprovalStatus

Selected

planApprovalStatus

PreManagerApproval

planApprovalStatus

PayeeSign

planApprovalStatus

Complete

payeeWorkflowStatus

InProgress

payeeWorkflowStatus

Complete

payeeWorkflowStatus

Cancelled

json
{
  "type": "Calculation",
  "calculationId": 0,
  "calculationName": "string",
  "portId": 0,
  "columnMap": {
    "property1": "string",
    "property2": "string"
  },
  "customTableName": "string",
  "filter": "string",
  "inputFormID": 0,
  "columns": "string",
  "headerRow": "string",
  "compress": true,
  "customOrderBy": [
    {
      "table": "string",
      "column": "string",
      "direction": "Ascending"
    }
  ],
  "columnFormat": [
    {
      "column": "string",
      "scale": 0
    }
  ],
  "columnWithDescription": [
    "string"
  ],
  "dataStoreName": "string",
  "delimiter": "string",
  "compPlanId": "string",
  "payeeId": "string",
  "period": "string",
  "periodLevel": "string",
  "payeeMajorDim": true,
  "mailWebUsers": true,
  "recipients": [
    "string"
  ],
  "emailSubject": "string",
  "emailBody": "string",
  "singleWorkbook": true,
  "fileName": "string",
  "headerImage": "string",
  "numberPages": true,
  "showTotalPageNumber": true,
  "portraitOrientation": true,
  "autoScale": true,
  "customScaleValue": 0.1,
  "tableViewportWidth": 0.1,
  "footerText": "string",
  "mergePdfFiles": true,
  "expandAllTableGroups": true,
  "user": "string",
  "password": "string",
  "token": "string",
  "table": "string",
  "sandbox": true,
  "dateFormat": "Default",
  "header": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "row": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "altRow": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "webFormId": 0,
  "workflowGroupId": 0,
  "filterValues": {
    "property1": "string",
    "property2": "string"
  },
  "webReportId": 0,
  "parameterValues": {
    "property1": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "property2": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    }
  },
  "currentUserId": "string",
  "isBatchExport": true,
  "batchExportPayeeList": [
    "string"
  ],
  "hiddenColumnMap": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "batchPicklistRefParam": "string",
  "bpmPublishType": "History",
  "workflowId": 0,
  "tokenId": 0,
  "timezoneOffset": "string",
  "offset": 0,
  "limit": 0,
  "orderBy": "string",
  "queryToolId": 0,
  "name": "string",
  "fromDataServer": "QUERY_SQL",
  "queryString": "string",
  "description": "string",
  "timeout": 0,
  "presenterFlexReportId": 0,
  "webTabId": 0,
  "currentPayeeId": "string",
  "batchExportPayeeIds": [
    "string"
  ],
  "bpmTokenId": 0,
  "planApprovalTemplateId": 0,
  "planApprovalStatus": "Selected",
  "planDocumentId": 0,
  "payeeWorkflowStatus": "InProgress",
  "planBuilderCalculationId": "string",
  "planBuilderCalculationName": "string",
  "requirementIds": [
    "string"
  ],
  "requirementExportAll": true,
  "requirementExportTitle": "string",
  "requirementfilter": "string",
  "requirementOrderBy": "string"
}

Varicent.RESTAPI.v1.DTOs.Pulse.CompPlanReportTypeDTO

Properties

Name

Type

Required

Restrictions

Description

reportType

integer(int32)

false

none

none

reportName

string¦null

false

none

none

reportTypeSummary

string¦null

false

none

none

reportDescription

string¦null

false

none

none

tagTypes

[Varicent.RESTAPI.v1.DTOs.Pulse.TagTypeDTO]¦null

false

none

none

reportTaggingGroup

string

false

none

none

filters

Varicent.RESTAPI.v1.DTOs.QuerySourceDefinitionDTO Varicent.RESTAPI.v1.DTOs.QuerySourceDefinitionDTO

false

none

none

Enumerated Values

Property

Value

reportTaggingGroup

TagReportGroupAdminClient

reportTaggingGroup

TagReportGroupTabletAndWeb

reportTaggingGroup

None

json
{
  "reportType": 0,
  "reportName": "string",
  "reportTypeSummary": "string",
  "reportDescription": "string",
  "tagTypes": [
    {
      "tagTypeId": 0,
      "tagType": "string",
      "tagColumns": []
    }
  ],
  "reportTaggingGroup": "TagReportGroupAdminClient",
  "filters": {
    "name": "string",
    "sourceDefinition": {
      "query": {},
      "sourceNames": {}
    },
    "dependencies": [
      "string"
    ],
    "columns": [
      {}
    ],
    "references": {
      "property1": "string",
      "property2": "string"
    },
    "timeReferences": {
      "property1": {},
      "property2": {}
    }
  }
}

Varicent.RESTAPI.v1.DTOs.Pulse.TagTypeDTO

Properties

Name

Type

Required

Restrictions

Description

tagTypeId

integer(int32)

false

none

none

tagType

string¦null

false

none

none

tagColumns

[RESTAPI.v1.DTOs.Pulse.TagColumnDTO]¦null

false

none

none

json
{
  "tagTypeId": 0,
  "tagType": "string",
  "tagColumns": [
    {
      "displayName": "string",
      "value": 0,
      "allowedTypes": []
    }
  ]
}

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

Properties

Name

Type

Required

Restrictions

Description

selectItems

[Varicent.RESTAPI.v1.DTOs.SelectItemDTO]¦nullVaricent.RESTAPI.v1.DTOs.SelectItemDTO

false

none

none

source

Varicent.RESTAPI.v1.DTOs.DataSourceDTO

false

none

none

joins

[Varicent.RESTAPI.v1.DTOs.JoinDTO]¦null

false

none

none

whereClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

order

[Varicent.RESTAPI.v1.DTOs.OrderItemDTO]¦null

false

none

none

group

[Varicent.RESTAPI.v1.DTOs.GroupItemDTO]¦null

false

none

none

havingClause

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

false

none

none

distinct

boolean

false

none

none

unionWith

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

exceptWith

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

json
{
  "selectItems": [
    {
      "alias": "string",
      "column": "string",
      "table": "string",
      "customSelect": "string",
      "dataType": "Int",
      "type": "SelectAll",
      "value": {}
    }
  ],
  "source": {
    "namespaceTable": {
      "m_namespace": "string",
      "name": "string"
    },
    "query": null,
    "alias": "string",
    "sourceType": "Table"
  },
  "joins": [
    {
      "source": {},
      "joinType": "Inner",
      "onClause": {}
    }
  ],
  "whereClause": {
    "constraintType": "clause",
    "op": "string",
    "dataFieldLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "caseSensitive": true,
    "constraints": [
      {}
    ],
    "literalRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "dataFieldRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "right": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "isPreciseDecimal": true,
    "like": "string",
    "escapeWildcards": true,
    "rowVersion": {
      "rowVersion": 0
    },
    "table": "string",
    "queryDefinitionRight": null
  },
  "order": [
    {
      "table": "string",
      "column": "string",
      "direction": "Ascending"
    }
  ],
  "group": [
    {
      "table": "string",
      "column": "string"
    }
  ],
  "havingClause": {
    "constraintType": "clause",
    "op": "string",
    "dataFieldLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "caseSensitive": true,
    "constraints": [
      {}
    ],
    "literalRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": {},
      "falseValue": {},
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "dataFieldRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "right": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "expressionRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "isPreciseDecimal": true,
    "like": "string",
    "escapeWildcards": true,
    "rowVersion": {
      "rowVersion": 0
    },
    "table": "string",
    "queryDefinitionRight": null
  },
  "distinct": true,
  "unionWith": null,
  "exceptWith": null
}

Varicent.RESTAPI.v1.DTOs.QueryDeltaDTO

Properties

Name

Type

Required

Restrictions

Description

modification

[Varicent.RESTAPI.v1.DTOs.Core.CollectionModificationDTO1[System.String]](#schemavaricent.restapi.v1.dtos.core.collectionmodificationdto1[system.string])

false

none

none

query

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

selectAllRows

boolean¦null

false

none

none

json
{
  "modification": {
    "itemsToAdd": [
      "string"
    ],
    "itemsToRemove": [
      "string"
    ]
  },
  "query": {
    "selectItems": [
      {}
    ],
    "source": {
      "namespaceTable": {},
      "query": null,
      "alias": "string",
      "sourceType": "Table"
    },
    "joins": [
      {}
    ],
    "whereClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "order": [
      {}
    ],
    "group": [
      {}
    ],
    "havingClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "distinct": true,
    "unionWith": null,
    "exceptWith": null
  },
  "selectAllRows": true
}

Varicent.RESTAPI.v1.DTOs.QuerySourceDefinitionDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

sourceDefinition

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

dependencies

[string]¦null

false

none

none

columns

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

none

references

object¦null

false

none

none

» additionalProperties

string

false

none

none

timeReferences

object¦null

false

none

none

» additionalProperties

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

none

json
{
  "name": "string",
  "sourceDefinition": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "dependencies": [
    "string"
  ],
  "columns": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "references": {
    "property1": "string",
    "property2": "string"
  },
  "timeReferences": {
    "property1": {
      "levelId": "string",
      "timeId": "string"
    },
    "property2": {
      "levelId": "string",
      "timeId": "string"
    }
  }
}

Varicent.RESTAPI.v1.DTOs.ReferenceOptionDTO

Properties

Name

Type

Required

Restrictions

Description

type

string

false

none

none

referencedColumn

string¦null

false

none

none

isJumpTo

boolean

false

none

none

tabName

string¦null

false

none

none

referencedInputFormName

string¦null

false

none

none

referencedInputFormId

integer(int32)

false

none

none

referencedTable

string¦null

false

none

none

Enumerated Values

Property

Value

type

ReferenceOptionInputForm

type

ReferenceOptionTable

json
{
  "type": "ReferenceOptionInputForm",
  "referencedColumn": "string",
  "isJumpTo": true,
  "tabName": "string",
  "referencedInputFormName": "string",
  "referencedInputFormId": 0,
  "referencedTable": "string"
}

Varicent.RESTAPI.v1.DTOs.ReportSourceDTO

Properties

Name

Type

Required

Restrictions

Description

dependencies

[string]¦null

false

none

none

name

string¦null

false

none

none

type

string

false

none

none

scalarType

string¦null

false

none

none

value

any

false

none

none

column

string¦null

false

none

none

keyValues

object¦null

false

none

none

» additionalProperties

Varicent.RESTAPI.v1.DTOs.ReportVariableDTO

false

none

none

table

string¦null

false

none

none

expression

string¦null

false

none

none

variables

[string]¦null

false

none

none

required

boolean

false

none

none

useWebUser

boolean

false

none

none

isParameterValueScalar

boolean

false

none

none

parameterValue

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

parameterId

integer(int32)

false

none

none

columnNames

[string]¦null

false

none

none

source

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

formula

string¦null

false

none

none

partitionColumns

[string]¦null

false

none

none

timeEnd

string(date-time)

false

none

none

timeFrequency

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

none

timePartition

string¦null

false

none

none

timeStart

string(date-time)

false

none

none

newColumnName

string¦null

false

none

none

keyColumns

[string]¦null

false

none

none

newColumns

[string]¦null

false

none

none

transposeColumn

string¦null

false

none

none

Enumerated Values

Property

Value

type

AggregateTransformation

type

ComputedColumn

type

InputRowSource

type

QuerySource

type

TransposedSource

type

StaticScalar

type

ValueScalar

type

ComputedScalar

type

Parameter

json
{
  "dependencies": [
    "string"
  ],
  "name": "string",
  "type": "AggregateTransformation",
  "scalarType": "string",
  "value": null,
  "column": "string",
  "keyValues": {
    "property1": {
      "value": {},
      "variableName": "string",
      "variableType": "Literal"
    },
    "property2": {
      "value": {},
      "variableName": "string",
      "variableType": "Literal"
    }
  },
  "table": "string",
  "expression": "string",
  "variables": [
    "string"
  ],
  "required": true,
  "useWebUser": true,
  "isParameterValueScalar": true,
  "parameterValue": {
    "expressionType": "caseExpression",
    "cases": [],
    "table": "string",
    "column": "string",
    "op": "string",
    "arguments": [
      {}
    ],
    "condition": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": null,
      "dataFieldRight": {},
      "right": null,
      "expressionLeft": null,
      "expressionRight": null,
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "trueValue": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "falseValue": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "isDate": true,
    "literalType": "Integer",
    "value": null
  },
  "parameterId": 0,
  "columnNames": [
    "string"
  ],
  "source": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "formula": "string",
  "partitionColumns": [
    "string"
  ],
  "timeEnd": "2019-08-24T14:15:22Z",
  "timeFrequency": {
    "levelId": "string",
    "timeId": "string"
  },
  "timePartition": "string",
  "timeStart": "2019-08-24T14:15:22Z",
  "newColumnName": "string",
  "keyColumns": [
    "string"
  ],
  "newColumns": [
    "string"
  ],
  "transposeColumn": "string"
}

Varicent.RESTAPI.v1.DTOs.ReportTreeNodeDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

parent

string¦null

false

none

none

parentNodeType

string¦null

false

none

none

treeNodeType

string

false

none

none

Enumerated Values

Property

Value

treeNodeType

Folder

treeNodeType

Source

treeNodeType

ParameterRoot

treeNodeType

ScalarRoot

treeNodeType

SourceRoot

treeNodeType

EditableSourceRoot

json
{
  "name": "string",
  "parent": "string",
  "parentNodeType": "string",
  "treeNodeType": "Folder"
}

Varicent.RESTAPI.v1.DTOs.ReportVariableDTO

Properties

Name

Type

Required

Restrictions

Description

value

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

variableName

string¦null

false

none

none

variableType

string

false

none

none

Enumerated Values

Property

Value

variableType

Literal

variableType

Parameter

variableType

Scalar

json
{
  "value": {
    "expressionType": "caseExpression",
    "cases": [],
    "table": "string",
    "column": "string",
    "op": "string",
    "arguments": [
      {}
    ],
    "condition": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": null,
      "dataFieldRight": {},
      "right": null,
      "expressionLeft": null,
      "expressionRight": null,
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "trueValue": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "falseValue": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "isDate": true,
    "literalType": "Integer",
    "value": null
  },
  "variableName": "string",
  "variableType": "Literal"
}

Varicent.RESTAPI.v1.DTOs.ResultSetDTO

Properties

Name

Type

Required

Restrictions

Description

columnDefinitions

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

none

data

[any]¦null

false

none

none

columnSourceMap

object¦null

false

none

none

» additionalProperties

string¦null

false

none

none

isDataSynced

boolean¦null

false

none

none

hierarchyMetadata

RESTAPI.v1.DTOs.Hierarchy.HierarchyMetadataDTO

false

none

none

json
{
  "columnDefinitions": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "data": [
    null
  ],
  "columnSourceMap": {
    "property1": "string",
    "property2": "string"
  },
  "isDataSynced": true,
  "hierarchyMetadata": {
    "tableName": "string",
    "idColumnName": "string",
    "parentColumnName": "string"
  }
}

Varicent.RESTAPI.v1.DTOs.RoleDefinitionDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

name

string¦null

false

none

none

displayName

string¦null

false

none

none

permissions

[Varicent.RESTAPI.v1.DTOs.RolePermissionDTO]¦null

false

none

none

permissionPaths

[string]¦null

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "id": 0,
  "name": "string",
  "displayName": "string",
  "permissions": [
    {
      "path": "string",
      "name": "string"
    }
  ],
  "permissionPaths": [
    "string"
  ],
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.RoleDefinitionNameDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

name

string¦null

false

none

none

displayName

string¦null

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "id": 0,
  "name": "string",
  "displayName": "string",
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.RolePermissionDTO

Properties

Name

Type

Required

Restrictions

Description

path

string¦null

false

none

none

name

string¦null

false

none

none

json
{
  "path": "string",
  "name": "string"
}

Varicent.RESTAPI.v1.DTOs.RowChangeDTO

Properties

Name

Type

Required

Restrictions

Description

start

[any]¦null

false

none

none

end

[any]¦null

false

none

none

rowChangeDiff

Varicent.RESTAPI.v1.DTOs.RowChangeSummaryDTO

false

none

none

json
{
  "start": [
    null
  ],
  "end": [
    null
  ],
  "rowChangeDiff": {
    "previous": {
      "savedBy": "string",
      "savedAt": "2019-08-24T14:15:22Z",
      "values": []
    },
    "selected": {
      "savedBy": "string",
      "savedAt": "2019-08-24T14:15:22Z",
      "values": []
    },
    "current": {
      "savedBy": "string",
      "savedAt": "2019-08-24T14:15:22Z",
      "values": []
    },
    "hasPrevious": true,
    "hasSelected": true,
    "hasCurrent": true
  }
}

Varicent.RESTAPI.v1.DTOs.RowChangeSummaryDTO

Properties

Name

Type

Required

Restrictions

Description

previous

Varicent.RESTAPI.v1.DTOs.RowSnapshotDTO

false

none

none

selected

Varicent.RESTAPI.v1.DTOs.RowSnapshotDTO

false

none

none

current

Varicent.RESTAPI.v1.DTOs.RowSnapshotDTO

false

none

none

hasPrevious

boolean

false

none

none

hasSelected

boolean

false

none

none

hasCurrent

boolean

false

none

none

json
{
  "previous": {
    "savedBy": "string",
    "savedAt": "2019-08-24T14:15:22Z",
    "values": [
      null
    ]
  },
  "selected": {
    "savedBy": "string",
    "savedAt": "2019-08-24T14:15:22Z",
    "values": [
      null
    ]
  },
  "current": {
    "savedBy": "string",
    "savedAt": "2019-08-24T14:15:22Z",
    "values": [
      null
    ]
  },
  "hasPrevious": true,
  "hasSelected": true,
  "hasCurrent": true
}

Varicent.RESTAPI.v1.DTOs.RowSnapshotDTO

Properties

Name

Type

Required

Restrictions

Description

savedBy

string¦null

false

none

none

savedAt

string(date-time)

false

none

none

values

[any]¦null

false

none

none

json
{
  "savedBy": "string",
  "savedAt": "2019-08-24T14:15:22Z",
  "values": [
    null
  ]
}

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

Properties

Name

Type

Required

Restrictions

Description

rowVersion

integer(int64)

false

none

none

json
{
  "rowVersion": 0
}

Varicent.RESTAPI.v1.DTOs.RowViewerDTO

Properties

Name

Type

Required

Restrictions

Description

rows

[any]¦null

false

none

none

json
{
  "rows": [
    null
  ]
}

Varicent.RESTAPI.v1.DTOs.RowViewerHistoryDTO

Properties

Name

Type

Required

Restrictions

Description

timeId

string¦null

false

none

none

rows

[any]¦null

false

none

none

json
{
  "timeId": "string",
  "rows": [
    null
  ]
}

Varicent.RESTAPI.v1.DTOs.RowViewerMultiRowWriteDTO

Properties

Name

Type

Required

Restrictions

Description

overwrite

[boolean]¦null

false

none

none

selectedColumns

[string]¦null

false

none

none

ignoreOriginalRows

boolean¦null

false

none

none

effectiveDate

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

rows

[any]¦null

false

none

none

json
{
  "overwrite": [
    true
  ],
  "selectedColumns": [
    "string"
  ],
  "ignoreOriginalRows": true,
  "effectiveDate": {},
  "rows": [
    null
  ]
}

Varicent.RESTAPI.v1.DTOs.RowViewerOverwriteDTO

Properties

Name

Type

Required

Restrictions

Description

columnDefinitions

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

none

existingRows

[any]¦null

false

none

none

overwriteRows

[any]¦null

false

none

none

endDateChanged

boolean

false

none

none

json
{
  "columnDefinitions": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "existingRows": [
    null
  ],
  "overwriteRows": [
    null
  ],
  "endDateChanged": true
}

Varicent.RESTAPI.v1.DTOs.RowViewerPatchDTO

Properties

Name

Type

Required

Restrictions

Description

oldRows

[any]¦null

false

none

none

overwrite

[boolean]¦null

false

none

none

selectedColumns

[string]¦null

false

none

none

ignoreOriginalRows

boolean¦null

false

none

none

effectiveDate

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

rows

[any]¦null

false

none

none

json
{
  "oldRows": [
    null
  ],
  "overwrite": [
    true
  ],
  "selectedColumns": [
    "string"
  ],
  "ignoreOriginalRows": true,
  "effectiveDate": {},
  "rows": [
    null
  ]
}

Varicent.RESTAPI.v1.DTOs.RowViewerPatchOverwriteDTO

Properties

Name

Type

Required

Restrictions

Description

columnDefinitions

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

none

existingRows

[array]¦null

false

none

none

overwriteRows

[array]¦null

false

none

none

json
{
  "columnDefinitions": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "existingRows": [
    [
      null
    ]
  ],
  "overwriteRows": [
    [
      null
    ]
  ]
}

Varicent.RESTAPI.v1.DTOs.RowViewerUpdateDTO

Properties

Name

Type

Required

Restrictions

Description

oldRows

[any]¦null

false

none

none

overwrite

boolean¦null

false

none

none

effectiveDate

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

rows

[any]¦null

false

none

none

json
{
  "oldRows": [
    null
  ],
  "overwrite": true,
  "effectiveDate": {},
  "rows": [
    null
  ]
}

Varicent.RESTAPI.v1.DTOs.RowViewerVersionDTO

Properties

Name

Type

Required

Restrictions

Description

option

string¦null

false

none

none

rows

[any]¦null

false

none

none

Enumerated Values

Property

Value

option

None

option

FromPast

option

FromFuture

json
{
  "option": "None",
  "rows": [
    null
  ]
}

Varicent.RESTAPI.v1.DTOs.RowViewerWriteDTO

Properties

Name

Type

Required

Restrictions

Description

overwrite

boolean¦null

false

none

none

effectiveDate

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

rows

[any]¦null

false

none

none

json
{
  "overwrite": true,
  "effectiveDate": {},
  "rows": [
    null
  ]
}

Varicent.RESTAPI.v1.DTOs.RunQueryDTO

Properties

Name

Type

Required

Restrictions

Description

limit

integer(int32)

false

none

none

offset

integer(int32)

false

none

none

timeout

integer(int32)

false

none

none

retrieveFromDataServer

string

false

none

none

exportFileFormat

string

false

none

none

Enumerated Values

Property

Value

retrieveFromDataServer

QUERY_SQL

retrieveFromDataServer

QUERY_SPARK

retrieveFromDataServer

QUERY_PRESTO

exportFileFormat

Excel

exportFileFormat

MSCRM

exportFileFormat

Pdf

exportFileFormat

Salesforce

exportFileFormat

Text

exportFileFormat

COS

exportFileFormat

Zip

json
{
  "limit": 0,
  "offset": 0,
  "timeout": 0,
  "retrieveFromDataServer": "QUERY_SQL",
  "exportFileFormat": "Excel"
}

Varicent.RESTAPI.v1.DTOs.RunQueryDefinitionDTO

Properties

Name

Type

Required

Restrictions

Description

query

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

limit

integer(int32)

false

none

none

offset

integer(int32)

false

none

none

timeout

integer(int32)

false

none

none

retrieveFromDataServer

string

false

none

none

exportFileFormat

string

false

none

none

Enumerated Values

Property

Value

retrieveFromDataServer

QUERY_SQL

retrieveFromDataServer

QUERY_SPARK

retrieveFromDataServer

QUERY_PRESTO

exportFileFormat

Excel

exportFileFormat

MSCRM

exportFileFormat

Pdf

exportFileFormat

Salesforce

exportFileFormat

Text

exportFileFormat

COS

exportFileFormat

Zip

json
{
  "query": {
    "selectItems": [
      {}
    ],
    "source": {
      "namespaceTable": {},
      "query": null,
      "alias": "string",
      "sourceType": "Table"
    },
    "joins": [
      {}
    ],
    "whereClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "order": [
      {}
    ],
    "group": [
      {}
    ],
    "havingClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "distinct": true,
    "unionWith": null,
    "exceptWith": null
  },
  "limit": 0,
  "offset": 0,
  "timeout": 0,
  "retrieveFromDataServer": "QUERY_SQL",
  "exportFileFormat": "Excel"
}

Varicent.RESTAPI.v1.DTOs.SQL.CaseExpressionDTO+CaseDTO

Properties

None

json
{}

Varicent.RESTAPI.v1.DTOs.SQL.ClauseDTO

Properties

Name

Type

Required

Restrictions

Description

constraintType

string

false

none

none

op

string¦null

false

none

none

dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

caseSensitive

boolean

false

none

none

constraints

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

none

[DTO version of IConstraint]

literalRight

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

right

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

expressionLeft

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

expressionRight

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

isPreciseDecimal

boolean

false

none

none

like

string¦null

false

none

none

escapeWildcards

boolean

false

none

none

rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

table

string¦null

false

none

none

queryDefinitionRight

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

Enumerated Values

Property

Value

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

json
{
  "constraintType": "clause",
  "op": "string",
  "dataFieldLeft": {
    "expressionType": "caseExpression",
    "cases": [],
    "table": "string",
    "column": "string",
    "op": "string",
    "arguments": [],
    "condition": null,
    "trueValue": null,
    "falseValue": null,
    "isDate": true,
    "literalType": "Integer",
    "value": null
  },
  "caseSensitive": true,
  "constraints": [
    {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": null,
      "dataFieldRight": {},
      "right": null,
      "expressionLeft": null,
      "expressionRight": null,
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    }
  ],
  "literalRight": {
    "expressionType": "caseExpression",
    "cases": [],
    "table": "string",
    "column": "string",
    "op": "string",
    "arguments": [
      {}
    ],
    "condition": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": null,
      "dataFieldRight": {},
      "right": null,
      "expressionLeft": null,
      "expressionRight": null,
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "trueValue": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "falseValue": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "isDate": true,
    "literalType": "Integer",
    "value": null
  },
  "dataFieldRight": {
    "expressionType": "caseExpression",
    "cases": [],
    "table": "string",
    "column": "string",
    "op": "string",
    "arguments": [],
    "condition": null,
    "trueValue": null,
    "falseValue": null,
    "isDate": true,
    "literalType": "Integer",
    "value": null
  },
  "right": {
    "expressionType": "caseExpression",
    "cases": [],
    "table": "string",
    "column": "string",
    "op": "string",
    "arguments": [],
    "condition": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": null,
      "dataFieldRight": {},
      "right": null,
      "expressionLeft": null,
      "expressionRight": null,
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "trueValue": null,
    "falseValue": null,
    "isDate": true,
    "literalType": "Integer",
    "value": null
  },
  "expressionLeft": {
    "expressionType": "caseExpression",
    "cases": [],
    "table": "string",
    "column": "string",
    "op": "string",
    "arguments": [],
    "condition": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": null,
      "dataFieldRight": {},
      "right": null,
      "expressionLeft": null,
      "expressionRight": null,
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "trueValue": null,
    "falseValue": null,
    "isDate": true,
    "literalType": "Integer",
    "value": null
  },
  "expressionRight": {
    "expressionType": "caseExpression",
    "cases": [],
    "table": "string",
    "column": "string",
    "op": "string",
    "arguments": [],
    "condition": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": null,
      "dataFieldRight": {},
      "right": null,
      "expressionLeft": null,
      "expressionRight": null,
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "trueValue": null,
    "falseValue": null,
    "isDate": true,
    "literalType": "Integer",
    "value": null
  },
  "isPreciseDecimal": true,
  "like": "string",
  "escapeWildcards": true,
  "rowVersion": {
    "rowVersion": 0
  },
  "table": "string",
  "queryDefinitionRight": null
}

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

DTO version of IConstraint

Properties

Name

Type

Required

Restrictions

Description

constraintType

string

false

none

none

op

string¦null

false

none

none

dataFieldLeft

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

caseSensitive

boolean

false

none

none

constraints

[Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO]¦null

false

none

none

literalRight

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

dataFieldRight

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

false

none

none

right

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

none

expressionLeft

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

none

expressionRight

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

none

isPreciseDecimal

boolean

false

none

none

like

string¦null

false

none

none

escapeWildcards

boolean

false

none

none

rowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

table

string¦null

false

none

none

queryDefinitionRight

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

Enumerated Values

Property

Value

constraintType

clause

constraintType

constraint

constraintType

expressionConstraint

constraintType

likeConstraint

constraintType

rowVersionConstraint

constraintType

subQueryConstraint

json
{
  "constraintType": "clause",
  "op": "string",
  "dataFieldLeft": {
    "expressionType": "caseExpression",
    "cases": [],
    "table": "string",
    "column": "string",
    "op": "string",
    "arguments": [],
    "condition": null,
    "trueValue": null,
    "falseValue": null,
    "isDate": true,
    "literalType": "Integer",
    "value": null
  },
  "caseSensitive": true,
  "constraints": [],
  "literalRight": null,
  "dataFieldRight": {
    "expressionType": "caseExpression",
    "cases": [],
    "table": "string",
    "column": "string",
    "op": "string",
    "arguments": [],
    "condition": null,
    "trueValue": null,
    "falseValue": null,
    "isDate": true,
    "literalType": "Integer",
    "value": null
  },
  "right": null,
  "expressionLeft": null,
  "expressionRight": null,
  "isPreciseDecimal": true,
  "like": "string",
  "escapeWildcards": true,
  "rowVersion": {
    "rowVersion": 0
  },
  "table": "string",
  "queryDefinitionRight": null
}

Varicent.RESTAPI.v1.DTOs.SQL.DataFieldDTO

Properties

Name

Type

Required

Restrictions

Description

expressionType

string

false

none

none

cases

[Varicent.RESTAPI.v1.DTOs.SQL.CaseExpressionDTO+CaseDTO]¦null

false

none

none

table

string¦null

false

none

none

column

string¦null

false

none

none

op

string¦null

false

none

none

arguments

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

none

none

condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

none

trueValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

none

falseValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

none

isDate

boolean

false

none

none

literalType

string

false

none

none

value

any

false

none

none

Enumerated Values

Property

Value

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

json
{
  "expressionType": "caseExpression",
  "cases": [],
  "table": "string",
  "column": "string",
  "op": "string",
  "arguments": [],
  "condition": null,
  "trueValue": null,
  "falseValue": null,
  "isDate": true,
  "literalType": "Integer",
  "value": null
}

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

DTO version of IExpression

Properties

Name

Type

Required

Restrictions

Description

expressionType

string

false

none

none

cases

[Varicent.RESTAPI.v1.DTOs.SQL.CaseExpressionDTO+CaseDTO]¦null

false

none

none

table

string¦null

false

none

none

column

string¦null

false

none

none

op

string¦null

false

none

none

arguments

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

none

none

condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

trueValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

none

falseValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

none

isDate

boolean

false

none

none

literalType

string

false

none

none

value

any

false

none

none

Enumerated Values

Property

Value

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

json
{
  "expressionType": "caseExpression",
  "cases": [],
  "table": "string",
  "column": "string",
  "op": "string",
  "arguments": [],
  "condition": {
    "constraintType": "clause",
    "op": "string",
    "dataFieldLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "caseSensitive": true,
    "constraints": [],
    "literalRight": null,
    "dataFieldRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "right": null,
    "expressionLeft": null,
    "expressionRight": null,
    "isPreciseDecimal": true,
    "like": "string",
    "escapeWildcards": true,
    "rowVersion": {
      "rowVersion": 0
    },
    "table": "string",
    "queryDefinitionRight": null
  },
  "trueValue": null,
  "falseValue": null,
  "isDate": true,
  "literalType": "Integer",
  "value": null
}

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

Properties

Name

Type

Required

Restrictions

Description

expressionType

string

false

none

none

cases

[Varicent.RESTAPI.v1.DTOs.SQL.CaseExpressionDTO+CaseDTO]¦null

false

none

none

table

string¦null

false

none

none

column

string¦null

false

none

none

op

string¦null

false

none

none

arguments

[Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO]¦null

false

none

[DTO version of IExpression]

condition

Varicent.RESTAPI.v1.DTOs.SQL.ConstraintBaseDTO

false

none

DTO version of IConstraint

trueValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

falseValue

Varicent.RESTAPI.v1.DTOs.SQL.ExpressionBaseDTO

false

none

DTO version of IExpression

isDate

boolean

false

none

none

literalType

string

false

none

none

value

any

false

none

none

Enumerated Values

Property

Value

expressionType

caseExpression

expressionType

dataField

expressionType

function

expressionType

ifExpression

expressionType

literal

literalType

Integer

literalType

Decimal

literalType

Date

literalType

DateTime

literalType

String

literalType

Float

literalType

Long

literalType

Null

literalType

Parameter

literalType

Guid

literalType

SystemUtcTime

literalType

Boolean

json
{
  "expressionType": "caseExpression",
  "cases": [],
  "table": "string",
  "column": "string",
  "op": "string",
  "arguments": [
    {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    }
  ],
  "condition": {
    "constraintType": "clause",
    "op": "string",
    "dataFieldLeft": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "caseSensitive": true,
    "constraints": [],
    "literalRight": null,
    "dataFieldRight": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": null,
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "right": null,
    "expressionLeft": null,
    "expressionRight": null,
    "isPreciseDecimal": true,
    "like": "string",
    "escapeWildcards": true,
    "rowVersion": {
      "rowVersion": 0
    },
    "table": "string",
    "queryDefinitionRight": null
  },
  "trueValue": {
    "expressionType": "caseExpression",
    "cases": [],
    "table": "string",
    "column": "string",
    "op": "string",
    "arguments": [],
    "condition": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": null,
      "dataFieldRight": {},
      "right": null,
      "expressionLeft": null,
      "expressionRight": null,
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "trueValue": null,
    "falseValue": null,
    "isDate": true,
    "literalType": "Integer",
    "value": null
  },
  "falseValue": {
    "expressionType": "caseExpression",
    "cases": [],
    "table": "string",
    "column": "string",
    "op": "string",
    "arguments": [],
    "condition": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": null,
      "dataFieldRight": {},
      "right": null,
      "expressionLeft": null,
      "expressionRight": null,
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "trueValue": null,
    "falseValue": null,
    "isDate": true,
    "literalType": "Integer",
    "value": null
  },
  "isDate": true,
  "literalType": "Integer",
  "value": null
}

Varicent.RESTAPI.v1.DTOs.ScalarDisplayStyleDTO

Properties

Name

Type

Required

Restrictions

Description

style

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

none

displayBorders

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

none

displayPadding

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

none

json
{
  "style": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "displayBorders": {
    "bottom": {
      "color": {},
      "width": 0.1
    },
    "left": {
      "color": {},
      "width": 0.1
    },
    "right": {
      "color": {},
      "width": 0.1
    },
    "top": {
      "color": {},
      "width": 0.1
    }
  },
  "displayPadding": {
    "bottom": 0.1,
    "left": 0.1,
    "right": 0.1,
    "top": 0.1
  }
}

Varicent.RESTAPI.v1.DTOs.Scenarios.CandidateScenarioItemDTO

Properties

Name

Type

Required

Restrictions

Description

elementID

integer(int32)

false

none

none

name

string¦null

false

none

none

type

string

false

none

none

sourceTableName

string¦null

false

none

none

Enumerated Values

Property

Value

type

Table

type

Calculation

json
{
  "elementID": 0,
  "name": "string",
  "type": "Table",
  "sourceTableName": "string"
}

Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioCalculationDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

elementId

integer(int32)

false

none

none

calculationId

integer(int32)

false

none

none

payeeGroupId

string¦null

false

none

none

json
{
  "id": 0,
  "elementId": 0,
  "calculationId": 0,
  "payeeGroupId": "string"
}

Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioChangeBaseDTO

Properties

Name

Type

Required

Restrictions

Description

tableName

string¦null

false

none

none

addedRows

[array]¦null

false

none

none

editedRows

[array]¦null

false

none

none

deletedRows

[array]¦null

false

none

none

changeQuery

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

field

string¦null

false

none

none

adjustOp

string

false

none

none

adjustOperand

number(double)

false

none

none

multiplyPercent

number(double)

false

none

none

replaceType

string

false

none

none

replaceValue

any

false

none

none

changeType

string

false

none

none

Enumerated Values

Property

Value

adjustOp

Add

adjustOp

Multiply

replaceType

Text

replaceType

Decimal

replaceType

Date

changeType

rowChange

changeType

adjustTransform

changeType

replaceTransform

json
{
  "tableName": "string",
  "addedRows": [
    [
      null
    ]
  ],
  "editedRows": [
    [
      null
    ]
  ],
  "deletedRows": [
    [
      null
    ]
  ],
  "changeQuery": {
    "selectItems": [
      {}
    ],
    "source": {
      "namespaceTable": {},
      "query": null,
      "alias": "string",
      "sourceType": "Table"
    },
    "joins": [
      {}
    ],
    "whereClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "order": [
      {}
    ],
    "group": [
      {}
    ],
    "havingClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "distinct": true,
    "unionWith": null,
    "exceptWith": null
  },
  "field": "string",
  "adjustOp": "Add",
  "adjustOperand": 0.1,
  "multiplyPercent": 0.1,
  "replaceType": "Text",
  "replaceValue": null,
  "changeType": "rowChange"
}

Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioChangeSetDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

sequenceNo

integer(int32)

false

none

none

name

string¦null

false

none

none

description

string¦null

false

none

none

changeType

string

false

none

none

calendarPeriodRange

Varicent.RESTAPI.v1.DTOs.Scenarios.SimpleCalendarPeriodRangeDTO

false

none

none

scenarioChange

Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioChangeBaseDTO

false

none

none

Enumerated Values

Property

Value

changeType

Transform

changeType

RowChange

json
{
  "id": 0,
  "sequenceNo": 0,
  "name": "string",
  "description": "string",
  "changeType": "Transform",
  "calendarPeriodRange": {
    "timeId": "string",
    "startPeriod": "string",
    "endPeriod": "string"
  },
  "scenarioChange": {
    "tableName": "string",
    "addedRows": [
      []
    ],
    "editedRows": [
      []
    ],
    "deletedRows": [
      []
    ],
    "changeQuery": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "field": "string",
    "adjustOp": "Add",
    "adjustOperand": 0.1,
    "multiplyPercent": 0.1,
    "replaceType": "Text",
    "replaceValue": null,
    "changeType": "rowChange"
  }
}

Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

workspaceId

integer(int32)

false

none

none

name

string¦null

false

none

none

description

string¦null

false

none

none

scenarioItems

Varicent.RESTAPI.v1.DTOs.ExpandableResourceDTO

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "id": 0,
  "workspaceId": 0,
  "name": "string",
  "description": "string",
  "scenarioItems": {
    "href": "string"
  },
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioItemDTO

Properties

Name

Type

Required

Restrictions

Description

elementId

integer(int32)

false

none

none

name

string¦null

false

none

none

type

string

false

none

none

sourceTableName

string¦null

false

none

none

changeSets

Varicent.RESTAPI.v1.DTOs.ExpandableResourceDTO

false

none

none

isPromoted

boolean

false

none

none

isFrozen

boolean

false

none

none

order

integer(int32)

false

none

none

Enumerated Values

Property

Value

type

Table

type

Calculation

json
{
  "elementId": 0,
  "name": "string",
  "type": "Table",
  "sourceTableName": "string",
  "changeSets": {
    "href": "string"
  },
  "isPromoted": true,
  "isFrozen": true,
  "order": 0
}

Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioReportItemDTO

Properties

Name

Type

Required

Restrictions

Description

baseEarnings

number(double)

false

none

none

scenarioEarnings

number(double)

false

none

none

json
{
  "baseEarnings": 0.1,
  "scenarioEarnings": 0.1
}

Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioReportRequestDTO

Properties

Name

Type

Required

Restrictions

Description

reportType

string

false

none

none

baseScenarioID

integer(int32)

false

none

none

targetScenarioID

integer(int32)

false

none

none

selectedPeriod

string¦null

false

none

none

selectedScenarioCalc

integer(int32)

false

none

none

selectedPayee

string¦null

false

none

none

Enumerated Values

Property

Value

reportType

PeriodComparison

reportType

PayeeComparison

json
{
  "reportType": "PeriodComparison",
  "baseScenarioID": 0,
  "targetScenarioID": 0,
  "selectedPeriod": "string",
  "selectedScenarioCalc": 0,
  "selectedPayee": "string"
}

Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioWorkspaceDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

isBaseCalculated

boolean

false

none

none

name

string¦null

false

none

none

description

string¦null

false

none

none

owner

string¦null

false

none

none

accessibilityType

string

false

none

none

startDate

string(date-time)

false

none

none

endDate

string(date-time)

false

none

none

scenarios

Varicent.RESTAPI.v1.DTOs.ExpandableResourceDTO

false

none

none

scenarioCalcs

[Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioCalculationDTO]¦null

false

none

none

calendarPeriodRanges

[Varicent.RESTAPI.v1.DTOs.Scenarios.SimpleCalendarPeriodRangeDTO]¦null

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

accessibilityType

Private

accessibilityType

Public

json
{
  "id": 0,
  "isBaseCalculated": true,
  "name": "string",
  "description": "string",
  "owner": "string",
  "accessibilityType": "Private",
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "scenarios": {
    "href": "string"
  },
  "scenarioCalcs": [
    {
      "id": 0,
      "elementId": 0,
      "calculationId": 0,
      "payeeGroupId": "string"
    }
  ],
  "calendarPeriodRanges": [
    {
      "timeId": "string",
      "startPeriod": "string",
      "endPeriod": "string"
    }
  ],
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioWorkspaceNameDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

name

string¦null

false

none

none

description

string¦null

false

none

none

json
{
  "id": 0,
  "name": "string",
  "description": "string"
}

Varicent.RESTAPI.v1.DTOs.Scenarios.ScenarioWorkspacePatchDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

description

string¦null

false

none

none

accessType

string¦null

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

accessType

Private

accessType

Public

json
{
  "name": "string",
  "description": "string",
  "accessType": "Private",
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.Scenarios.SimpleCalendarPeriodRangeDTO

Properties

Name

Type

Required

Restrictions

Description

timeId

string¦null

false

none

none

startPeriod

string¦null

false

none

none

endPeriod

string¦null

false

none

none

json
{
  "timeId": "string",
  "startPeriod": "string",
  "endPeriod": "string"
}

Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

name

string¦null

false

none

none

scheduleItemType

string

false

none

none

order

integer(int32)

false

none

none

lastRun

string(date-time)

false

none

none

lastRunStatus

string

false

none

none

activation

string

false

none

none

nextRun

string(date-time)

false

none

none

parent

integer(int32)¦null

false

none

none

scheduledTime

Varicent.RESTAPI.v1.DTOs.Scheduler.ScheduleTimeDTO

false

none

none

parentItem

Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO

false

none

none

childScheduleItems

[Varicent.RESTAPI.v1.DTOs.ScheduleItemDTO]¦null

false

none

none

settings

RESTAPI.v1.DTOs.Scheduler.SchedulerSettingsDTO

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

previousName

string¦null

false

none

none

runInParallel

boolean

false

none

none

externalItemID

string¦null

false

none

none

ptzId

string¦null

false

none

none

Enumerated Values

Property

Value

scheduleItemType

Folder

scheduleItemType

Calculation

scheduleItemType

Import

scheduleItemType

ExternalTool

scheduleItemType

TaskGeneration

scheduleItemType

StarSchemaPopulation

scheduleItemType

LockPeriod

scheduleItemType

EnableWeb

scheduleItemType

DisableWeb

scheduleItemType

Plan

scheduleItemType

Transformation

scheduleItemType

ClearTable

scheduleItemType

Publish

scheduleItemType

WebReport

scheduleItemType

Optimize

scheduleItemType

TaskRun

scheduleItemType

AddWorkflowMembers

scheduleItemType

UnassignIdleInquiries

scheduleItemType

PurgeHistory

scheduleItemType

ExpiringPasswordEmailNotificationAdmin

scheduleItemType

ExpiringPasswordEmailNotificationWeb

scheduleItemType

EnableWebUsers

scheduleItemType

CloudExternalTool

scheduleItemType

CloudSystemTool

scheduleItemType

IndexRebuild

scheduleItemType

PublishQueryTool

scheduleItemType

CalculateAndLock

scheduleItemType

HealthDashboardEvaluation

scheduleItemType

CalculationComponent

scheduleItemType

RefreshMaterializedView

scheduleItemType

RemoveWorkflowMembers

scheduleItemType

ELTRun

scheduleItemType

CalculationPlanBuilder

lastRunStatus

Success

lastRunStatus

Warning

lastRunStatus

Error

lastRunStatus

Cancelled

lastRunStatus

None

activation

Enabled

activation

DisabledForNextScheduledRunOnly

activation

Disabled

json
{
  "id": 0,
  "name": "string",
  "scheduleItemType": "Folder",
  "order": 0,
  "lastRun": "2019-08-24T14:15:22Z",
  "lastRunStatus": "Success",
  "activation": "Enabled",
  "nextRun": "2019-08-24T14:15:22Z",
  "parent": 0,
  "scheduledTime": {
    "id": 0,
    "scheduleItemId": 0,
    "minute": 0,
    "hour": 0,
    "dayOfMonth": 0,
    "month": 0,
    "dayOfWeek": 0,
    "nextRunTime": "2019-08-24T14:15:22Z",
    "isDSTAdjusted": true,
    "version": {
      "rowVersion": 0
    }
  },
  "parentItem": null,
  "childScheduleItems": [],
  "settings": {
    "schedulerSettingsId": 0,
    "scheduleItemId": 0,
    "parentSettingsID": 0,
    "emailOnFailure": true,
    "emailOnSuccess": true,
    "stopOnFailure": true,
    "stopToolOnTimeout": true,
    "isGlobal": true,
    "overrideChildSettings": true,
    "successEmails": [
      "string"
    ],
    "failEmails": [
      "string"
    ],
    "externalToolTimeout": 0,
    "parentSettings": null,
    "enableRetries": true,
    "retries": 0,
    "interval": 0,
    "version": {
      "rowVersion": 0
    }
  },
  "version": {
    "rowVersion": 0
  },
  "previousName": "string",
  "runInParallel": true,
  "externalItemID": "string",
  "ptzId": "string"
}

Varicent.RESTAPI.v1.DTOs.Scheduler.ScheduleItemWorkflowExpiryDTO

Properties

Name

Type

Required

Restrictions

Description

nextRunTime

string(date-time)

false

none

none

tokenID

integer(int32)

false

none

none

json
{
  "nextRunTime": "2019-08-24T14:15:22Z",
  "tokenID": 0
}

Varicent.RESTAPI.v1.DTOs.Scheduler.ScheduleTimeDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

scheduleItemId

integer(int32)

false

none

none

minute

integer(int32)

false

none

none

hour

integer(int32)

false

none

none

dayOfMonth

integer(int32)

false

none

none

month

integer(int32)

false

none

none

dayOfWeek

integer(int32)

false

none

none

nextRunTime

string(date-time)

false

none

none

isDSTAdjusted

boolean¦null

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "id": 0,
  "scheduleItemId": 0,
  "minute": 0,
  "hour": 0,
  "dayOfMonth": 0,
  "month": 0,
  "dayOfWeek": 0,
  "nextRunTime": "2019-08-24T14:15:22Z",
  "isDSTAdjusted": true,
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

type

string

false

none

none

isKey

boolean

false

none

none

nullable

boolean

false

none

none

values

string¦null

false

none

none

lockedPeriod

RESTAPI.v1.DTOs.SimplePeriodDTO

false

none

none

referencedCol

string¦null

false

none

none

picklistFilter

string¦null

false

none

none

displayName

string¦null

false

none

none

isELTPeriod

boolean¦null

false

none

none

Enumerated Values

Property

Value

type

String

type

LongString

type

MaxString

type

Date

type

DateTime

type

Decimal

type

Int

type

Long

type

Float

type

BLOB

type

Identity

type

CLOB

type

RowVersion

type

UID

type

VarCharMax

type

Boolean

json
{
  "name": "string",
  "type": "String",
  "isKey": true,
  "nullable": true,
  "values": "string",
  "lockedPeriod": {
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z"
  },
  "referencedCol": "string",
  "picklistFilter": "string",
  "displayName": "string",
  "isELTPeriod": true
}

Varicent.RESTAPI.v1.DTOs.SchemaQualifiedTableNameDTO

Properties

Name

Type

Required

Restrictions

Description

m_namespace

string¦null

false

none

none

name

string¦null

false

none

none

json
{
  "m_namespace": "string",
  "name": "string"
}

Varicent.RESTAPI.v1.DTOs.SearchItemDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

parentBlockId

integer(int32)

false

none

none

name

string¦null

false

none

none

type

string

false

none

none

subType

string

false

none

none

calculationType

string

false

none

none

canView

boolean

false

none

none

blockId

integer(int32)¦null

false

none

none

details

string¦null

false

none

none

Enumerated Values

Property

Value

type

Block

type

Table

type

Calculation

type

Plan

type

TailoredReport

type

WebForm

type

WebReport

type

InputPort

type

OutputPort

type

Library

type

DataStore

type

AssignTable

type

Hub

type

Waypoint

type

InsertionPoint

subType

None

subType

InsertionPoint

subType

Waypoint

calculationType

Mathematical

calculationType

Sorting

calculationType

TimeShift

calculationType

Category

calculationType

Symon

json
{
  "id": 0,
  "parentBlockId": 0,
  "name": "string",
  "type": "Block",
  "subType": "None",
  "calculationType": "Mathematical",
  "canView": true,
  "blockId": 0,
  "details": "string"
}

Varicent.RESTAPI.v1.DTOs.SectionDisplayDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

frequency

Varicent.RESTAPI.v1.DTOs.FrequencyDTO

false

none

none

sources

[Varicent.RESTAPI.v1.DTOs.SourceInfoDTO]¦null

false

none

none

sectionDisplayStyle

Varicent.RESTAPI.v1.DTOs.ScalarDisplayStyleDTO

false

none

none

json
{
  "name": "string",
  "frequency": {
    "levelId": "string",
    "timeId": "string"
  },
  "sources": [
    {
      "columnMapping": {},
      "valueColumn": "string",
      "sourceName": "string",
      "sectionStyle": {},
      "format": {},
      "dateFormat": {}
    }
  ],
  "sectionDisplayStyle": {
    "style": {
      "alignment": "Justify",
      "backColor": {},
      "font": {},
      "foreColor": {}
    },
    "displayBorders": {
      "bottom": {},
      "left": {},
      "right": {},
      "top": {}
    },
    "displayPadding": {
      "bottom": 0.1,
      "left": 0.1,
      "right": 0.1,
      "top": 0.1
    }
  }
}

Varicent.RESTAPI.v1.DTOs.SelectItemDTO

Properties

Name

Type

Required

Restrictions

Description

alias

string¦null

false

none

none

column

string¦null

false

none

none

table

string¦null

false

none

none

customSelect

string¦null

false

none

none

dataType

string

false

none

none

type

string

false

none

none

value

Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO Varicent.RESTAPI.v1.DTOs.SQL.LiteralDTO

false

none

none

Enumerated Values

Property

Value

dataType

Int

dataType

Decimal

dataType

DateTime

dataType

None

dataType

String

type

SelectAll

type

SelectItem

type

SelectLiteral

type

SelectCustom

type

SelectExpression

json
{
  "alias": "string",
  "column": "string",
  "table": "string",
  "customSelect": "string",
  "dataType": "Int",
  "type": "SelectAll",
  "value": {
    "expressionType": "caseExpression",
    "cases": [],
    "table": "string",
    "column": "string",
    "op": "string",
    "arguments": [
      {}
    ],
    "condition": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": null,
      "dataFieldRight": {},
      "right": null,
      "expressionLeft": null,
      "expressionRight": null,
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "trueValue": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "falseValue": {
      "expressionType": "caseExpression",
      "cases": [],
      "table": "string",
      "column": "string",
      "op": "string",
      "arguments": [],
      "condition": {},
      "trueValue": null,
      "falseValue": null,
      "isDate": true,
      "literalType": "Integer",
      "value": null
    },
    "isDate": true,
    "literalType": "Integer",
    "value": null
  }
}

Varicent.RESTAPI.v1.DTOs.SortingInfoDTO

Properties

Name

Type

Required

Restrictions

Description

levelId

string¦null

false

none

none

sortDescending

boolean

false

none

none

timeId

string¦null

false

none

none

sortedByName

boolean

false

none

none

json
{
  "levelId": "string",
  "sortDescending": true,
  "timeId": "string",
  "sortedByName": true
}

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

Properties

Name

Type

Required

Restrictions

Description

query

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

sourceNames

object¦null

false

none

none

» additionalProperties

string¦null

false

none

none

json
{
  "query": {
    "selectItems": [
      {}
    ],
    "source": {
      "namespaceTable": {},
      "query": null,
      "alias": "string",
      "sourceType": "Table"
    },
    "joins": [
      {}
    ],
    "whereClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "order": [
      {}
    ],
    "group": [
      {}
    ],
    "havingClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "distinct": true,
    "unionWith": null,
    "exceptWith": null
  },
  "sourceNames": {
    "property1": "string",
    "property2": "string"
  }
}

Varicent.RESTAPI.v1.DTOs.SourceInfoDTO

Properties

Name

Type

Required

Restrictions

Description

columnMapping

object¦null

false

none

none

» additionalProperties

string¦null

false

none

none

valueColumn

string¦null

false

none

none

sourceName

string¦null

false

none

none

sectionStyle

Varicent.RESTAPI.v1.DTOs.ScalarDisplayStyleDTO

false

none

none

format

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

none

dateFormat

Varicent.RESTAPI.v1.DTOs.PRDateFormatDTO

false

none

none

json
{
  "columnMapping": {
    "property1": "string",
    "property2": "string"
  },
  "valueColumn": "string",
  "sourceName": "string",
  "sectionStyle": {
    "style": {
      "alignment": "Justify",
      "backColor": {},
      "font": {},
      "foreColor": {}
    },
    "displayBorders": {
      "bottom": {},
      "left": {},
      "right": {},
      "top": {}
    },
    "displayPadding": {
      "bottom": 0.1,
      "left": 0.1,
      "right": 0.1,
      "top": 0.1
    }
  },
  "format": {
    "scale": 0,
    "style": "Number"
  },
  "dateFormat": {
    "style": "Date"
  }
}

Varicent.RESTAPI.v1.DTOs.StarSchema.FactColumnDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

sourceTable

string¦null

false

none

none

joiningColumn

string¦null

false

none

none

json
{
  "name": "string",
  "sourceTable": "string",
  "joiningColumn": "string"
}

Varicent.RESTAPI.v1.DTOs.StarSchema.StarSchemaDefinitionDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

fact

string¦null

false

none

none

columnMap

object¦null

false

none

none

» additionalProperties

string¦null

false

none

none

factColumns

[Varicent.RESTAPI.v1.DTOs.StarSchema.FactColumnDTO]¦null

false

none

none

dataStoreID

integer(int32)

false

none

none

sourceTableDimMap

object¦null

false

none

none

» additionalProperties

string¦null

false

none

none

json
{
  "name": "string",
  "fact": "string",
  "columnMap": {
    "property1": "string",
    "property2": "string"
  },
  "factColumns": [
    {
      "name": "string",
      "sourceTable": "string",
      "joiningColumn": "string"
    }
  ],
  "dataStoreID": 0,
  "sourceTableDimMap": {
    "property1": "string",
    "property2": "string"
  }
}

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

Properties

Name

Type

Required

Restrictions

Description

color

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

none

font

Varicent.RESTAPI.v1.DTOs.FontDefinitionDTOVaricent.RESTAPI.v1.DTOs.FontDefinitionDTO

false

none

none

json
{
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "font": {
    "family": "string",
    "size": 0.1,
    "unit": "string",
    "bold": true,
    "italic": true,
    "underline": true,
    "strikeout": true
  }
}

Varicent.RESTAPI.v1.DTOs.Subscriptions.SubscribableDTO

Properties

Name

Type

Required

Restrictions

Description

id

string¦null

false

none

none

type

string

false

none

none

Enumerated Values

Property

Value

type

Block

type

Table

type

Calculation

type

Plan

type

TailoredReport

type

WebForm

type

WebReport

type

InputPort

type

OutputPort

type

Library

type

DataStore

type

AssignTable

type

Hub

type

Waypoint

type

InsertionPoint

json
{
  "id": "string",
  "type": "Block"
}

Varicent.RESTAPI.v1.DTOs.Subscriptions.SubscriptionDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

name

string¦null

false

none

none

subscribable

Varicent.RESTAPI.v1.DTOs.Composer.ElementDTO

false

none

none

lastModified

string(date-time)

false

none

none

lastAuthor

string¦null

false

none

none

newChangesCount

integer(int32)

false

none

none

type

string

false

none

none

Enumerated Values

Property

Value

type

Block

type

Table

type

Calculation

type

Plan

type

TailoredReport

type

WebForm

type

WebReport

type

InputPort

type

OutputPort

type

Library

type

DataStore

type

AssignTable

type

Hub

type

Waypoint

type

InsertionPoint

json
{
  "id": 0,
  "name": "string",
  "subscribable": {
    "elementId": 0,
    "parentBlockId": 0,
    "bounds": {
      "location": {},
      "size": "string",
      "x": 0.1,
      "y": 0.1,
      "width": 0.1,
      "height": 0.1,
      "left": 0.1,
      "top": 0.1,
      "right": 0.1,
      "bottom": 0.1,
      "isEmpty": true
    },
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "name": "string",
    "parentBlock": {
      "id": 0,
      "name": "string",
      "href": "string"
    },
    "isVisible": true,
    "version": {
      "rowVersion": 0
    }
  },
  "lastModified": "2019-08-24T14:15:22Z",
  "lastAuthor": "string",
  "newChangesCount": 0,
  "type": "Block"
}

Varicent.RESTAPI.v1.DTOs.SwimLaneDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

order

integer(int32)

false

none

none

name

string¦null

false

none

none

description

string¦null

false

none

none

workflowID

integer(int32)

false

none

none

isSystemLane

boolean

false

none

none

isByRestriction

boolean

false

none

none

isAdmin

boolean

false

none

none

memberDefinition

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

payeeIDs

[string]¦null

false

none

none

queryDelta

Varicent.RESTAPI.v1.DTOs.QueryDeltaDTO

false

none

none

adminIDs

[string]¦null

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "id": 0,
  "order": 0,
  "name": "string",
  "description": "string",
  "workflowID": 0,
  "isSystemLane": true,
  "isByRestriction": true,
  "isAdmin": true,
  "memberDefinition": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "payeeIDs": [
    "string"
  ],
  "queryDelta": {
    "modification": {
      "itemsToAdd": [],
      "itemsToRemove": []
    },
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "selectAllRows": true
  },
  "adminIDs": [
    "string"
  ],
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.Symon.PipeConnectionDTO

Properties

Name

Type

Required

Restrictions

Description

pipeID

string¦null

false

none

none

inputID

string¦null

false

none

none

outputID

string¦null

false

none

none

outputName

string¦null

false

none

none

lastValidated

string(date-time)

false

none

none

inputMapping

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

none

outputMapping

[RESTAPI.v1.DTOs.Symon.PipeConnectionColumnMappingDTO]¦null

false

none

none

json
{
  "pipeID": "string",
  "inputID": "string",
  "outputID": "string",
  "outputName": "string",
  "lastValidated": "2019-08-24T14:15:22Z",
  "inputMapping": [
    {
      "source": "string",
      "destination": "string",
      "type": "String"
    }
  ],
  "outputMapping": [
    {
      "source": "string",
      "destination": "string",
      "type": "String"
    }
  ]
}

Varicent.RESTAPI.v1.DTOs.Table.QueryTableColumnDTO

Properties

Name

Type

Required

Restrictions

Description

queryDefinition

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

table

Varicent.RESTAPI.v1.DTOs.CustomTableDTO

false

none

none

columns

[string]¦null

false

none

none

json
{
  "queryDefinition": {
    "selectItems": [
      {}
    ],
    "source": {
      "namespaceTable": {},
      "query": null,
      "alias": "string",
      "sourceType": "Table"
    },
    "joins": [
      {}
    ],
    "whereClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "order": [
      {}
    ],
    "group": [
      {}
    ],
    "havingClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "distinct": true,
    "unionWith": null,
    "exceptWith": null
  },
  "table": {
    "version": {
      "rowVersion": 0
    },
    "name": "string",
    "tableType": "System",
    "effectiveDated": true,
    "workflowObjectID": 0,
    "hierarchyMetadata": {
      "tableName": "string",
      "idColumnName": "string",
      "parentColumnName": "string"
    },
    "lastUpdatedTracking": true
  },
  "columns": [
    "string"
  ]
}

Varicent.RESTAPI.v1.DTOs.Table.SimpleColumnDTO

Properties

Name

Type

Required

Restrictions

Description

tableName

string¦null

false

none

none

columnName

string¦null

false

none

none

json
{
  "tableName": "string",
  "columnName": "string"
}

Varicent.RESTAPI.v1.DTOs.TableAdditionalDataDTO

Properties

Name

Type

Required

Restrictions

Description

isWebEnabled

boolean

false

none

none

isHistoryEnabled

boolean

false

none

none

comment

string¦null

false

none

none

isGlobal

boolean

false

none

none

directEdit

boolean

false

none

none

isWebDataEditEditable

boolean

false

none

none

arePendingEditsActionable

boolean

false

none

none

isWebDataViewable

boolean

false

none

none

isReadOnly

boolean

false

none

none

isOptimizedEditEnabled

boolean

false

none

none

json
{
  "isWebEnabled": true,
  "isHistoryEnabled": true,
  "comment": "string",
  "isGlobal": true,
  "directEdit": true,
  "isWebDataEditEditable": true,
  "arePendingEditsActionable": true,
  "isWebDataViewable": true,
  "isReadOnly": true,
  "isOptimizedEditEnabled": true
}

Varicent.RESTAPI.v1.DTOs.TableAdditionalDataPatchDTO

Properties

Name

Type

Required

Restrictions

Description

enableTables

[string]¦null

false

none

none

disableTables

[string]¦null

false

none

none

json
{
  "enableTables": [
    "string"
  ],
  "disableTables": [
    "string"
  ]
}

Varicent.RESTAPI.v1.DTOs.TableDefinitionDTO

Properties

Name

Type

Required

Restrictions

Description

table

Varicent.RESTAPI.v1.DTOs.CustomTableDTO

false

none

none

columns

[Varicent.RESTAPI.v1.DTOs.ColumnDefinitionDTO]¦null

false

none

none

time

Varicent.RESTAPI.v1.DTOs.TableTimeDTO

false

none

none

json
{
  "table": {
    "version": {
      "rowVersion": 0
    },
    "name": "string",
    "tableType": "System",
    "effectiveDated": true,
    "workflowObjectID": 0,
    "hierarchyMetadata": {
      "tableName": "string",
      "idColumnName": "string",
      "parentColumnName": "string"
    },
    "lastUpdatedTracking": true
  },
  "columns": [
    {
      "column": {},
      "isRemovable": true,
      "isNullable": true,
      "referencedColumn": "string"
    }
  ],
  "time": {
    "timeId": "string",
    "dateColumn": "string",
    "lockedOn": {},
    "min": {},
    "max": {}
  }
}

Varicent.RESTAPI.v1.DTOs.TableHistoryDTO

Properties

Name

Type

Required

Restrictions

Description

totalRowCount

integer(int64)

false

none

none

columnDefinitions

[Varicent.RESTAPI.v1.DTOs.Schema.ColumnSchemaDTO]¦null

false

none

none

data

[Varicent.RESTAPI.v1.DTOs.TableHistoryRowDTO]¦null

false

none

none

json
{
  "totalRowCount": 0,
  "columnDefinitions": [
    {
      "name": "string",
      "type": "String",
      "isKey": true,
      "nullable": true,
      "values": "string",
      "lockedPeriod": {},
      "referencedCol": "string",
      "picklistFilter": "string",
      "displayName": "string",
      "isELTPeriod": true
    }
  ],
  "data": [
    {
      "rowData": {},
      "rowDifferences": {}
    }
  ]
}

Varicent.RESTAPI.v1.DTOs.TableHistoryRangeDTO

Properties

Name

Type

Required

Restrictions

Description

isStatic

boolean

false

none

none

historyId

integer(int32)

false

none

none

start

string(date-time)¦null

false

none

none

end

string(date-time)¦null

false

none

none

json
{
  "isStatic": true,
  "historyId": 0,
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z"
}

Varicent.RESTAPI.v1.DTOs.TableHistoryRowDTO

Properties

Name

Type

Required

Restrictions

Description

rowData

object¦null

false

none

none

» additionalProperties

any

false

none

none

rowDifferences

object¦null

false

none

none

» additionalProperties

boolean¦null

false

none

none

json
{
  "rowData": {
    "property1": null,
    "property2": null
  },
  "rowDifferences": {
    "property1": true,
    "property2": true
  }
}

Varicent.RESTAPI.v1.DTOs.TableTimeDTO

Properties

Name

Type

Required

Restrictions

Description

timeId

string¦null

false

none

none

dateColumn

string¦null

false

none

none

lockedOn

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

min

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

max

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

json
{
  "timeId": "string",
  "dateColumn": "string",
  "lockedOn": {},
  "min": {},
  "max": {}
}

Varicent.RESTAPI.v1.DTOs.TaskManager.ParameterPairDTO

Properties

Name

Type

Required

Restrictions

Description

displayText

string¦null

false

none

none

value

string¦null

false

none

none

type

string¦null

false

none

none

json
{
  "displayText": "string",
  "value": "string",
  "type": "string"
}

Varicent.RESTAPI.v1.DTOs.TaskManager.TaskActionDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

type

string

false

none

none

parameters

[Varicent.RESTAPI.v1.DTOs.TaskManager.ParameterPairDTO]¦null

false

none

none

Enumerated Values

Property

Value

type

Alert

type

PayeeGroupAdd

type

PayeeGroupRemove

type

WorkflowAddToGroup

type

WorkflowRemoveFromGroup

type

WorkflowEnableAndNotifyGroupForWeb

type

AlertTailoredReportNotEmpty

type

PayeeGroupSetEndDate

type

PayeeGroupAddAsOfToday

type

WorkflowMaintainGroup

type

WorkflowEnableGroupForWebDataEdit

json
{
  "id": 0,
  "type": "Alert",
  "parameters": [
    {
      "displayText": "string",
      "value": "string",
      "type": "string"
    }
  ]
}

Varicent.RESTAPI.v1.DTOs.TaskManager.TaskAlertTreeListNodeItemDTO

Properties

Name

Type

Required

Restrictions

Description

resourceId

integer(int32)¦null

false

none

none

name

string¦null

false

none

none

enabled

boolean

false

none

none

query

Varicent.RESTAPI.v1.DTOs.QueryDefinitionDTO

false

none

none

id

integer(int32)

false

none

none

parent

integer(int32)¦null

false

none

none

oldParent

integer(int32)¦null

false

none

none

prev

integer(int32)¦null

false

none

none

oldPrev

integer(int32)¦null

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "resourceId": 0,
  "name": "string",
  "enabled": true,
  "query": {
    "selectItems": [
      {}
    ],
    "source": {
      "namespaceTable": {},
      "query": null,
      "alias": "string",
      "sourceType": "Table"
    },
    "joins": [
      {}
    ],
    "whereClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "order": [
      {}
    ],
    "group": [
      {}
    ],
    "havingClause": {
      "constraintType": "clause",
      "op": "string",
      "dataFieldLeft": {},
      "caseSensitive": true,
      "constraints": [],
      "literalRight": {},
      "dataFieldRight": {},
      "right": {},
      "expressionLeft": {},
      "expressionRight": {},
      "isPreciseDecimal": true,
      "like": "string",
      "escapeWildcards": true,
      "rowVersion": {},
      "table": "string",
      "queryDefinitionRight": null
    },
    "distinct": true,
    "unionWith": null,
    "exceptWith": null
  },
  "id": 0,
  "parent": 0,
  "oldParent": 0,
  "prev": 0,
  "oldPrev": 0,
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.TaskManager.TaskDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

actionType

string

false

none

none

alertType

string

false

none

none

parameters

[string]¦null

false

none

none

createdAt

string(date-time)

false

none

none

deferred

string(date-time)¦null

false

none

none

rule

string¦null

false

none

none

values

[string]¦null

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

actionType

Alert

actionType

PayeeGroupAdd

actionType

PayeeGroupRemove

actionType

WorkflowAddToGroup

actionType

WorkflowRemoveFromGroup

actionType

WorkflowEnableAndNotifyGroupForWeb

actionType

AlertTailoredReportNotEmpty

actionType

PayeeGroupSetEndDate

actionType

PayeeGroupAddAsOfToday

actionType

WorkflowMaintainGroup

actionType

WorkflowEnableGroupForWebDataEdit

alertType

Invalid

alertType

PayeeMoreThanOnePlan

alertType

PayeeNotInPlan

alertType

TerminatedPayeeActive

alertType

TailoredReportEmpty

alertType

TerminationBeforeEndDate

json
{
  "id": 0,
  "actionType": "Alert",
  "alertType": "Invalid",
  "parameters": [
    "string"
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "deferred": "2019-08-24T14:15:22Z",
  "rule": "string",
  "values": [
    "string"
  ],
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.TaskManager.TaskGroupDTO

Properties

Name

Type

Required

Restrictions

Description

groupId

integer(int32)

false

none

none

name

string¦null

false

none

none

source

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

json
{
  "groupId": 0,
  "name": "string",
  "source": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  }
}

Varicent.RESTAPI.v1.DTOs.TaskManager.TaskGroupTreeListNodeItemDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

comment

string¦null

false

none

none

resourceId

integer(int32)¦null

false

none

none

type

string

false

none

none

group

Varicent.RESTAPI.v1.DTOs.TaskManager.TaskGroupDTO

false

none

none

id

integer(int32)

false

none

none

parent

integer(int32)¦null

false

none

none

oldParent

integer(int32)¦null

false

none

none

prev

integer(int32)¦null

false

none

none

oldPrev

integer(int32)¦null

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

type

Group

type

Folder

json
{
  "name": "string",
  "comment": "string",
  "resourceId": 0,
  "type": "Group",
  "group": {
    "groupId": 0,
    "name": "string",
    "source": {
      "query": {},
      "sourceNames": {}
    }
  },
  "id": 0,
  "parent": 0,
  "oldParent": 0,
  "prev": 0,
  "oldPrev": 0,
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.TaskManager.TaskRuleDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

name

string¦null

false

none

none

action

Varicent.RESTAPI.v1.DTOs.TaskManager.TaskActionDTO

false

none

none

roleIds

[integer]¦null

false

none

none

columns

[string]¦null

false

none

none

json
{
  "id": 0,
  "name": "string",
  "action": {
    "id": 0,
    "type": "Alert",
    "parameters": [
      {}
    ]
  },
  "roleIds": [
    0
  ],
  "columns": [
    "string"
  ]
}

Varicent.RESTAPI.v1.DTOs.TaskManager.TaskRuleTreeListNodeItemDTO

Properties

Name

Type

Required

Restrictions

Description

resourceId

integer(int32)¦null

false

none

none

name

string¦null

false

none

none

comment

string¦null

false

none

none

type

string

false

none

none

rule

Varicent.RESTAPI.v1.DTOs.TaskManager.TaskRuleDTO

false

none

none

isVisible

boolean

false

none

none

id

integer(int32)

false

none

none

parent

integer(int32)¦null

false

none

none

oldParent

integer(int32)¦null

false

none

none

prev

integer(int32)¦null

false

none

none

oldPrev

integer(int32)¦null

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

type

Rule

type

Folder

type

Alert

json
{
  "resourceId": 0,
  "name": "string",
  "comment": "string",
  "type": "Rule",
  "rule": {
    "id": 0,
    "name": "string",
    "action": {
      "id": 0,
      "type": "Alert",
      "parameters": []
    },
    "roleIds": [
      0
    ],
    "columns": [
      "string"
    ]
  },
  "isVisible": true,
  "id": 0,
  "parent": 0,
  "oldParent": 0,
  "prev": 0,
  "oldPrev": 0,
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.Time.CalendarDTO

Properties

Name

Type

Required

Restrictions

Description

definition

Varicent.RESTAPI.v1.DTOs.Time.CalendarDefinitionDTO

false

none

none

tree

Varicent.RESTAPI.v1.DTOs.Time.PeriodDTO

false

none

none

locked

string¦null

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "definition": {
    "timeId": "string",
    "name": "string",
    "levels": [
      "string"
    ]
  },
  "tree": {
    "name": "string",
    "level": "string",
    "start": {},
    "end": {},
    "children": []
  },
  "locked": "string",
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.Time.CalendarDefinitionDTO

Properties

Name

Type

Required

Restrictions

Description

timeId

string¦null

false

none

none

name

string¦null

false

none

none

levels

[string]¦null

false

none

none

json
{
  "timeId": "string",
  "name": "string",
  "levels": [
    "string"
  ]
}

Varicent.RESTAPI.v1.DTOs.Time.CompactCalendarDTO

Properties

Name

Type

Required

Restrictions

Description

locked

string¦null

false

none

none

levelLockedDates

[string]¦null

false

none

none

calendarStart

string(date-time)

false

none

none

defaultStartDate

string(date-time)

false

none

none

calendarEnd

string(date-time)

false

none

none

definition

Varicent.RESTAPI.v1.DTOs.Time.CalendarDefinitionDTO

false

none

none

levelPeriodCounts

object¦null

false

none

none

» additionalProperties

integer(int32)¦null

false

none

none

json
{
  "locked": "string",
  "levelLockedDates": [
    "2019-08-24T14:15:22Z"
  ],
  "calendarStart": "2019-08-24T14:15:22Z",
  "defaultStartDate": "2019-08-24T14:15:22Z",
  "calendarEnd": "2019-08-24T14:15:22Z",
  "definition": {
    "timeId": "string",
    "name": "string",
    "levels": [
      "string"
    ]
  },
  "levelPeriodCounts": {
    "property1": 0,
    "property2": 0
  }
}

Varicent.RESTAPI.v1.DTOs.Time.PeriodDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

level

string¦null

false

none

none

start

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

end

Varicent.RESTAPI.Utils.Json.Converters.Date

false

none

none

children

[Varicent.RESTAPI.v1.DTOs.Time.PeriodDTO]¦null

false

none

none

json
{
  "name": "string",
  "level": "string",
  "start": {},
  "end": {},
  "children": []
}

Varicent.RESTAPI.v1.DTOs.TransformationDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)¦null

false

none

none

name

string¦null

false

none

none

table

string¦null

false

none

none

sourceColumn

string¦null

false

none

none

find

string¦null

false

none

none

targetColumn

string¦null

false

none

none

replace

string¦null

false

none

none

replaceType

string

false

none

none

findType

string

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

replaceType

Text

replaceType

Decimal

replaceType

Date

findType

Text

findType

Decimal

findType

Date

json
{
  "id": 0,
  "name": "string",
  "table": "string",
  "sourceColumn": "string",
  "find": "string",
  "targetColumn": "string",
  "replace": "string",
  "replaceType": "Text",
  "findType": "Text",
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.TrendpointDTO

Properties

Name

Type

Required

Restrictions

Description

label

string¦null

false

none

none

labelStyle

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

none

color

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

none

json
{
  "label": "string",
  "labelStyle": {
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    }
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  }
}

Varicent.RESTAPI.v1.DTOs.UpdateBPMFolderDTO

Properties

Name

Type

Required

Restrictions

Description

folder

RESTAPI.v1.DTOs.TreeNodeDTO

false

none

none

oldOrder

integer(int32)

false

none

none

newOrder

integer(int32)

false

none

none

oldParentFolderRowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

newParentFolderRowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

workflowType

string¦null

false

none

none

Enumerated Values

Property

Value

workflowType

PresenterReport

workflowType

Inquiry

workflowType

PlanApproval

workflowType

PresenterFlexReport

workflowType

PlanDocument

json
{
  "folder": {
    "node": null,
    "children": []
  },
  "oldOrder": 0,
  "newOrder": 0,
  "oldParentFolderRowVersion": {
    "rowVersion": 0
  },
  "newParentFolderRowVersion": {
    "rowVersion": 0
  },
  "workflowType": "PresenterReport"
}

Varicent.RESTAPI.v1.DTOs.UpdateBPMWorkflowDTO

Properties

Name

Type

Required

Restrictions

Description

workflow

Varicent.RESTAPI.v1.DTOs.BPMWorkflowChildNodeDTO

false

none

none

oldOrder

integer(int32)

false

none

none

newOrder

integer(int32)¦null

false

none

none

oldParentFolderRowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

newParentFolderRowVersion

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "workflow": {
    "workflow": {
      "id": 0,
      "name": "string",
      "description": "string",
      "isSingleInstance": true,
      "workflowState": "Stopped",
      "conditionalVars": [],
      "columnCount": 0,
      "workflowConfig": {},
      "runCount": 0,
      "runDate": "string",
      "runBy": "string",
      "lastActioned": "string",
      "workflowType": "PresenterReport",
      "webReport": {},
      "inquiry": {},
      "bpmWorkflowPresenterFlexReportDTO": {},
      "bpmWorkflowPlanDocPresenterFlexReportDTO": {},
      "assignedReports": [],
      "numReportsAssigned": 0,
      "permissions": {},
      "parentFolder": {},
      "parameters": [],
      "layoutAssignment": {},
      "webReportID": 0,
      "version": {}
    },
    "parentFolderId": 0
  },
  "oldOrder": 0,
  "newOrder": 0,
  "oldParentFolderRowVersion": {
    "rowVersion": 0
  },
  "newParentFolderRowVersion": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.UserDTO

Properties

Name

Type

Required

Restrictions

Description

id

string¦null

false

none

none

role

Varicent.RESTAPI.v1.DTOs.RoleDefinitionDTO

false

none

none

createdAt

string(date-time)

false

none

none

disabled

boolean

false

none

none

json
{
  "id": "string",
  "role": {
    "id": 0,
    "name": "string",
    "displayName": "string",
    "permissions": [
      {}
    ],
    "permissionPaths": [
      "string"
    ],
    "version": {
      "rowVersion": 0
    }
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "disabled": true
}

Varicent.RESTAPI.v1.DTOs.ValidationRuleDTO

Properties

Name

Type

Required

Restrictions

Description

name

string¦null

false

none

none

table

string¦null

false

none

none

column

string¦null

false

none

none

comment

string¦null

false

none

none

rule

string¦null

false

none

none

type

string

false

none

none

Enumerated Values

Property

Value

type

Text

type

Numeric

json
{
  "name": "string",
  "table": "string",
  "column": "string",
  "comment": "string",
  "rule": "string",
  "type": "Text"
}

Varicent.RESTAPI.v1.DTOs.VaricentUrlDTO

Properties

Name

Type

Required

Restrictions

Description

moduleType

string

false

none

none

actionType

string

false

none

none

elementType

string

false

none

none

moduleTab

string¦null

false

none

none

args

object¦null

false

none

none

» additionalProperties

string¦null

false

none

none

Enumerated Values

Property

Value

moduleType

home

moduleType

composer

moduleType

workflow

moduleType

scheduler

moduleType

taskmanager

moduleType

audit

moduleType

payeeledger

moduleType

webforms

moduleType

presenter

moduleType

rowviewer

moduleType

hierarchy

moduleType

calcviewer

moduleType

calculate

moduleType

payeegroups

moduleType

migration

moduleType

localsavedimport

moduleType

remotesavedimport

moduleType

savedpublication

moduleType

portviewer

moduleType

scenarios

moduleType

viewPR

moduleType

progress

moduleType

runSchedulerProcess

moduleType

BPM

moduleType

NonInteractive

moduleType

compPlanManager

moduleType

rapidreports

moduleType

adaptive

moduleType

adaptiveforms

moduleType

plans

moduleType

data

moduleType

people

moduleType

processList

moduleType

manageFile

actionType

None

actionType

Cut

actionType

Copy

actionType

Delete

actionType

Select

actionType

Edit

actionType

Wrap

actionType

ViewUsedByTree

actionType

ViewUsesTree

actionType

UsedBy

actionType

TableEditDescription

actionType

TableAddInputForm

actionType

TableEditInputForm

actionType

TableEditValidationRules

actionType

TableDeleteInputForm

actionType

TableMakeEffectiveDated

actionType

TableImport

actionType

TableDeleteRows

actionType

TableClear

actionType

TableTransform

actionType

TablePurgeHistory

actionType

TableToggleTrackHistory

actionType

TableToggleGlobal

actionType

TableEditWebDataEditPermissions

actionType

TableEditWebDataRestrictions

actionType

TableEditWebDataApproveReject

actionType

TableToggleDirectEdit

actionType

Publish

actionType

CalculationPreview

actionType

CalculationCurrentValue

actionType

CalculationHistory

actionType

CalculationMethod

actionType

PresenterView

actionType

ComponentView

actionType

ComponentUnwrap

actionType

ComponentEditConnections

actionType

ComponentAddInboundConnection

actionType

ComponentAddOutboundConnection

actionType

ComponentManageLinks

actionType

ComponentManageDocuments

actionType

AdaptivePresenterView

actionType

AdaptiveFormView

elementType

none

elementType

table

elementType

presenter

elementType

webform

elementType

calculation

elementType

datastore

elementType

component

elementType

adaptive

elementType

adaptiveform

json
{
  "moduleType": "home",
  "actionType": "None",
  "elementType": "none",
  "moduleTab": "string",
  "args": {
    "property1": "string",
    "property2": "string"
  }
}

Varicent.RESTAPI.v1.DTOs.VaricentUserDTO

Properties

Name

Type

Required

Restrictions

Description

changePassAtNextLogin

boolean

false

none

none

createdAt

string(date-time)

false

none

none

disabled

boolean

false

none

none

encryptionVersion

string

false

none

none

hasVersion

boolean

false

none

none

id

string¦null

false

none

none

lastPasswordExpireMail

string(date-time)¦null

false

none

none

lastPasswordExpirePrompt

string(date-time)¦null

false

none

none

email

string¦null

false

none

none

name

string¦null

false

none

none

nbFailedLogOnAttempts

integer(int32)

false

none

none

password

string¦null

false

none

none

passwordLastChanged

string(date-time)

false

none

none

roleDefinition

Varicent.RESTAPI.v1.DTOs.RoleDefinitionDTO

false

none

none

salt

string¦null

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

encryptionVersion

Version1

encryptionVersion

Version2

encryptionVersion

Version3

json
{
  "changePassAtNextLogin": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "disabled": true,
  "encryptionVersion": "Version1",
  "hasVersion": true,
  "id": "string",
  "lastPasswordExpireMail": "2019-08-24T14:15:22Z",
  "lastPasswordExpirePrompt": "2019-08-24T14:15:22Z",
  "email": "string",
  "name": "string",
  "nbFailedLogOnAttempts": 0,
  "password": "string",
  "passwordLastChanged": "2019-08-24T14:15:22Z",
  "roleDefinition": {
    "id": 0,
    "name": "string",
    "displayName": "string",
    "permissions": [
      {}
    ],
    "permissionPaths": [
      "string"
    ],
    "version": {
      "rowVersion": 0
    }
  },
  "salt": "string",
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.WatsonAssistantConfigDTO

Properties

Name

Type

Required

Restrictions

Description

assistantId

string¦null

false

none

none

assistantEnabled

boolean

false

none

none

json
{
  "assistantId": "string",
  "assistantEnabled": true
}

Varicent.RESTAPI.v1.DTOs.WatsonAssistantQuestionDTO

Properties

Name

Type

Required

Restrictions

Description

messageJson

string¦null

false

none

none

messageText

string¦null

false

none

none

sessionContext

string¦null

false

none

none

messageContext

string¦null

false

none

none

history

[Varicent.RESTAPI.v1.DTOs.WatsonAssistantQuestionDTO+History]¦null

false

none

none

json
{
  "messageJson": "string",
  "messageText": "string",
  "sessionContext": "string",
  "messageContext": "string",
  "history": []
}

Varicent.RESTAPI.v1.DTOs.WatsonAssistantQuestionDTO+History

Properties

Name

Type

Required

Restrictions

Description

id

string¦null

false

none

none

fullResponseText

string¦null

false

none

none

json
{
  "id": "string",
  "fullResponseText": "string"
}

Varicent.RESTAPI.v1.DTOs.WebFormDefinitionDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

elementId

integer(int32)

false

none

none

name

string¦null

false

none

none

javaScript

string¦null

false

none

none

protected

boolean

false

none

none

filterFirst

boolean

false

none

none

numRows

integer(int32)

false

none

none

numColumns

integer(int32)

false

none

none

exportFilter

integer(int32)

false

none

none

elements

[Varicent.RESTAPI.v1.DTOs.WebFormElementDTO]¦nullVaricent.RESTAPI.v1.DTOs.WebFormElementDTO

false

none

none

spans

[Varicent.RESTAPI.v1.DTOs.CellSpanDTO]¦null

false

none

none

workflowObjectId

integer(int32)

false

none

none

element

Varicent.RESTAPI.v1.DTOs.IExpandableResourceDTO

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "id": 0,
  "elementId": 0,
  "name": "string",
  "javaScript": "string",
  "protected": true,
  "filterFirst": true,
  "numRows": 0,
  "numColumns": 0,
  "exportFilter": 0,
  "elements": [
    {
      "row": 0,
      "column": 0,
      "type": "WebFormAdmin",
      "name": "string",
      "location": "string",
      "resourceType": "Image",
      "timeId": "string",
      "text": "string",
      "style": {},
      "definition": {},
      "tableDefinition": {},
      "rules": [],
      "columnOptions": [],
      "mainTable": {},
      "sourceDefinition": {},
      "filters": [],
      "editableColumns": [],
      "links": [],
      "webFormSource": null,
      "data": null,
      "source": {},
      "op": "Sum",
      "displayFormat": {},
      "value": null,
      "result": null,
      "link": {}
    }
  ],
  "spans": [
    {
      "row": 0,
      "columnStart": 0,
      "columnEnd": 0
    }
  ],
  "workflowObjectId": 0,
  "element": {},
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.WebFormElementDTO

Properties

Name

Type

Required

Restrictions

Description

row

integer(int32)

false

none

none

column

integer(int32)

false

none

none

type

string

false

none

none

name

string¦null

false

none

none

location

string¦null

false

none

none

resourceType

string¦null

false

none

none

timeId

string¦null

false

none

none

text

string¦null

false

none

none

style

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

none

definition

Varicent.RESTAPI.v1.DTOs.TableDefinitionDTO

false

none

none

tableDefinition

Varicent.RESTAPI.v1.DTOs.TableDefinitionDTO

false

none

none

rules

[Varicent.RESTAPI.v1.DTOs.InputRuleDTO]¦null

false

none

none

columnOptions

[Varicent.RESTAPI.v1.DTOs.ColumnOptionsDTO]¦null

false

none

none

mainTable

Varicent.RESTAPI.v1.DTOs.TableDefinitionDTO

false

none

none

sourceDefinition

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

filters

[Varicent.RESTAPI.v1.DTOs.WebFormFilterDTO]¦null

false

none

none

editableColumns

[Varicent.RESTAPI.v1.DTOs.EditableColumnDTO]¦null

false

none

none

links

[Varicent.RESTAPI.v1.DTOs.LinkDTO]¦null

false

none

none

webFormSource

Varicent.RESTAPI.v1.DTOs.WebFormElementDTO

false

none

none

data

any

false

read-only

none

source

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

op

string¦null

false

none

none

displayFormat

Varicent.RESTAPI.v1.DTOs.NumericFormatDTO

false

none

none

value

Varicent.RESTAPI.v1.DTOs.WebFormElementDTO

false

none

none

result

any

false

read-only

none

link

Varicent.RESTAPI.v1.DTOs.LinkDTO

false

none

none

Enumerated Values

Property

Value

type

WebFormAdmin

type

WebFormResource

type

WebFormSink

type

WebFormSource

type

WebFormSourceData

type

WebFormValue

type

WebFormValueData

type

WebFormText

resourceType

Image

resourceType

Link

op

Sum

op

Avg

op

Count

op

Max

op

Min

json
{
  "row": 0,
  "column": 0,
  "type": "WebFormAdmin",
  "name": "string",
  "location": "string",
  "resourceType": "Image",
  "timeId": "string",
  "text": "string",
  "style": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "definition": {
    "table": {
      "version": {},
      "name": "string",
      "tableType": "System",
      "effectiveDated": true,
      "workflowObjectID": 0,
      "hierarchyMetadata": {},
      "lastUpdatedTracking": true
    },
    "columns": [
      {}
    ],
    "time": {
      "timeId": "string",
      "dateColumn": "string",
      "lockedOn": {},
      "min": {},
      "max": {}
    }
  },
  "tableDefinition": {
    "table": {
      "version": {},
      "name": "string",
      "tableType": "System",
      "effectiveDated": true,
      "workflowObjectID": 0,
      "hierarchyMetadata": {},
      "lastUpdatedTracking": true
    },
    "columns": [
      {}
    ],
    "time": {
      "timeId": "string",
      "dateColumn": "string",
      "lockedOn": {},
      "min": {},
      "max": {}
    }
  },
  "rules": [
    {
      "id": 0,
      "elementId": 0,
      "table": "string",
      "column": "string",
      "operatorType": "LessThan",
      "valueType": "String",
      "value": null
    }
  ],
  "columnOptions": [
    {
      "index": 0,
      "width": 0,
      "isRequired": true
    }
  ],
  "mainTable": {
    "table": {
      "version": {},
      "name": "string",
      "tableType": "System",
      "effectiveDated": true,
      "workflowObjectID": 0,
      "hierarchyMetadata": {},
      "lastUpdatedTracking": true
    },
    "columns": [
      {}
    ],
    "time": {
      "timeId": "string",
      "dateColumn": "string",
      "lockedOn": {},
      "min": {},
      "max": {}
    }
  },
  "sourceDefinition": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "filters": [
    {
      "filterId": 0,
      "name": "string",
      "sourceTable": "string",
      "sourceColumn": "string",
      "type": "Simple",
      "op": "Equals",
      "display": "Select",
      "definition": {},
      "systemType": "string",
      "filterValueColumn": "string",
      "filterNameColumn": "string",
      "version": {}
    }
  ],
  "editableColumns": [
    {
      "column": {},
      "index": 0,
      "table": "string"
    }
  ],
  "links": [
    {
      "document": "string",
      "openInNewWindow": true,
      "parameters": {},
      "reportId": 0,
      "targetId": 0,
      "targetType": "WebReport",
      "webFormId": 0,
      "webTabId": 0
    }
  ],
  "webFormSource": null,
  "data": null,
  "source": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "op": "Sum",
  "displayFormat": {
    "scale": 0,
    "style": "Number"
  },
  "value": null,
  "result": null,
  "link": {
    "document": "string",
    "openInNewWindow": true,
    "parameters": {
      "property1": {},
      "property2": {}
    },
    "reportId": 0,
    "targetId": 0,
    "targetType": "WebReport",
    "webFormId": 0,
    "webTabId": 0
  }
}

Varicent.RESTAPI.v1.DTOs.WebFormFilterDTO

Properties

Name

Type

Required

Restrictions

Description

filterId

integer(int32)

false

none

none

name

string¦null

false

none

none

sourceTable

string¦null

false

none

none

sourceColumn

string¦null

false

none

none

type

string

false

none

none

op

string

false

none

none

display

string

false

none

none

definition

Varicent.RESTAPI.v1.DTOs.SourceDefinitionDTO

false

none

none

systemType

string¦null

false

none

none

filterValueColumn

string¦null

false

none

none

filterNameColumn

string¦null

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

type

Simple

type

Workflow

type

Custom

op

Equals

op

LessThan

op

LessThanEquals

op

GreaterThan

op

GreaterThanEquals

display

Select

display

Field

json
{
  "filterId": 0,
  "name": "string",
  "sourceTable": "string",
  "sourceColumn": "string",
  "type": "Simple",
  "op": "Equals",
  "display": "Select",
  "definition": {
    "query": {
      "selectItems": [],
      "source": {},
      "joins": [],
      "whereClause": {},
      "order": [],
      "group": [],
      "havingClause": {},
      "distinct": true,
      "unionWith": null,
      "exceptWith": null
    },
    "sourceNames": {
      "property1": "string",
      "property2": "string"
    }
  },
  "systemType": "string",
  "filterValueColumn": "string",
  "filterNameColumn": "string",
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.WebFormNameDTO

Properties

Name

Type

Required

Restrictions

Description

isFavorite

boolean

false

none

none

name

string¦null

false

none

none

id

string¦null

false

none

none

workflowObjectId

integer(int32)

false

none

none

json
{
  "isFavorite": true,
  "name": "string",
  "id": "string",
  "workflowObjectId": 0
}

Varicent.RESTAPI.v1.DTOs.WebReportBatchExportDetailsDTO

Properties

Name

Type

Required

Restrictions

Description

canBatchExport

boolean

false

none

none

picklistRefParam

string¦null

false

none

none

json
{
  "canBatchExport": true,
  "picklistRefParam": "string"
}

Varicent.RESTAPI.v1.DTOs.WebReportDTO

Properties

Name

Type

Required

Restrictions

Description

allowPdfExport

boolean

false

none

none

showInquiry

boolean

false

none

none

batchExportDetails

Varicent.RESTAPI.v1.DTOs.WebReportBatchExportDetailsDTO

false

none

none

background

Varicent.RESTAPI.v1.DTOs.BackgroundDisplayDTO

false

none

none

defaultStyle

Varicent.RESTAPI.v1.DTOs.StyleDefinitionDTO

false

none

none

directlyAccessible

boolean

false

none

none

frameLayout

Varicent.RESTAPI.v1.DTOs.FrameableDTO

false

none

none

isLayoutLocked

boolean

false

none

none

name

string¦null

false

none

none

pdfOptions

Varicent.RESTAPI.v1.DTOs.WebReportPdfOptionsDTO

false

none

none

sources

[Varicent.RESTAPI.v1.DTOs.ReportSourceDTO]¦null

false

none

none

trees

[Varicent.RESTAPI.v1.DTOs.ReportTreeNodeDTO]¦null

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

webReportId

integer(int32)

false

none

none

workflowObjectId

integer(int32)

false

none

none

element

Varicent.RESTAPI.v1.DTOs.IExpandableResourceDTO

false

none

none

styleCategory

string¦null

false

none

none

json
{
  "allowPdfExport": true,
  "showInquiry": true,
  "batchExportDetails": {
    "canBatchExport": true,
    "picklistRefParam": "string"
  },
  "background": {
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "image": {
      "displayBorder": {},
      "displayPadding": {},
      "gridType": "string",
      "hoverText": "string",
      "imageByteArray": "string",
      "imageId": 0,
      "imageLink": {},
      "imageType": "string",
      "imageUrl": "string",
      "expiryDate": "2019-08-24T14:15:22Z",
      "cosObjectName": "string",
      "name": "string",
      "source": {},
      "style": {}
    },
    "imageAttachment": "Scroll",
    "imagePosition": "Absolute",
    "imageTile": "None",
    "webreportId": 0,
    "x": 0,
    "y": 0,
    "opacity": 0
  },
  "defaultStyle": {
    "color": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    }
  },
  "directlyAccessible": true,
  "frameLayout": {
    "horizontalAlign": "Left",
    "verticalAlign": "Top",
    "type": "Frame",
    "childHeightPercents": [
      0.1
    ],
    "childWidthPercents": [
      0.1
    ],
    "frames": [
      []
    ],
    "name": "string",
    "numColumns": 0,
    "numRows": 0,
    "display": {
      "gridType": "string",
      "name": "string",
      "source": {},
      "type": "DataGridDisplay",
      "restrictSource": {},
      "restrictColumn": "string",
      "style": {},
      "columnMap": {},
      "computedColumns": [],
      "computedRow": {},
      "dataGridDisplayStyle": {},
      "dataGridInputRules": [],
      "dateFormat": {},
      "defaultPageSize": 0,
      "enableExportToExcel": true,
      "enableInquiryCopy": true,
      "enableShowHideColumns": true,
      "freezeTopRow": true,
      "hiddenColumnAliasMap": {},
      "hiddenColumns": [],
      "hiddenInputRowColumnMap": {},
      "inputRowAtTop": true,
      "isVertical": true,
      "numericStyle": {},
      "paginated": true,
      "sections": [],
      "showOnlyInputRow": true,
      "showSectionHeader": true,
      "sortColumns": [],
      "suppressHeader": true,
      "hideRowBorders": true,
      "disableRowHighlighting": true,
      "suppressRepeatPartitionValues": true,
      "timeId": "string",
      "validationRules": [],
      "selectedTemplateId": 0,
      "columnWidths": [],
      "displays": [],
      "fixedGridDisplayStyle": {},
      "imageType": "string",
      "imageLink": {},
      "imageId": 0,
      "imageByteArray": "string",
      "hoverText": "string",
      "imageUrl": "string",
      "expiryDate": "2019-08-24T14:15:22Z",
      "cosObjectName": "string",
      "controlDisplayStyle": {},
      "sortById": true,
      "sortAscending": true,
      "refParameter": "string",
      "nameColumn": "string",
      "idColumn": "string",
      "hideValueForExport": true,
      "hideIdValues": true,
      "scalarDisplayStyle": {},
      "scalarLink": {},
      "text": "string",
      "documentId": 0,
      "buttonDisplayStyle": {},
      "cellStyle": {},
      "agreementText": "string",
      "format": {},
      "conditionalFormatRule": {},
      "dateDisplayMode": "ShortDate",
      "xAxisName": "string",
      "yAxisName": "string",
      "numberPrefix": "string",
      "numberSuffix": "string",
      "labelOrientation": "Horizontal",
      "hideValues": true,
      "decimalSeparator": "string",
      "thousandSeparator": "string",
      "isPercentage": "string",
      "numDecimals": "string",
      "numberScaling": "string",
      "showTitle": true,
      "yMinMax": true,
      "zMinMax": true,
      "yMin": "string",
      "yMax": "string",
      "zMin": "string",
      "zMax": "string",
      "dontTrimBarLabel": "string",
      "defaultLink": {},
      "entityLinkMap": {},
      "fusionSource": {},
      "fusionStyles": {},
      "fusionTheme": "Classic",
      "height": 0,
      "legendPosition": "Bottom",
      "mapDisplayType": "Afghanistan",
      "mapValueRanges": [],
      "showLegend": true,
      "width": 0,
      "ssChartDisplayType": "Area2D",
      "chartLink": {},
      "customColors": [],
      "msChartDisplayType": "MSArea",
      "syAxisName": "string",
      "syNumberPrefix": "string",
      "syNumberSuffix": "string",
      "hideSyValues": true,
      "centerValues": true,
      "syDecimalSeparator": "string",
      "syThousandSeparator": "string",
      "isSyPercentage": "string",
      "syNumDecimals": "string",
      "syNumberScaling": "string",
      "lowerLimitDisplayName": "string",
      "upperLimitDisplayName": "string",
      "valueToolTip": "string",
      "gaugeDisplayType": "AngularGauge",
      "link": {},
      "limitLabelFillColor": "string",
      "gaugeValueRanges": [],
      "trendpoint": {},
      "gaugeStartAngle": 0.1,
      "gaugeEndAngle": 0.1,
      "fillColor": {},
      "status": "Available",
      "enableHeaders": true,
      "workflowLinkDisplayStyle": {},
      "columns": []
    }
  },
  "isLayoutLocked": true,
  "name": "string",
  "pdfOptions": {
    "autoScale": true,
    "customScaleValue": 0.1,
    "footerText": "string",
    "includePageNumber": true,
    "portraitOrientation": true,
    "showTotalPageNumber": true,
    "tableViewportWidth": 0.1
  },
  "sources": [
    {
      "dependencies": [],
      "name": "string",
      "type": "AggregateTransformation",
      "scalarType": "string",
      "value": null,
      "column": "string",
      "keyValues": {},
      "table": "string",
      "expression": "string",
      "variables": [],
      "required": true,
      "useWebUser": true,
      "isParameterValueScalar": true,
      "parameterValue": {},
      "parameterId": 0,
      "columnNames": [],
      "source": {},
      "formula": "string",
      "partitionColumns": [],
      "timeEnd": "2019-08-24T14:15:22Z",
      "timeFrequency": {},
      "timePartition": "string",
      "timeStart": "2019-08-24T14:15:22Z",
      "newColumnName": "string",
      "keyColumns": [],
      "newColumns": [],
      "transposeColumn": "string"
    }
  ],
  "trees": [
    {
      "name": "string",
      "parent": "string",
      "parentNodeType": "string",
      "treeNodeType": "Folder"
    }
  ],
  "version": {
    "rowVersion": 0
  },
  "webReportId": 0,
  "workflowObjectId": 0,
  "element": {},
  "styleCategory": "string"
}

Varicent.RESTAPI.v1.DTOs.WebReportElementDTO

Properties

Name

Type

Required

Restrictions

Description

webReportName

string¦null

false

none

none

webReportDefinition

Varicent.RESTAPI.v1.DTOs.WebReportDTO

false

none

none

elementId

integer(int32)

false

none

none

parentBlockId

integer(int32)¦null

false

none

none

bounds

System.Drawing.RectangleF

false

none

none

color

Varicent.RESTAPI.v1.DTOs.ColorDefinitionDTO

false

none

none

name

string¦null

false

none

none

parentBlock

Varicent.RESTAPI.v1.DTOs.Composer.ExpandableBlockElementDTO

false

none

none

isVisible

boolean

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "webReportName": "string",
  "webReportDefinition": {
    "allowPdfExport": true,
    "showInquiry": true,
    "batchExportDetails": {
      "canBatchExport": true,
      "picklistRefParam": "string"
    },
    "background": {
      "color": {},
      "image": {},
      "imageAttachment": "Scroll",
      "imagePosition": "Absolute",
      "imageTile": "None",
      "webreportId": 0,
      "x": 0,
      "y": 0,
      "opacity": 0
    },
    "defaultStyle": {
      "color": {},
      "font": {}
    },
    "directlyAccessible": true,
    "frameLayout": {
      "horizontalAlign": "Left",
      "verticalAlign": "Top",
      "type": "Frame",
      "childHeightPercents": [],
      "childWidthPercents": [],
      "frames": [],
      "name": "string",
      "numColumns": 0,
      "numRows": 0,
      "display": {}
    },
    "isLayoutLocked": true,
    "name": "string",
    "pdfOptions": {
      "autoScale": true,
      "customScaleValue": 0.1,
      "footerText": "string",
      "includePageNumber": true,
      "portraitOrientation": true,
      "showTotalPageNumber": true,
      "tableViewportWidth": 0.1
    },
    "sources": [
      {}
    ],
    "trees": [
      {}
    ],
    "version": {
      "rowVersion": 0
    },
    "webReportId": 0,
    "workflowObjectId": 0,
    "element": {},
    "styleCategory": "string"
  },
  "elementId": 0,
  "parentBlockId": 0,
  "bounds": {
    "location": {
      "isEmpty": true,
      "x": 0.1,
      "y": 0.1
    },
    "size": "string",
    "x": 0.1,
    "y": 0.1,
    "width": 0.1,
    "height": 0.1,
    "left": 0.1,
    "top": 0.1,
    "right": 0.1,
    "bottom": 0.1,
    "isEmpty": true
  },
  "color": {
    "a": 0,
    "b": 0,
    "g": 0,
    "r": 0
  },
  "name": "string",
  "parentBlock": {
    "id": 0,
    "name": "string",
    "href": "string"
  },
  "isVisible": true,
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.WebReportHtmlPreviewDTO

Properties

Name

Type

Required

Restrictions

Description

content

string¦null

false

none

none

css

string¦null

false

none

none

javascript

string¦null

false

none

none

json
{
  "content": "string",
  "css": "string",
  "javascript": "string"
}

Varicent.RESTAPI.v1.DTOs.WebReportNameDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

name

string¦null

false

none

none

isFavorite

boolean

false

none

none

workflowObjectId

integer(int32)

false

none

none

json
{
  "id": 0,
  "name": "string",
  "isFavorite": true,
  "workflowObjectId": 0
}

Varicent.RESTAPI.v1.DTOs.WebReportPdfOptionsDTO

Properties

Name

Type

Required

Restrictions

Description

autoScale

boolean

false

none

none

customScaleValue

number(double)

false

none

none

footerText

string¦null

false

none

none

includePageNumber

boolean

false

none

none

portraitOrientation

boolean

false

none

none

showTotalPageNumber

boolean

false

none

none

tableViewportWidth

number(double)¦null

false

none

none

json
{
  "autoScale": true,
  "customScaleValue": 0.1,
  "footerText": "string",
  "includePageNumber": true,
  "portraitOrientation": true,
  "showTotalPageNumber": true,
  "tableViewportWidth": 0.1
}

Varicent.RESTAPI.v1.DTOs.WebReportValidationRuleDTO

Properties

Name

Type

Required

Restrictions

Description

formula

string¦null

false

none

none

errorMessage

string¦null

false

none

none

json
{
  "formula": "string",
  "errorMessage": "string"
}

Varicent.RESTAPI.v1.DTOs.WebUserDTO

Properties

Name

Type

Required

Restrictions

Description

isWebEnabled

boolean

false

none

none

isLocked

boolean¦null

false

none

none

changePasswordOnNextLogin

boolean¦null

false

none

none

password

string¦null

false

none

none

title

string¦null

false

none

none

email

string¦null

false

none

none

phone

string¦null

false

none

none

reportsTo

string¦null

false

none

none

name

string¦null

false

none

none

id

string¦null

false

none

none

json
{
  "isWebEnabled": true,
  "isLocked": true,
  "changePasswordOnNextLogin": true,
  "password": "string",
  "title": "string",
  "email": "string",
  "phone": "string",
  "reportsTo": "string",
  "name": "string",
  "id": "string"
}

Varicent.RESTAPI.v1.DTOs.WebUserWithGroupDTO

Properties

Name

Type

Required

Restrictions

Description

groupName

string¦null

false

none

none

parentName

string¦null

false

none

none

isWebEnabled

boolean

false

none

none

isLocked

boolean¦null

false

none

none

changePasswordOnNextLogin

boolean¦null

false

none

none

password

string¦null

false

none

none

title

string¦null

false

none

none

email

string¦null

false

none

none

phone

string¦null

false

none

none

reportsTo

string¦null

false

none

none

name

string¦null

false

none

none

id

string¦null

false

none

none

json
{
  "groupName": "string",
  "parentName": "string",
  "isWebEnabled": true,
  "isLocked": true,
  "changePasswordOnNextLogin": true,
  "password": "string",
  "title": "string",
  "email": "string",
  "phone": "string",
  "reportsTo": "string",
  "name": "string",
  "id": "string"
}

Varicent.RESTAPI.v1.DTOs.Workflow.AdminNoteDTO

Properties

Name

Type

Required

Restrictions

Description

time

string(date-time)

false

none

none

author

string¦null

false

none

none

subject

string¦null

false

none

none

body

string¦null

false

none

none

noteID

integer(int32)

false

none

none

isNew

boolean

false

none

none

category

string

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

Enumerated Values

Property

Value

category

AdminMessage

category

Document

category

SignOff

category

InquiryAssigned

category

InquiryOpen

category

AdminPayeeMessage

category

InquiryReturned

category

InquiryEscalated

category

InquiryResubmitted

category

InquiryCommented

category

InquiryClosed

category

PlanApprovalDocument

json
{
  "time": "2019-08-24T14:15:22Z",
  "author": "string",
  "subject": "string",
  "body": "string",
  "noteID": 0,
  "isNew": true,
  "category": "AdminMessage",
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.Workflow.WorkflowTreeDTO

Properties

Name

Type

Required

Restrictions

Description

id

integer(int32)

false

none

none

name

string¦null

false

none

none

edges

[Varicent.RESTAPI.v1.DTOs.Workflow.WorkflowTreeEdgeDTO]¦null

false

none

none

nodes

[Varicent.RESTAPI.v1.DTOs.Workflow.WorkflowTreeNodeDTO]¦null

false

none

none

descendantList

object¦null

false

none

none

» additionalProperties

[integer]

false

none

none

version

Varicent.RESTAPI.v1.DTOs.RowVersionDTO

false

none

none

json
{
  "id": 0,
  "name": "string",
  "edges": [
    {
      "start": 0,
      "end": 0
    }
  ],
  "nodes": [
    {
      "nodeId": 0,
      "groupId": 0,
      "name": "string",
      "signOffType": "AnySignOff",
      "canAdjust": true
    }
  ],
  "descendantList": {
    "property1": [
      0
    ],
    "property2": [
      0
    ]
  },
  "version": {
    "rowVersion": 0
  }
}

Varicent.RESTAPI.v1.DTOs.Workflow.WorkflowTreeEdgeDTO

Properties

Name

Type

Required

Restrictions

Description

start

integer(int32)

false

none

none

end

integer(int32)

false

none

none

json
{
  "start": 0,
  "end": 0
}

Varicent.RESTAPI.v1.DTOs.Workflow.WorkflowTreeNodeDTO

Properties

Name

Type

Required

Restrictions

Description

nodeId

integer(int32)

false

none

none

groupId

integer(int32)

false

none

none

name

string¦null

false

none

none

signOffType

string

false

none

none

canAdjust

boolean

false

none

none

Enumerated Values

Property

Value

signOffType

AnySignOff

signOffType

AllSignOff

json
{
  "nodeId": 0,
  "groupId": 0,
  "name": "string",
  "signOffType": "AnySignOff",
  "canAdjust": true
}

Varicent.RESTAPI.v1.DTOs.WorkflowLinkDisplayStyleDTO

Properties

Name

Type

Required

Restrictions

Description

headerStyle

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

none

primaryStyle

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

none

secondaryStyle

Varicent.RESTAPI.v1.DTOs.CellStyleDTO

false

none

none

displayBorders

Varicent.RESTAPI.v1.DTOs.BordersDTO

false

none

none

displayPadding

Varicent.RESTAPI.v1.DTOs.PaddingDTO

false

none

none

json
{
  "headerStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "primaryStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "secondaryStyle": {
    "alignment": "Justify",
    "backColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    },
    "font": {
      "family": "string",
      "size": 0.1,
      "unit": "string",
      "bold": true,
      "italic": true,
      "underline": true,
      "strikeout": true
    },
    "foreColor": {
      "a": 0,
      "b": 0,
      "g": 0,
      "r": 0
    }
  },
  "displayBorders": {
    "bottom": {
      "color": {},
      "width": 0.1
    },
    "left": {
      "color": {},
      "width": 0.1
    },
    "right": {
      "color": {},
      "width": 0.1
    },
    "top": {
      "color": {},
      "width": 0.1
    }
  },
  "displayPadding": {
    "bottom": 0.1,
    "left": 0.1,
    "right": 0.1,
    "top": 0.1
  }
}

Varicent.RESTAPI.v1.DTOs.WorkflowPermissionsDTO

Properties

Name

Type

Required

Restrictions

Description

advanceToken

[string]¦null

false

none

none

viewDocuments

[string]¦null

false

none

none

json
{
  "advanceToken": [
    "Start"
  ],
  "viewDocuments": [
    "Start"
  ]
}

varicent.RESTAPI.v1.DTOs.PortColumnDTO

Properties

Name

Type

Required

Restrictions

Description

portId

integer(int32)

false

none

none

name

string¦null

false

none

none

dataType

string

false

none

none

order

integer(int32)

false

none

none

isKey

boolean

false

none

none

sourceColumn

string¦null

false

none

none

Enumerated Values

Property

Value

dataType

String

dataType

Date

dataType

Numeric

dataType

Int

dataType

LongString

json
{
  "portId": 0,
  "name": "string",
  "dataType": "String",
  "order": 0,
  "isKey": true,
  "sourceColumn": "string"
}