Endpoints in AR REST API

This version of AR System supports version v1.0 of the REST API and earlier. The base URL for the latest API version is:

http://localhost:8008/api

Merge entry

{{status subtle="false" colour="Green" title="POST"/}}

 /arsys/v1/mergeEntry/{formName}
Click here to expand...
Description

Merges an entry into a form with attachment

Responses

Code

Description

Schema

default

successful operation


Entry

{{status subtle="false" colour="Blue" title="GET"/}}

 /arsys/v1.0/entry
Click here to expand...
Responses

Code

Description

Schema

200

successful operation

string

{{status subtle="false" colour="Blue" title="GET"/}}

 /arsys/v1.0/entry/{formName}
Click here to expand...
Description

Returns the details of all the entries on a form.The default behavior is to internally call Get List Entry With Fields, which does not initiate Get Entry workflow.

Parameters

Name

Located in

Description

Default

Schema

formName

path

The form for which an entries are to be read.

 

string*

fields

query

Selects what parts of the JSON document to return (for example, ?fields=values(field1,field2))

 

string

sort

query

Order in which sorts the results (for example, ?sort=submitDate.desc)

 

string

q

query

Search qualification

 

string

offset

query

Offset for the entry return

 

int32

limit

query

Number of instances in which limit the result

 

int32

expand

query

Expands related entries (associations).

 

string

runfilters

query

Flag indicating if get Filters to be called.

 

string

Responses

Code

Description

Schema

200

successful operation

RestEntries {

  entries: [

     RestEntry {

      values: {

      }

      _links: {

      }

      _embedded: {

      }

    }

  ]

  _links: {

  }

}|

{{status subtle="false" colour="Green" title="POST"/}}

 /arsys/v1.0/entry/{formName}
Click here to expand...
Description

Display-only forms and Join forms do not generate an entry ID when they are created, and the status code 204 is returned. If an entry ID is generated, such as on a regular form, status code 201 with the Location header is returned.

Parameters

Name

Located in

Description

Default

Schema

fields

query

Selects what parts of the JSON document to return (for example, ?fields=entryId1,entryId2).

 

string

body

body

Expects a RestEntry bodypart. Also, expects one or more attachments. The actual binary values are passed as attach-fieldname bodyparts

 

FormDataMultiPart {

    type: string  contentDisposition: ContentDisposition {

    parameters: {

    }

    fileName: string

    creationDate: date-time

    modificationDate: date-time

    readDate: date-time

    size: int64

  }

  entity: {

  }

  headers: {

  }

  mediaType: MediaType {

    type: string

    subtype: string

    parameters: {

    }

    wildcardSubtype: boolean

    wildcardType: boolean

  }

  messageBodyWorkers: MessageBodyWorkers {

  }

  parent: MultiPart {

    contentDisposition: ContentDisposition {

      type: string

      parameters: {

      }

      fileName: string

      creationDate: date-time

      modificationDate: date-time

      readDate: date-time

      size: int64

    }

    entity: {

    }

    headers: {

    }

    mediaType: MediaType {

      type: string

      subtype: string

      parameters: {

      }

      wildcardSubtype: boolean

      wildcardType: boolean

    }

    messageBodyWorkers: MessageBodyWorkers {

    }

    parent: string

    providers: Providers {

    }

    bodyParts: [

      string

    ]

    parameterizedHeaders: {

    }

  }

  providers: Providers {

  }

  bodyParts: [

     BodyPart {

      contentDisposition: ContentDisposition {

        type: string

        parameters: {

        }

        fileName: string

        creationDate: date-time

        modificationDate: date-time

        readDate: date-time

        size: int64

      }

      entity: {

      }

      headers: {

      }

      mediaType: MediaType {

        type: string

        subtype: string

        parameters: {

        }

        wildcardSubtype: boolean

        wildcardType: boolean

      }

      messageBodyWorkers: MessageBodyWorkers {

      }

      parent: MultiPart {

        contentDisposition: ContentDisposition {

          type: string

          parameters: {

          }

          fileName: string

          creationDate: date-time

          modificationDate: date-time

          readDate: date-time

          size: int64

        }

        entity: {

        }

        headers: {

        }

        mediaType: MediaType {

          type: string

          subtype: string

          parameters: {

          }

          wildcardSubtype: boolean

          wildcardType: boolean

        }

        messageBodyWorkers: MessageBodyWorkers {

        }

        parent: string

        providers: Providers {

        }

        bodyParts: [

          string

        ]

        parameterizedHeaders: {

        }

      }

      providers: Providers {

      }

      parameterizedHeaders: {

      }

    }

  ]

  fields: {

  }

  parameterizedHeaders: {

  }

}|


Responses

Code

Description

Schema

200

successful operation

