End points in AR REST API
This version of Remedy 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
MergeEntry REST-API
POST /arsys/v1/mergeEntry/{formName}
Description
Merges an entry into a form with attachment
Responses
Code | Description | Schema |
---|
default | successful operation |
Operations on entry objects
GET /arsys/v1.0/entry
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
GET /arsys/v1.0/entry/{formName}
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. |
|
fields | query | Selects what parts of the JSON document to return (for example, ?fields=values(field1,field2)) |
|
sort | query | Order in which sorts the results (for example, ?sort=submitDate.desc) |
|
q | query | Search qualification |
|
offset | query | Offset for the entry return |
|
limit | query | Number of instances in which limit the result |
|
expand | query | Expands related entries (associations). |
|
string
]
|
runfilters | query | Flag indicating if get Filters to be called. |
|
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
entries:
[
RestEntry
{
values:
{
}
_links:
{
}
_embedded:
{
}
}
]
_links:
{
}
}
|
POST /arsys/v1.0/entry/{formName}
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). |
|
body | body | Expects a RestEntry bodypart. Also, expects one or more attachments.The actual binary values are passed as attach-fieldname bodyparts |
|
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
{
}
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 |
|
values:
{
}
_links:
{
}
_embedded:
{
}
}
|
OPTIONS /arsys/v1.0/entry/{formName}
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. |
|
fields | query | Selects what parts of the JSON document to return (for example, fields=values(fieldName1,fieldName2)) |
|
expand | query | Expands the related entries (associations). |
|
string
]
|
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
id:
string
get$ref:
string
get$schema:
string
disallow:
[
string
]
required:
boolean
readonly:
boolean
description:
string
extends:
[
string
]
}
|
GET /arsys/v1.0/entry/{formName}/{entryId}
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 |
|
entryId | path | The entry ID |
|
fields | query | Selects what parts of the JSON document to return (for example, ?fields=entryId1,entryId2). |
|
expand | query | Expands the related entries (associations). |
|
string
]
|
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
values:
{
}
_links:
{
}
_embedded:
{
}
}
|
PUT /arsys/v1.0/entry/{formName}/{entryId}
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 |
|
body | body | Expects a RestEntry bodypart. Also, expects one or more attachments.The actual binary values are passed as attach-fieldname bodyparts |
|
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
{
}
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 |
DELETE /arsys/v1.0/entry/{formName}/{entryId}
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. |
|
entryId | path | The entry ID |
|
options | query | Delete options |
|
string
Enum: [
"NONE",
"FORCE",
"NOCASCADE"
]
]
|
Responses
Code | Description | Schema |
---|
default | successful operation |
OPTIONS /arsys/v1.0/entry/{formName}/{entryId}
Description
Retrieves the information of the form schema.
Parameters
Name | Located in | Description | Default | Schema |
---|
formName | path |
|
entryId | path |
|
fields | query |
|
expand | query |
|
string
]
|
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
id:
string
get$ref:
string
get$schema:
string
disallow:
[
string
]
required:
boolean
readonly:
boolean
description:
string
extends:
[
string
]
}
|
GET /arsys/v1.0/entry/{formName}/{entryId}/assoc/{associationName}
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. |
|
entryId | path | The entry ID. |
|
associationName | path | The form for which an entries are to be read. |
|
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
entries:
[
RestEntry
{
values:
{
}
_links:
{
}
_embedded:
{
}
}
]
_links:
{
}
}
|
OPTIONS /arsys/v1.0/entry/{formName}/{entryId}/assoc/{associationName}
Description
Retrieves the information of the form schema.
Parameters
Name | Located in | Description | Default | Schema |
---|
formName | path |
|
entryId | path |
|
associationName | path |
|
fields | query |
|
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
id:
string
get$ref:
string
get$schema:
string
disallow:
[
string
]
required:
boolean
readonly:
boolean
description:
string
extends:
[
string
]
}
|
GET /arsys/v1.0/entry/{formName}/{entryId}/attach/{fieldName}
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. |
|
entryId | path | The entry ID |
|
fieldName | path | The name of an attachment field. |
|
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
byte
]
|
This version of Remedy 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
Fields REST-API
GET /arsys/v1.0/fields/{formName}
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 |
|
field_ids | query | The fieldIds for which field definition has to be retrieved |
|
field_criteria | query | The field criteria to retrieve field definitions |
|
field_type | query | The field type to retrieve field definitions |
|
changed_since | query | 0 |
|
props_to_search | query |
|
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
done:
boolean
cancelled:
boolean
suspended:
boolean
}
|
400 | Request body is incorrect |
|
done:
boolean
cancelled:
boolean
suspended:
boolean
}
|
403 | Forbidden |
|
done:
boolean
cancelled:
boolean
suspended:
boolean
}
|
404 | Form does not exist |
|
done:
boolean
cancelled:
boolean
suspended:
boolean
}
|
500 | Internal Server Error |
|
done:
boolean
cancelled:
boolean
suspended:
boolean
}
|
GET /arsys/v1.0/fields/{formName}/{fieldId}
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 |
|
fieldId | path | The fieldId for which field definition has to be retrieved |
|
field_criteria | query | Additional field criteria |
|
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
done:
boolean
cancelled:
boolean
suspended:
boolean
}
|
400 | Request body is incorrect |
|
done:
boolean
cancelled:
boolean
suspended:
boolean
}
|
403 | Forbidden |
|
done:
boolean
cancelled:
boolean
suspended:
boolean
}
|
404 | Form does not exist |
|
done:
boolean
cancelled:
boolean
suspended:
boolean
}
|
500 | Internal Server Error |
|
done:
boolean
cancelled:
boolean
suspended:
boolean
}
|
This version of Remedy 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
AR Login Logout apis
POST /jwt/login
Description
Returns a jwt auth token to be used to authenticate other AR REST apis
Parameters
Name | Located in | Description | Default | Schema |
---|
username | formData |
|
password | formData |
|
authString | formData |
|
Responses
Code | Description | Schema |
---|
200 | successful operation |
|
POST /jwt/logout
Description
Called to logout an existing user session
Responses
Code | Description | Schema |
---|
default | successful operation |
Comments
Log in or register to comment.