logo
API docs by Redocly

Journal Management (2.09)

Download OpenAPI specification:Download

Journal Management Concepts

The Journal Management provides developers with a REST API to manage Journals,Follow-Ups, and Tickets.

System Integrity

This Journal Management API provides developers a way to create and update Journals and Follow-Ups in the system.

Health Check

Use to check whether or not the JournalManagement service is up and running.

Authorizations:
SWT

Responses

Follow-up

Search Reminders

Search for reminders on a specific Follow-Up.

Available Fields

The following is a list of fields from the reminder and how they can be used within the search.

  • Filterable : createDate, createUser, durationSeconds, durationType, durationTypeID, lastModifiedDate, lastModifiedUser, reminderID, sentDate
  • Sortable : createDate, createUser, durationSeconds, durationType, durationTypeID, lastModifiedDate, lastModifiedUser, reminderID, sentDate
Authorizations:
SWT
path Parameters
followUpID
required
number
Example: 1

Unique identifier for the follow-up the reminder is associated to.

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters
contentType
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/JournalManagement/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Create Follow-up Reminder

Used to create a reminder on a follow-up

Note

  • The follow-up must be open.
  • reminderDurationSeconds must be greater than 0 and less than 2,147,483,647
path Parameters
followUpID
required
number
Example: 1

ID of the Follow-Up.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
reminderDurationSeconds
required
number

Number of seconds before the follow-up date when the reminder will be sent.

reminderDurationTypeID
required
number

Identifier of the duration type.

Responses

Request samples

Content type
application/json
{
  • "reminderDurationSeconds": 3600,
  • "reminderDurationTypeID": 2
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Delete A Reminder

Delete a single Reminder.

path Parameters
followUpID
required
number
Example: 1

Unique identifier for the follow-up the reminder is associated to.

reminderID
required
number
Example: 1

Unique identifier for the Reminder.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Update A Reminder

Modify a single Reminder on Follow-Up. This operation uses the JSON Patch document structure for defining updates to the company objects. Read more about JSON Patch (RFC 6902) Here.

Patchable Fields

The following is a list of properties of a Reminder that can be patched.

  • durationSeconds : replace
  • durationTypeID : replace
  • sentDate : add
path Parameters
followUpID
required
number
Example: 1

Unique identifier for the follow-up the reminder is associated to.

reminderID
required
number
Example: 1

Unique identifier for the Reminder.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
op
required
string

Indicates what type of JSON Patch operation being requested. Valid values are add, replace, and remove.

path
required
string

Path within the JSON document that should be modified.

value
required
string

If supplied, the new value to be used at the given path by the given operation.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "createDate": "2018-03-27T19:11:25.657Z",
  • "createUser": "'The Auxiliary Carrier'",
  • "durationSeconds": 3600,
  • "durationType": "'Hours'",
  • "durationTypeID": 1,
  • "lastModifiedDate": "2018-03-27T19:11:25.657Z",
  • "lastModifiedUser": "ws_user",
  • "reminderID": 1,
  • "sentDate": "2018-03-28T19:11:25.657Z"
}

Follow-up Reminders

Search Pending Follow-Up Reminders

Search for reminders on a specific Follow-Up.

Available Fields

The following is a list of fields from the pending reminder and how they can be used within the search.

  • Filterable : followUpID, reminderDate
  • Sortable : assignedTo, followUpID, reminderDate, reminderID
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters
contentType
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Journal

Create Journal

Provides the ability to create a journal. [Rev 1.05]

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
description
string

The descriptive text of the journal item.

isInternal
boolean

True indicates that this ticket is configured to prevent viewing by service subscribers.

  • Note: Only journal items that have WebViewable = true and IsInternal = false should be viewable by service subscribers.
isRetained
boolean

True indicates that this journal item will be displayed on the summary tab of the customer account.

journalStatusID
required
integer

The ID of a journal item status that was configured to be used with journal items of the specific class of this journal item.

journalTypeID
required
integer

The ID of a journal item type that was configured to be used with journal items of the specific class of this journal item.

objectID
required
integer

The ID of the object that the journal item is associated with.

  • Note: A journal cannot be associated with a journal.
objectType
required
string
Enum: "Customer" "BillingOrder" "Dispute" "Equipment" "JournalItem" "Other"

Indicates the type of object to be accessed or acted upon.

workflowEnvironment
string

If the journal item was created by or otherwise linked to a workflow, the environment in which the target workflow was run

workItemInstanceID
integer

If the journal item was created by or otherwise linked to a workflow, the unique identifier for the task ("work item") instance that created it.

Responses

Request samples

Content type
application/json
{
  • "description": "Send welcome survey",
  • "isInternal": false,
  • "isRetained": true,
  • "journalStatusID": 1001,
  • "journalTypeID": 80,
  • "objectID": 70,
  • "objectType": "Customer",
  • "workflowEnvironment": "string",
  • "workItemInstanceID": 0
}

Response samples

Content type
application/json
{
  • "createDate": "2019-12-24T14:07:25.427016-05:00",
  • "createUser": "Username",
  • "description": "Send welcome survey",
  • "isInternal": false,
  • "isRetained": true,
  • "journalID": 5421,
  • "journalStatus": "Pending",
  • "journalStatusID": 1001,
  • "journalType": "Forced Journals",
  • "journalTypeID": 80,
  • "lastModifiedDate": "2019-12-24T14:07:25.427016-05:00",
  • "lastModifiedUser": "Username",
  • "objectType": "Customer",
  • "objectID": 70,
  • "workflowEnvironment": "My WorkflowEnvironment Name",
  • "workItemInstanceID": 56
}