RestEntry {

  }  values: {

  _links: {

  }

  _embedded: {

  }

}|

{{status subtle="false" colour="Yellow" title="OPTIONS"/}}

 /arsys/v1.0/entry/{formName}
Click here to expand...
Description

Retrieves the information of the form schema.

Parameters

Name

Located in

Description

Default

Schema

formName

path

The form for which option information is to be retrieved.

 

string*

fields

query

Selects what parts of the JSON document to return (for example, fields=values(fieldName1,fieldName2))

 

string

expand

query

Expands the related entries (associations).

 

string

Responses

Code

Description

Schema

200

successful operation

JsonSchema {

  get$ref: string  id: string

  get$schema: string

  disallow: [

    string

  ]

  required: boolean

  readonly: boolean

  description: string

  extends: [

    string

  ]

}|

{{status subtle="false" colour="Blue" title="GET"/}}

 /arsys/v1.0/entry/{formName}/{entryId}
Click here to expand...
Description

Returns the details of an entry on a form. The entry object will contain field values for all data fields to which the user has permission.

Parameters

Name

Located in

Description

Default

Schema

formName

path

The form for which an entry is to be read

 

string*

entryId

path

The entry ID

 

string*

fields

query

Selects what parts of the JSON document to return (for example, ?fields=entryId1,entryId2).

 

string

expand

query

Expands the related entries (associations).

 

string

Responses
Code
Description
Schema
200
successful operation
RestEntry {
  }  values: {
  _links: {
  }
  _embedded: {
  }
}|
{{status subtle="false" colour="Yellow" title="PUT"/}}

 /arsys/v1.0/entry/{formName}/{entryId}
Click here to expand...
Description

This operation updates an entry with an attachment.

Parameters

Name

Located in

Description

Default

Schema

If-Unmodified-Since

header

If-Unmodified-Since HTTP Date

 

date-time

body

body

Expects a RestEntry bodypart. Also, expects one or more attachments. The actual binary values are passed as attach-fieldname bodyparts

 

FormDataMultiPart {

    type: string  contentDisposition: ContentDisposition {

    parameters: {

    }

    fileName: string

    creationDate: date-time

    modificationDate: date-time

    readDate: date-time

    size: int64

  }

  entity: {

  }

  headers: {

  }

  mediaType: MediaType {

    type: string

    subtype: string

    parameters: {

    }

    wildcardSubtype: boolean

    wildcardType: boolean

  }

  messageBodyWorkers: MessageBodyWorkers {

  }

  parent: MultiPart {

    contentDisposition: ContentDisposition {

      type: string

      parameters: {

      }

      fileName: string

      creationDate: date-time

      modificationDate: date-time

      readDate: date-time

      size: int64

    }

    entity: {

    }

    headers: {

    }

    mediaType: MediaType {

      type: string

      subtype: string

      parameters: {

      }

      wildcardSubtype: boolean

      wildcardType: boolean

    }

    messageBodyWorkers: MessageBodyWorkers {

    }

    parent: string

    providers: Providers {

    }

    bodyParts: [

      string

    ]

    parameterizedHeaders: {

    }

  }

  providers: Providers {

  }

  bodyParts: [

     BodyPart {

      contentDisposition: ContentDisposition {

        type: string

        parameters: {

        }

        fileName: string

        creationDate: date-time

        modificationDate: date-time

        readDate: date-time

        size: int64

      }

      entity: {

      }

      headers: {

      }

      mediaType: MediaType {

        type: string

        subtype: string

        parameters: {

        }

        wildcardSubtype: boolean

        wildcardType: boolean

      }

      messageBodyWorkers: MessageBodyWorkers {

      }

      parent: MultiPart {

        contentDisposition: ContentDisposition {

          type: string

          parameters: {

          }

          fileName: string

          creationDate: date-time

          modificationDate: date-time

          readDate: date-time

          size: int64

        }

        entity: {

        }

        headers: {

        }

        mediaType: MediaType {

          type: string

          subtype: string

          parameters: {

          }

          wildcardSubtype: boolean

          wildcardType: boolean

        }

        messageBodyWorkers: MessageBodyWorkers {

        }

        parent: string

        providers: Providers {

        }

        bodyParts: [

          string

        ]

        parameterizedHeaders: {

        }

      }

      providers: Providers {

      }

      parameterizedHeaders: {

      }

    }

  ]

  fields: {

  }

  parameterizedHeaders: {

  }

}|


Responses

Code

Description

Schema

default

successful operation


{{status subtle="false" colour="Red" title="DELETE"/}}

 /arsys/v1.0/entry/{formName}/{entryId}
Click here to expand...
Description

Delete an entry from a particular form. You can also use the option FORCE to force delete all the list of entries, for example, ?options=FORCE

Parameters

Name

Located in

