Activities

(implementation of Activity entity)

Provides following method for API calls:

• Create
• Delete
• DeleteByIds
• Get
• GetAll
• GetAttachment
• SaveAll
• SaveAllAndReturnIds
• Search
• SearchFirst
• SetAttachment
• Update

Create

URL:

/api/v1/{format}/activities

Method:

POST

Parameters request:

Object< Activity >

Parameters response:

Object

Description:

1. description(STRING)
2. file_name(STRING)
3. issue(OBJECT< Issue >)
4. reported_date(NUMBER(Date representation wrapped))
5. reported_by(OBJECT< Person >)
6. id(NUMBER)

Delete

URL:

/api/v1/{format}/activities/{id}

Method:

DELETE

Parameters request:

null

Parameters response:

Object

Description:

1. description(STRING)
2. file_name(STRING)
3. issue(OBJECT< Issue >)
4. reported_date(NUMBER(Date representation wrapped))
5. reported_by(OBJECT< Person >)
6. id(NUMBER)

DeleteByIds

URL:

/api/v1/{format}/activities

Method:

DELETE

Parameters request:

Url parameters: ids

Parameters response:

Array

Description:

1. description(STRING)
2. file_name(STRING)
3. issue(OBJECT< Issue >)
4. reported_date(NUMBER(Date representation wrapped))
5. reported_by(OBJECT< Person >)
6. id(NUMBER)

Get

URL:

/api/v1/{format}/activities/{id}

Method:

GET

Parameters request:

null

Parameters response:

Object

Description:

1. description(STRING)
2. file_name(STRING)
3. issue(OBJECT< Issue >)
4. reported_date(NUMBER(Date representation wrapped))
5. reported_by(OBJECT< Person >)
6. id(NUMBER)

GetAll

URL:

/api/v1/{format}/activities

Method:

GET

Parameters request:

null

Parameters response:

Array

Description:

1. description(STRING)
2. file_name(STRING)
3. issue(OBJECT< Issue >)
4. reported_date(NUMBER(Date representation wrapped))
5. reported_by(OBJECT< Person >)
6. id(NUMBER)

GetAttachment

URL:

/api/v1/{format}/activities/attach/{id}

Method:

GET

Parameters request:

null

Parameters response:

Object

Description:

Starting downloading of file

Note

After redirecting user to url, will be started downloading.

SaveAll

URL:

/api/v1/{format}/activities/saveall

Method:

POST

Parameters request:

Array< Activity >

Parameters response:

Array

Description:

1. description(STRING)
2. file_name(STRING)
3. issue(OBJECT< Issue >)
4. reported_date(NUMBER(Date representation wrapped))
5. reported_by(OBJECT< Person >)
6. id(NUMBER)

SaveAllAndReturnIds

URL:

/api/v1/{format}/activities/saveall

Method:

POST

Parameters request:

Url parameters: full

Array< Activity >

Parameters response:

Array

Description:

ARRAY<NUMBER>

Search

URL:

/api/v1/{format}/activities/search

Method:

POST

Parameters request:

Array< SearchCriteries$SearchCriteriaResult >

Parameters response:

Array

Description:

1. description(STRING)
2. file_name(STRING)
3. issue(OBJECT< Issue >)
4. reported_date(NUMBER(Date representation wrapped))
5. reported_by(OBJECT< Person >)
6. id(NUMBER)

SearchFirst

URL:

/api/v1/{format}/activities/search/first

Method:

POST

Parameters request:

Array< SearchCriteries$SearchCriteriaResult >

Parameters response:

Object

Description:

1. description(STRING)
2. file_name(STRING)
3. issue(OBJECT< Issue >)
4. reported_date(NUMBER(Date representation wrapped))
5. reported_by(OBJECT< Person >)
6. id(NUMBER)

SetAttachment

URL:

/api/v1/{format}/activities/attach/{id}

Method:

POST

Parameters request:

null

Parameters response:

Object

Description:

Note

You need submit form with action url.

In form must be input file!

Max file size 20Mb.

Update

URL:

/api/v1/{format}/activities/{id}

Method:

PUT

Parameters request:

Object< Activity >

Parameters response:

Object

Description:

1. description(STRING)
2. file_name(STRING)
3. issue(OBJECT< Issue >)
4. reported_date(NUMBER(Date representation wrapped))
5. reported_by(OBJECT< Person >)
6. id(NUMBER)