This documentation supports the 19.02 version of Remedy Action Request System.

To view the latest version, select the version from the Product version menu.

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}
 Merge an entry with attachment
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
 Get Status
Responses

Code

Description

Schema

200

successful operation

string

GET /arsys/v1.0/entry/{formName}
 Get multiple entries
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: {

  }

}|

POST /arsys/v1.0/entry/{formName}
 Create an entry with attachments
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 {

  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

RestEntry {

  values: {

  }

  _links: {

  }

  _embedded: {

  }

}|

OPTIONS /arsys/v1.0/entry/{formName}
 Get form options
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 {

  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}
 Get an entry
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: {

  }

}|

PUT /arsys/v1.0/entry/{formName}/{entryId}
 Updates an entry with attachment
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 {

  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}
 Delete an entry
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

[

  string

  Enum: [

    "NONE",

    "FORCE",

    "NOCASCADE"

  ]

]|

Responses

Code

Description

Schema

default

successful operation

OPTIONS /arsys/v1.0/entry/{formName}/{entryId}
 Get form options
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 {

  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}
 Get an association
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 {

  entries: [

     RestEntry {

      values: {

      }

      _links: {

      }

      _embedded: {

      }

    }

  ]

  _links: {

  }

}|

OPTIONS /arsys/v1.0/entry/{formName}/{entryId}/assoc/{associationName}
 Get form options
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 {

  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}
 Get an attachment
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

]|

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}
 Returns form fields
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 fieldIds 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 {

  done: boolean

  cancelled: boolean

  suspended: boolean

}|

400

Request body is incorrect

AsyncResponse {

  done: boolean

  cancelled: boolean

  suspended: boolean

}|

403

Forbidden

AsyncResponse {

  done: boolean

  cancelled: boolean

  suspended: boolean

}|

404

Form does not exist

AsyncResponse {

  done: boolean

  cancelled: boolean

  suspended: boolean

}|

500

Internal Server Error

AsyncResponse {

  done: boolean

  cancelled: boolean

  suspended: boolean

}|

GET /arsys/v1.0/fields/{formName}/{fieldId}
 Returns form field definitions
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 fieldId 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 {

  done: boolean

  cancelled: boolean

  suspended: boolean

}|

403

Forbidden

AsyncResponse {

  done: boolean

  cancelled: boolean

  suspended: boolean

}|

404

Form does not exist

AsyncResponse {

  done: boolean

  cancelled: boolean

  suspended: boolean

}|

500

Internal Server Error

AsyncResponse {

  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
 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

string

password

formData

string

authString

formData

string

Responses

Code

Description

Schema

200

successful operation

string

POST /jwt/logout
 logout
Description

Called to logout an existing user session

Responses

Code

Description

Schema

default

successful operation



Was this page helpful? Yes No Submitting... Thank you

Comments