Description

Default

Schema

formName

path

The form for which entry is to be deleted.

 

string*

entryId

path

The entry ID

 

string*

options

query

Delete options

 

[

  Enum: [  string

    "NONE",

    "FORCE",

    "NOCASCADE"

  ]

]|

Responses

Code

Description

Schema

default

successful operation


{{status subtle="false" colour="Yellow" title="OPTIONS"/}}

 /arsys/v1.0/entry/{formName}/{entryId}
Click here to expand...
Description

Retrieves the information of the form schema.

Parameters

Name

Located in

Description

Default

Schema

formName

path

 

 

string*

entryId

path

 

 

string*

fields

query

 

 

string

expand

query

 

 

string


Responses

Code

Description

Schema

200

successful operation

JsonSchema {

  get$ref: string  id: string

  get$schema: string

  disallow: [

    string

  ]

  required: boolean

  readonly: boolean

  description: string

  extends: [

    string

  ]

}|

{{status subtle="false" colour="Blue" title="GET"/}}

 /arsys/v1.0/entry/{formName}/{entryId}/assoc/{associationName}
Click here to expand...
Description

Returns the list of associated entries for a particular entry.

Parameters

Name

Located in

Description

Default

Schema

formName

path

The form for which an entry is to be read.

 

string*

entryId

path

The entry ID.

 

string*

associationName

path

The form for which an entries are to be read.

 

string*

Responses

Code

Description

Schema

200

successful operation

RestEntries {

     RestEntry {  entries: [

      values: {

      }

      _links: {

      }

      _embedded: {

      }

    }

  ]

  _links: {

  }

}|

{{status subtle="false" colour="Yellow" title="OPTIONS"/}}

 /arsys/v1.0/entry/{formName}/{entryId}/assoc/{associationName}
Click here to expand...
Description

Retrieves the information of the form schema.

Parameters

Name

Located in

Description

Default

Schema

formName

path

 

 

string*

entryId

path

 

 

string*

associationName

path

 

 

string*

fields

query

 

 

string

Responses

Code

Description

Schema

200

successful operation

JsonSchema {

  get$ref: string  id: string

  get$schema: string

  disallow: [

    string

  ]

  required: boolean

  readonly: boolean

  description: string

  extends: [

    string

  ]

}|

{{status subtle="false" colour="Blue" title="GET"/}}

 /arsys/v1.0/entry/{formName}/{entryId}/attach/{fieldName}
Click here to expand...
Description

Returns an attachment for a particular entry or for the list of entries.

Parameters

Name

Located in

Description

Default

Schema

formName

path

The form for which an entry is to be created.

 

string*

entryId

path

The entry ID

 

string*

fieldName

path

The name of an attachment field.

 

string*

Responses

Code

Description

Schema

200

successful operation

byte

Fields

{{status subtle="false" colour="Blue" title="GET"/}}

 /arsys/v1.0/fields/{formName}
Click here to expand...
Description

Returns details of fields on the form

Parameters

Name

Located in

Description

Default

Schema

formName

path

The form for which field definition has to be retrieved

 

string*

field_ids

query

The field Ids for which field definition has to be retrieved

 

string*

field_criteria

query

The field criteria to retrieve field definitions

 

string

field_type

query

The field type to retrieve field definitions

 

string

changed_since

query

 

0

int32

props_to_search

query

 

 

string

Responses

Code

Description

Schema

200

successful operation

AsyncResponse {

  cancelled: boolean  done: boolean

  suspended: boolean

}|

400

Request body is incorrect

AsyncResponse {

  cancelled: boolean  done: boolean

  suspended: boolean

}|


403

Forbidden

AsyncResponse {

  cancelled: boolean  done: boolean

  suspended: boolean

}|


404

Form does not exist

AsyncResponse {

 cancelled: boolean  done: boolean

  suspended: boolean

}|

500

Internal Server Error

AsyncResponse {

  cancelled: boolean  done: boolean

  suspended: boolean

}|

{{status subtle="false" colour="Blue" title="GET"/}}

 /arsys/v1.0/fields/{formName}/{fieldId}
Click here to expand...
Description

Returns details of field on the form

Parameters

Name

Located in

Description

Default

Schema

formName

path

The form for which field definition has to be retrieved

 

string*

fieldId

path

The field Id for which field definition has to be retrieved

 

int32*

field_criteria

query

Additional field criteria

 

string

Responses
Code
Description
Schema
200
successful operation
AsyncResponse {
  done: boolean
  cancelled: boolean
  suspended: boolean
}|
400
Request body is incorrect
AsyncResponse {
  cancelled: boolean  done: boolean
  suspended: boolean
}|
403
Forbidden
AsyncResponse {
  cancelled: boolean  done: boolean
  suspended: boolean
}|
404
Form does not exist
AsyncResponse {
  cancelled: boolean  done: boolean
  suspended: boolean
}|
500
Internal Server Error
AsyncResponse {
  cancelled: boolean  done: boolean
  suspended: boolean
}|

