Abstract Approval Processes

Operations

Creates a new abstract approval process record that does not already exist.

Request

This method will auto-generate an ID and create a new abstract approval process. If an ID is specified for the abstract approval process, an error will be thrown.

Security

knox-authorizer

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The abstract approval process that you would like to be saved.

acceptance_notification_emailobject(Acceptance Notification Email)required

The email to send when the abstract is received

approval_form_idstring(Approval Form)required

Form shown to the presenter when they approve

approval_notification_emailobject(Approval Notification Email)required

The email to send when the abstract is received

decline_notification_emailobject(Decline Notification Email)required

The email to send when the abstract is received

enable_acceptance_notification_emailboolean(Enable Acceptance Notification Email)

Whether or not an email should be sent when the abstract is accepted by the presenter

enable_approval_notification_emailboolean(Enable Approval Notification Email)

Whether or not an email should be sent when the abstract is approved

enable_decline_notification_emailboolean(Enable Decline Notification Email)

Whether or not an email should be sent when the abstract is declined

enable_presenter_decline_emailboolean(Enable Presenter Decline Email)

Whether or not an email should be sent when the abstract is approved but declined by the presenter

event_idstring(Event)required

ID for the event associated with this process

idstring(ID)^[\w-_:]+$required

The unique, string identifier of this abstract approval process

is_activeboolean(Is Active)

Whether or not this abstract approval process is active

namestring(Name)required

The name of the abstract approval process

presenter_decline_emailobject(Presenter Decline Email)required

The email to send when the abstract is received

presenter_decline_form_idstring(Presenter Decline Form)

Form shown to those who decline. If not selected, the accept form is used

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber, (float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring, (date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring, (date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber, (float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber, (float)(Sys Version)

A number representing the version of this record in the database

visible_in_portalboolean(Visible In Portal)

Should we show this process in the portal

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/events/events-v1/abstractApprovalProcesses/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "acceptance_notification_email": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "approval_form_id": "string",
    "approval_notification_email": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "decline_notification_email": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "enable_acceptance_notification_email": true,
    "enable_approval_notification_email": true,
    "enable_decline_notification_email": true,
    "enable_presenter_decline_email": true,
    "event_id": "string",
    "id": "string",
    "is_active": true,
    "name": "string",
    "presenter_decline_email": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "presenter_decline_form_id": "string",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "visible_in_portal": true
  }'

Responses

The abstract approval process was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json