Methods
(static) countNotesForSupplier(supplierTaskId, token) → {number}
Counts all the notes that are referenced to the specified supplierTaskId (This service version is used by a Supplier Account in Supplier Portal)
Parameters:
| Name | Type | Description |
|---|---|---|
supplierTaskId |
string | Required: Id of the supplier task to which the notes are referenced |
token |
string | Required: the Authorization Bearer token passed in the Header of the request |
Listens to Events:
- event:HTTP GET /rest-api/corporateacademy-mediator/count-notes-for-supplier/:supplierTaskId
Returns:
Counter of the retrieved notes
- Type
- number
(static) countSupplierProposalNotes(supplierTaskId, token) → {number}
Counts all the notes that are referenced to the specified supplierTaskId
Parameters:
| Name | Type | Description |
|---|---|---|
supplierTaskId |
string | Required: Id of the supplier task to which the notes are referenced |
token |
string | Required: the Authorization Bearer token passed in the Header of the request |
Listens to Events:
- event:HTTP GET /rest-api/corporateacademy-mediator/count-supplier-proposal-notes/:supplierTaskId
Returns:
Counter of the retrieved notes
- Type
- number
(static) createNoteForSupplier(supplierTaskId, noteText, token) → {Note}
Creates a note for the specified proposal of a supplier (This service version is used by a Supplier Account in Supplier Portal)
Parameters:
| Name | Type | Description |
|---|---|---|
supplierTaskId |
string | Required: Id of the supplier task to which the notes will be referenced |
noteText |
string | Required: Text that will be used as description of the note |
token |
string | Required: the Authorization Bearer token passed in the Header of the request |
Listens to Events:
- event:HTTP POST /rest-api/corporateacademy-mediator/create-note-for-supplier/:supplierTaskId
Returns:
The newly created note
- Type
- Note
(static) createSupplierProposalNote(supplierTaskId, noteText, token) → {Note}
Creates a note for the specified proposal of a supplier
Parameters:
| Name | Type | Description |
|---|---|---|
supplierTaskId |
string | Required: Id of the supplier task to which the notes will be referenced |
noteText |
string | Required: Text that will be used as description of the note |
token |
string | Required: the Authorization Bearer token passed in the Header of the request |
Listens to Events:
- event:HTTP POST /rest-api/corporateacademy-mediator/create-supplier-proposal-note/:supplierTaskId
Returns:
The newly created note
- Type
- Note
(static) deleteNoteForSupplier(noteId, token) → {boolean}
Deletes a supplier proposal's note (This service version is used by a Supplier Account in Supplier Portal)
Parameters:
| Name | Type | Description |
|---|---|---|
noteId |
string | Required: Id of the note to delete |
token |
string | Required: the Authorization Bearer token passed in the Header of the request |
Listens to Events:
- event:HTTP POST /rest-api/corporateacademy-mediator/delete-note-for-supplier/:noteId
Returns:
Returns true if no errors were thrown during the execution
- Type
- boolean
(static) deleteSupplierProposalNote(noteId, token) → {boolean}
Deletes a supplier proposal's note
Parameters:
| Name | Type | Description |
|---|---|---|
noteId |
string | Required: Id of the note to delete |
token |
string | Required: the Authorization Bearer token passed in the Header of the request |
Listens to Events:
- event:HTTP POST /rest-api/corporateacademy-mediator/delete-supplier-proposal-note/:noteId
Returns:
Returns true if no errors were thrown during the execution
- Type
- boolean
(static) listNotesForSupplier(supplierTaskId, skipUserData, token) → {Array.<UserNote>}
Retrieves all the notes that are referenced to the specified supplierTaskId. By default, a restricted set of user data will be loaded for each note, referring to its creator. (This service version is used by a Supplier Account in Supplier Portal)
Parameters:
| Name | Type | Description |
|---|---|---|
supplierTaskId |
string | Required: Id of the supplier task to which the notes are referenced |
skipUserData |
boolean | Optional: If true, users data won't be retrieved |
token |
string | Required: the Authorization Bearer token passed in the Header of the request |
Listens to Events:
- event:HTTP GET /rest-api/corporateacademy-mediator/list-notes-for-supplier/:supplierTaskId
Returns:
Array containing the retrieved notes
- Type
- Array.<UserNote>
(static) listSupplierProposalNotes(supplierTaskId, skipUserData, token) → {Array.<UserNote>}
Retrieves all the notes that are referenced to the specified supplierTaskId. By default, a restricted set of user data will be loaded for each note, referring to its creator.
Parameters:
| Name | Type | Description |
|---|---|---|
supplierTaskId |
string | Required: Id of the supplier task to which the notes are referenced |
skipUserData |
boolean | Optional: If true, users data won't be retrieved |
token |
string | Required: the Authorization Bearer token passed in the Header of the request |
Listens to Events:
- event:HTTP GET /rest-api/corporateacademy-mediator/list-supplier-proposal-notes/:supplierTaskId
Returns:
Array containing the retrieved notes
- Type
- Array.<UserNote>