Get Journal

Provides the ability to retrieve journal information. [Rev 1.05]

Authorizations:
SWT
path Parameters
journalID
required
integer
Example: 1

Id of Journal to retrieve.

Responses

Response samples

Content type
application/json
{
  • "createDate": "2019-12-24T14:07:25.427016-05:00",
  • "createUser": "Username",
  • "description": "Send welcome survey",
  • "isInternal": false,
  • "isRetained": true,
  • "journalID": 5421,
  • "journalStatus": "Pending",
  • "journalStatusID": 1001,
  • "journalType": "Forced Journals",
  • "journalTypeID": 80,
  • "lastModifiedDate": "2019-12-24T14:07:25.427016-05:00",
  • "lastModifiedUser": "Username",
  • "objectType": "Customer",
  • "objectID": 70,
  • "workflowEnvironment": "My WorkflowEnvironment Name",
  • "workItemInstanceID": 56
}

Ticket

Close Ticket

Provides the ability to close a ticket and optionally close all its non-closed child tickets. [Rev 1.04]

Patchable Fields

The following is a list of properties of a ticket that can be patched.

  • ticketResolutionNote : add, remove, replace
  • ticketResolutionTypeID : add, remove, replace
  • ticketStatusID : add, replace

Note

  • The ticket status provided in the patch operations must be associated to a closed state
Authorizations:
SWT
path Parameters
ticketID
required
integer
Example: 1

ID of the Ticket to be closed.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
cascade
boolean

Indicated whether or not to close all the non-closed child tickets associated to the ticket.

Array of objects (JSONPatchTicketClose)

List of patch operation to apply to the ticket

Responses

Request samples

Content type
application/json
{
  • "cascade": true,
  • "ticketClosePatch": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Resolve Ticket

Provides the ability to resolve a ticket and optionally resolve all its non-closed child tickets. [Rev 1.04]

Patchable Fields

The following is a list of properties of a ticket that can be patched.

  • ticketResolutionNote : add, remove, replace
  • ticketResolutionTypeID : add, remove, replace
  • ticketStatusID : add, replace

Note

  • The ticket status provided in the patch operations must be associated to a resolved state
Authorizations:
SWT
path Parameters
ticketID
required
integer
Example: 1

ID of the Ticket to be resolved.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
cascade
boolean

Indicated whether or not to resolve all the non-closed child tickets associated to the ticket.

Array of objects (JSONPatchTicketResolve)

List of patch operation to apply to the ticket

Responses

Request samples

Content type
application/json
{
  • "cascade": true,
  • "ticketResolvePatch": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Update Ticket Status

Provides the ability to update the status of a ticket and optionally update the status of all its non-closed child tickets. [Rev 1.04]

Patchable Fields

The following is a list of properties of a ticket that can be patched.

  • ticketStatusID : add, replace, remove
Authorizations:
SWT
path Parameters
ticketID
required
integer
Example: 1

ID of the Ticket to be updated.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
cascade
boolean

Indicated whether or not to update the status of all the non-closed child tickets associated to the ticket.

Array of objects (JSONPatchTicketStatus)

List of patch operation to apply to the ticket

Responses

Request samples

Content type
application/json
{
  • "cascade": true,
  • "ticketStatusPatch": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Sales Entity Ticket

Search for tickets associated to a sales entity. [Rev 1.05]

Available Fields

The following is a list of fields from the pending reminder and how they can be used within the search.

  • Filterable : closeDate, customerID, customerName, salesCodeID, ticketImpactID, ticketPriorityID, ticketStatusID, ticketID, ticketTypeID, ticketUrgencyID, title
  • Sortable : closeDate, createDate, customerID, customerName, salesCode, salesCodeID, ticketID, ticketImpact, ticketImpactID, ticketPriority, ticketPriorityID, ticketStatus, ticketStatusID, ticketType, ticketTypeID, ticketUrgency, ticketUrgencyID, title
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Release Notes

Release Notes 2.09

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.08

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.07

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.06

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.05

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.04

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.03

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.02

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.01

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.00

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.08

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.07

  • Updated [#operation/salesEntityTicket](GET /api/ticket/salesEntityTicket) operation to include customerAcctNumber in response associated to sales entities.

Release Notes 1.05

  • Added [#operation/getJournal](GET /api/journal/{journalID}) operation to get a journal.
  • Added [#operation/createJournal](POST /api/journal) operation to create a journal.
  • Added [#operation/salesEntityTicket](GET /api/ticket/salesEntityTicket) operation to get tickets associated to sales entities.

Release Notes 1.04

  • Added [#operation/closeTicket](PATCH /api/ticket/{ticketID}/close) operation to close a ticket.
  • Added [#operation/resolveTicket](PATCH /api/ticket/{ticketID}/resolve) operation to resolve a ticket.
  • Added [#operation/updateTicketStatus](PATCH /api/ticket/{ticketID}/updateStatus) operation to update the status of a ticket.

Release Notes 1.01

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.00

  • Initial release of Journal Management API.