How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Fenergo Journey Instance API

The JourneyInstance API from Fenergo — 25 operation(s) for journeyinstance.

Fenergo Journey Instance API is one of 281 APIs that Fenergo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include JourneyInstance. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 27 operations across 25 paths, and defines 103 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: /journeycommand, /journeyquery.

27 operations 25 paths 103 schemas 6 GET4 POST17 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.fenergox.com/advanceddashboardcommand
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Fenergo Journey Instance API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Bearer). By default, every request must be authenticated.

  • Bearer — Please insert JWT with Bearer into field

Paths & Operations 27

Across 25 paths, the API surfaces 27 operations — 6 GET, 4 POST, 17 PUT. Each is listed below with its method, path, parameters, and response codes.

JourneyInstance 27
POST
/api/journey-instance
Create journey instance
CreateJourney 2 params body → 202404400401403500410
PUT
/api/journey-instance/{journeyInstanceId}/abort
Cancel journey instance
AbortJourneyInstance 3 params body → 202404400401403500410
PUT
/api/journey-instance/batch/abort
Batch cancel journey instances
BatchAbortJourneyInstances 2 params body → 202404400401403500410
PUT
/api/journey-instance/{journeyInstanceId}/task/complete
Complete journey instance task
CompleteTask 4 params → 202404400401403500410
PUT
/api/journey-instance/{journeyInstanceId}/task/{taskId}/reviewOutcome
Save review outcome
SaveReviewOutcome 4 params body → 202404400401403500410
PUT
/api/journey-instance/{journeyInstanceId}/task/{taskId}/reassign
Reassign task
ReassignTask 4 params body → 202404400401403500410
PUT
/api/journey-instance/bulk-reassign
Bulk reassign task
ReassignTaskBulk 2 params body → 202400401403500410
PUT
/api/journey-instance/{journeyInstanceId}/task/{taskId}/reset
Reset task
ResetTask 4 params body → 202404400401403500410
PUT
/api/journey-instance/{journeyInstanceId}/task/{taskId}/pause
Pause journey instance task
PauseTask 4 params body → 202404400401403500410
PUT
/api/journey-instance/{journeyInstanceId}/task/{taskId}/unpause
Unpause journey instance task
UnpauseTask 4 params → 202404400401403500410
PUT
/api/journey-instance/{journeyInstanceId}/stage/{stageId}/pause
Pause journey instance stage
PauseStage 4 params body → 202404400401403500410
PUT
/api/journey-instance/{journeyInstanceId}/stage/{stageId}/unpause
Unpause journey instance stage
UnpauseStage 4 params → 202404400401403500410
PUT
/api/journey-instance/{journeyInstanceId}/pause
Pause journey instance
PauseInstance 3 params body → 202404400401403500410
PUT
/api/journey-instance/{journeyInstanceId}/unpause
Unpause journey instance
UnpauseInstance 3 params → 202404400401403500410
PUT
/api/journey-instance/{id}/access-layers
Update journey instance access layers
UpdateJourneyAccessLayers 3 params body → 202409404400401403500410
PUT
/api/journey-instance/{journeyInstanceId}/task/{taskId}/reassign-read-only-teams
Reassign task read only teams
ReassignTaskReadOnlyTeams 4 params body → 202404400401403500410
PUT
/api/journey-instance/{journeyInstanceId}/reassign-journey-owner
Reassign journey owner
ReassignJourneyOwner 3 params body → 202404400401403500410
PUT
/api/journey-instance/{journeyInstanceId}/custom-status
Update journey instance custom status
CustomStatusUpdate 3 params body → 202404400401403500410
POST
/api/journey-instance/launch-journey
Launch journey business process
LaunchJourney 2 params body → 202400401403500410
GET
/api/journey-instance/{journeyInstanceId}
Get journey instance by id
GetJourneyInstanceById 3 params → 200404304400401403500410
GET
/api/journey-instance/{journeyInstanceId}/task/{taskId}
Get journey instance task by id
GetTaskById 3 params → 200404400401403500410
GET
/api/journey-instance/searchdeprecated
Get journey instances by entity id
GetInstancesByEntityId 2 params → 200400401403500410
POST
/api/journey-instance/search
Get a page of journey instances by entity id
GetInstancesByEntityIdV2 1 param body → 200400401403500410
GET
/api/journey-instance/{journeyInstanceId}/linked-journeys
Get linked journeys by main journey id
GetLinkedJourneysById 4 params → 200400401403500410
POST
/api/journey-instance/{journeyInstanceId}/linked-journeys
Get linked journeys by main journey id
GetLinkedJourneysByIdV2 2 params body → 200400401403500410
GET
/api/journey-instance/lifecycle-status/entity/{entityId}
Get lifecycle status of all journey instances by entity id
GetLifecycleStatusByEntityId 2 params → 200400401403500410
GET
/api/journey-instance/launch-journey/{businessProcessId}
Get launch journey business process
GetLaunchJourneyBusinessProcess 2 params → 200404400401403500410

