Rules Timeline

Retrieve a list of Rules Engine timeline messages

Retrieve a list of Rules Engine timeline messages.

Request
Security:
path Parameters
eventType
required
string

The event type.

query Parameters
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

sort
Array of strings

The collection items sort field and order (prefix with "-" for descending sort).

q
string

The partial search of the text fields.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

A list of Rules Engine timeline messages was retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/events/{eventType}/timeline
Request samples
curl -i -X GET \
  'https://api-sandbox.rebilly.com/organizations/unknown/events/:eventType/timeline?limit=1000&offset=0&filter=string&sort=string&q=string' \
  -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Create Rules Engine Timeline comment

Create a Rules Engine Timeline comment.

Request
Security:
path Parameters
eventType
required
string

The event type.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json

Rules Engine Timeline resource.

message
string

The message that describes the message details.

Responses
201

Rules Engine Timeline comment was created.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

422

Invalid data was sent.

post/events/{eventType}/timeline
Request samples
application/json
{
  • "message": "string"
}
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "type": "timeline-comment-created",
  • "triggeredBy": "rebilly",
  • "message": "string",
  • "extraData": {
    },
  • "occurredTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}

Retrieve Rules Engine Timeline message

Retrieve a Rules Engine timeline message with specified identifier string.

Request
Security:
path Parameters
eventType
required
string

The event type.

messageId
required
string

The Rules Engine Timeline message ID.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

Rules Engine message was retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

get/events/{eventType}/timeline/{messageId}
Request samples
curl -i -X GET \
  https://api-sandbox.rebilly.com/organizations/unknown/events/:eventType/timeline/:messageId \
  -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "type": "timeline-comment-created",
  • "triggeredBy": "rebilly",
  • "message": "string",
  • "extraData": {
    },
  • "occurredTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}

Delete Rules Engine Timeline message

Delete Rules Engine Timeline message with predefined identifier string.

Request
Security:
path Parameters
eventType
required
string

The event type.

messageId
required
string

The Rules Engine Timeline message ID.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
204

Rules Engine Timeline message was deleted.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

409

Conflict.

delete/events/{eventType}/timeline/{messageId}
Request samples
curl -i -X DELETE \
  https://api-sandbox.rebilly.com/organizations/unknown/events/:eventType/timeline/:messageId \
  -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": 400,
  • "title": "string",
  • "detail": "string",
  • "error": "string"
}