This version of AR System supports versions v1.0 of the REST API and earlier. The base URL for the latest API version is:

http://localhost:8008/api

Login

{{status subtle="false" colour="Green" title="POST"/}}

 /jwt/login
Click here to expand...
Description

Returns a jwt auth token to be used to authenticate other AR REST apis

Parameters

Name

Located in

Description

Default

Schema

username

formData

 

 

string

password

formData

 

 

string

authString

formData

 

 

string

Responses

Code

Description

Schema

200

successful operation

string

Logout

{{status subtle="false" colour="Green" title="POST"/}}

 /jwt/logout
Click here to expand...
Description

Called to logout an existing user session

Responses

Code

Description

Schema

default

successful operation



Menu

{{status subtle="false" colour="Green" title="POST"/}}

 /arsys/v1.0/menu/expand
Click here to expand...
Parameters

Name

Located in

Description

Default

Schema

body

body

ExpandMenu body part

 

RestExpandMenuRequestData {

 qualification_substitute_info: RestFieldAndKeywordEntry {  name: string

    form_name: string

    field_values: {

    }

    keyword_values: {

    }

  }

  max_entries: int32

  total_count: boolean

}|

Responses

Code

Description

Schema

200

successful operation

[

    type: string   RestMenuItem {

    label: string

    value: string

    content: [

      string

    ]

  }

]|

{{status subtle="false" colour="Blue" title="GET"/}}

 /arsys/v1.0/menu/{name}
Click here to expand...
Parameters

Name

Located in

Description

Default

Schema

name

path

Name of the menu

 

string*

menu_criteria

query

Comma separate criteria list

 

string

Responses

Code

Description

Schema

200

successful operation

RestMenu {

  new_name: string  name: string

  help_text: string

  menu_type: string

  refresh_code: int32

  properties: {

  }

  owner: string

  menu_information: {

  }

  last_changed_by: string

  last_update_time: date-time

  change_history: [

     RestDiaryItem {

      user: string

      changed_time: date-time

      text: string

    }

  ]

  _links: {

  }

  _embedded: {

  }

}|

Webhook

{{status subtle="false" colour="Green" title="POST"/}}

 /arsys/v1.0/webhook
Click here to expand...
Parameters

Name

Located in

Description

Default

Schema

body

body

RestWebhook request body.

 

RestWebhook {

  description: string  webhook_id: string

  form_name: string

  condition: string

  entry_events: [

    string

  ]

  payload_fields: [

    string

  ]

  enabled: boolean

  callback: RestWebhookCallback {

    url: string

    authentication: RestWebhookAuthentication {

      type: string

      username: string

      password: string

    }

    headers: {

    }

  }

  _links: {

  }

  _embedded: {

  }

}|


Responses

Code

Description

Schema

default

successful operation


{{status subtle="false" colour="Blue" title="GET"/}}

 /arsys/v1.0/webhook/{id}
Click here to expand...
Parameters

Name

Located in

Description

Default

Schema

id

path

Id of webhook to get

 

string*

Responses

Code

Description

Schema

default

successful operation


{{status subtle="false" colour="Yellow" title="PUT"/}}

 /arsys/v1.0/webhook/{id}
Click here to expand...
Parameters

Name

Located in

Description

Default

Schema

id

path

Id of webhook to be updated

 

string*

body

body

RestWebhook request body.

 

RestWebhook {

  description: string  webhook_id: string

  form_name: string

  condition: string

  entry_events: [

    string

  ]

  payload_fields: [

    string

  ]

  enabled: boolean

  callback: RestWebhookCallback {

    url: string

    authentication: RestWebhookAuthentication {

      type: string

      username: string

      password: string

    }

    headers: {

    }

  }

  _links: {

  }

  _embedded: {

  }

}|

Responses

Code

Description

Schema

default

successful operation


{{status subtle="false" colour="Red" title="DELETE"/}}

 /arsys/v1.0/webhook/{id}
Click here to expand...
Parameters

Name

Located in

Description

Default

Schema

id

path

Id of webhook to be deleted

 

string*

Responses

Code

Description

Schema

200

successful operation

RestWebhook {

  description: string  webhook_id: string

  form_name: string

  condition: string

  entry_events: [

    string

  ]

  payload_fields: [

    string

  ]

  enabled: boolean

  callback: RestWebhookCallback {

    url: string

    authentication: RestWebhookAuthentication {

      type: string

      username: string

      password: string

    }

    headers: {

    }

  }

  _links: {

  }

  _embedded: {

  }

}|

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*