Schemas 103

The contract defines 103 schemas that model the data the API accepts and returns. The most detailed are JourneyTaskDto (60 properties), JourneyInstanceDto (42 properties), EntityJourneyInstanceViewModelDto (26 properties), JourneyInstanceStageDto (25 properties). Each schema is shown below with its type and property counts.

ReviewOutcomeDtoServiceRequest
object
Service request data
1 property
ServiceResponseMessage
object
The message associated to the service response
3 properties
ReassignTaskDto
object
DTO representing reassign task
4 properties 1 required
UpdateJourneyInstanceAccessLayersDto
object
Request DTO representing the journey instance access layers data
2 properties 1 required
JourneyLaunchedDtoServiceResponse
object
Service response data
2 properties
ReopenTaskCommandResponseServiceResponse
object
Service response data
2 properties
ReviewOutcomeDto
object
Request DTO representing review outcome task data to save
2 properties 1 required
PauseJourneyInstanceDto
object
2 properties 1 required
StringServiceResponse
object
Service response data
2 properties
CreateJourneyInstanceDto
object
Request DTO representing journey instance to create
5 properties 1 required
LaunchJourneyDto
object
Response DTO representing launch journey instance(s)
4 properties
ReopenTaskCommandResponse
object
1 property
TaskReassignOutcomeDtoListServiceResponse
object
Service response data
2 properties
ObjectServiceResponse
object
Service response data
2 properties
ReassignMultipleTasksDto
object
DTO representing reassign tasks in bulk
1 property 1 required
AbortMultipleJourneysDto
object
DTO representing aborting journeys in bulk
3 properties 1 required
PauseJourneyInstanceStageDtoServiceRequest
object
Service request data
1 property
ReassignJourneyOwnerDtoServiceRequest
object
Service request data
1 property
PauseJourneyInstanceTaskDtoServiceRequest
object
Service request data
1 property
ReassignTaskInBulkDto
object
DTO representing an request of a task reassignment process
6 properties 2 required
AbortJourneyDto
object
DTO to abort journey
2 properties
ReassignReadOnlyTeamsDto
object
DTO representing reassign read only teams
1 property
LaunchJourneyDtoServiceRequest
object
Service request data
1 property
ResetTaskDtoServiceRequest
object
Service request data
1 property
AbortMultipleJourneysDtoServiceRequest
object
Service request data
1 property
PauseJourneyInstanceTaskDto
object
2 properties 1 required
ReopenedTaskDto
object
3 properties
ReassignReadOnlyTeamsDtoServiceRequest
object
Service request data
1 property
JourneyInstanceCreatedDto
object
Response DTO representing created journey instance
4 properties
PauseJourneyInstanceDtoServiceRequest
object
Service request data
1 property
ReassignMultipleTasksDtoServiceRequest
object
Service request data
1 property
CreateJourneyInstanceDtoServiceRequest
object
Service request data
1 property
CustomStatusUpdateDtoServiceRequest
object
Service request data
1 property
ValidationErrorModel
object
Represents the details of validation error
4 properties
ReassignTaskDtoServiceRequest
object
Service request data
1 property
AbortJourneyDtoServiceRequest
object
Service request data
1 property
ValidationErrorModelListServiceResponse
object
Service response data
2 properties
PauseJourneyInstanceStageDto
object
2 properties 1 required
ResetTaskDto
object
DTO representing reset task
2 properties
JourneyInstanceCreatedDtoServiceResponse
object
Service response data
2 properties
UpdateJourneyInstanceAccessLayersDtoServiceRequest
object
Service request data
1 property
TaskReassignOutcomeDto
object
DTO representing an outcome of a task reassignment process
4 properties
CustomStatusUpdateDto
object
Request DTO representing journey custom status update data
1 property
JourneyJurisdictionDto
object
Request DTO representing jurisdiction journey should operate on
1 property
ReassignJourneyOwnerDto
object
DTO representing reassign journey owner
3 properties
AccessLayerDto
object
DTO representing access layers attached
2 properties
JourneyLaunchedDto
object
DTO representing launched journey business process
1 property
LinkedJourneysRequestDto
object
4 properties
EntityJourneyInstanceViewModelDto
object
Response DTO representing journey instance data for a specific entity, without Stages object
26 properties
EntityJourneyInstanceViewModelDtoIEnumerableServiceResponse
object
Service response data
2 properties
EntityJourneyInstanceSearchResponseDto
object
3 properties
JourneyInstanceServiceLevelAgreementDto
object
Response DTO representing Service Level Agreement of a Journey/Stage/Task, omits Conditions property.
9 properties
PageOptions
object
Options for setting up the results page
3 properties
JourneyInstanceLightDtoIEnumerableServiceResponse
object
Service response data
2 properties
JourneyInstanceDto
object
Response DTO representing all journey instance data
42 properties
EntityJourneyInstanceSearchResponseDtoServiceResponse
object
Service response data
2 properties
UserTaskPermissionsDto
object
The current user's permissions for a single task within a journey instance. Entries are only emitted for tasks where at least one permission is denied.
1 property
TeamAssignmentDtoConditionalValueDto
object
7 properties
LinkedJourneyDto
object
11 properties
PermissionDto
object
A single permission outcome for the current user, plus a human-readable reason that the UI surfaces as a tooltip when the action is not permitted.
2 properties
Condition
object
5 properties
ConditionDto
object
Represents condition root
5 properties
ConditionalValueDto
object
8 properties
EntityJourneyInstanceSearchRequestDto
object
2 properties
JourneyInstanceMilestoneDto
object
DTO representing Journey Milestone
6 properties
LifecycleStatusSummaryFactor
object
Single Journey Type overview
2 properties
ServiceLevelAgreementDto
object
Response DTO representing Service Level Agreement of a Journey/Stage/Task
10 properties
JourneyInstanceDtoServiceResponse
object
Service response data
2 properties
LaunchJourneyBusinessProcessPayloadDto
object
Response DTO representing journey launch business process payload
2 properties
ConditionDefinition
object
10 properties
LifecycleStatusSummary
object
Value object representing summary of journey instances for given entity grouped by journey type
2 properties
LifecycleStatus
string
Lifecycle status enumeration
LaunchJourneyBusinessProcessDto
object
Response DTO representing journey launch business process
6 properties
LinkedJourneysRequestDtoServiceRequest
object
Service request data
1 property
ValueField
object
2 properties
ServiceLevelAgreementLightDto
object
Request DTO representing Service Level Agreement of a Journey/Stage/Task
2 properties
JourneyOwnerDto
object
3 properties
JourneyInstanceStageDto
object
Journey Instance Stage metadata
25 properties
JourneyTaskDtoServiceResponse
object
Service response data
2 properties
EntityJourneyInstanceSearchRequestDtoServiceRequest
object
Service request data
1 property
ChannelTypeDto
string
JourneyInstanceLightDto
object
Response DTO representing journey instance data without Stages object
24 properties
ServiceLevelAgreementLightDtoConditionalValueDto
object
7 properties
JourneyInstanceProcessDto
object
Journey Instance Process metadata
15 properties
LinkedJourneysResponseDtoServiceResponse
object
Service response data
2 properties
TeamAssignmentDto
object
DTO representing task's team assignment metadata
2 properties
LaunchJourneyBusinessProcessDtoServiceResponse
object
Service response data
2 properties
LifecycleSummaryFactorStatus
string
The summary status of journey instances of given type
LinkedJourneysResponseDto
object
4 properties
ConditionDefinitionDto
object
Represents condition
9 properties
SortOrder
integer
Sort Order (Ascending or Descending)
JourneyStatsDto
object
Represents the progress of journey instance or stage
3 properties
LaunchJourneyBusinessProcessItemDto
object
Response DTO representing journey launch business process item
7 properties
JourneyLifecycleStatus
object
Single Journey Instance overview
4 properties
JourneyMetadataDto
object
DTO representing journey metadata
2 properties
ApplicationTypeDto
string
The types of application
OriginSource
string
RestrictedJourneyInstanceDto
object
A journey instance the caller's access profile does not permit. Intentionally minimal — exposes only the id, with no other fields, since the caller isn't autho…
1 property
LifecycleStatusSummaryServiceResponse
object
Service response data
2 properties
JourneyTaskDto
object
Journey Task metadata
60 properties 1 required
BusinessProcessMessageDto
object
Response DTO representing business process message
2 properties
AccessLayerDto_2
object
Response DTO representing associated access layers
2 properties
TaskMessageDto
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

fenergo-journeyinstance-api-openapi.yml Raw ↑

Other APIs Fenergo publishes across the network.

Fenergo Acceptable Document API
Fenergo Access Layer API
Fenergo Adapter Mock API
Fenergo Advanced Dashboard API
Fenergo Agency API
Fenergo Agent API
Fenergo Agent Slos API
Fenergo Agent Value Story API
Fenergo Aggregation API
Fenergo Allocation API
Fenergo Allocation Configuration API
Fenergo Asset API
Where this information came from

This is an independent, third-party profile of Fenergo Journey Instance API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.