AMCS Group DefinitionAndProvider API
The DefinitionAndProvider API from AMCS Group — 5 operation(s) for definitionandprovider.
OpenAPI Specification
openapi: 3.0.1
info:
title: Core AccessGroup DefinitionAndProvider API
version: core
tags:
- name: DefinitionAndProvider
paths:
/services/api/workflow/definitionAndProviders/changes:
get:
tags:
- DefinitionAndProvider
parameters:
- name: since
in: query
schema:
type: string
- name: cursor
in: query
schema:
type: string
- name: links
in: query
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceChanges[ApiWorkflowDefinitionAndProviderResource]'
/services/api/workflow/definitionAndProviders/template:
get:
tags:
- DefinitionAndProvider
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceResult[ApiWorkflowDefinitionAndProviderResource]'
/services/api/workflow/definitionAndProviders/{id}:
get:
tags:
- DefinitionAndProvider
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: links
in: query
schema:
type: string
- name: include
in: query
schema:
type: string
- name: expand
in: query
schema:
type: string
- name: udf
in: query
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceResultEntity[ApiWorkflowDefinitionAndProviderResource]'
put:
tags:
- DefinitionAndProvider
parameters:
- name: id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
delete:
tags:
- DefinitionAndProvider
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResource'
/services/api/workflow/definitionAndProviders/{id}/blob/{blobMemberName}:
get:
tags:
- DefinitionAndProvider
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: blobMemberName
in: path
required: true
schema:
type: string
- name: fileName
in: query
schema:
type: string
- name: contentType
in: query
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: string
format: binary
/services/api/workflow/definitionAndProviders:
get:
tags:
- DefinitionAndProvider
parameters:
- name: filter
in: query
schema:
type: string
- name: search
in: query
schema:
type: string
- name: order
in: query
schema:
type: string
- name: max
in: query
schema:
type: string
- name: page
in: query
schema:
type: string
- name: includeCount
in: query
schema:
type: string
- name: includeDeleted
in: query
schema:
type: string
- name: links
in: query
schema:
type: string
- name: udf
in: query
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceResultCollection[ApiWorkflowDefinitionAndProviderResource]'
post:
tags:
- DefinitionAndProvider
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
components:
schemas:
ApiResourceResultUpdatesExtra:
type: object
properties:
until:
type: string
nullable: true
cursor:
type: string
nullable: true
additionalProperties: false
ApiResourceResultCollection[ApiWorkflowDefinitionAndProviderResource]:
type: object
properties:
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
resource:
type: array
items:
$ref: '#/components/schemas/AMCS.Core.Entity.Api.Workflow.ApiWorkflowDefinitionAndProvider'
nullable: true
extra:
$ref: '#/components/schemas/ApiResourceResultCollectionExtra'
additionalProperties: false
AMCS.Core.Entity.Api.Workflow.ApiWorkflowDefinitionAndProvider:
type: object
properties:
isValid:
type: boolean
readOnly: true
id:
type: integer
format: int32
nullable: true
readOnly: true
id32:
type: integer
format: int32
readOnly: true
guid:
type: string
format: uuid
nullable: true
lastChangeReasonId:
type: integer
format: int32
nullable: true
tempIdentifier:
type: string
nullable: true
workflowDefinitions:
type: array
items:
$ref: '#/components/schemas/AMCS.Core.Entity.Api.Workflow.ApiWorkflowDefinitionBrowser'
nullable: true
workflowProviders:
type: array
items:
$ref: '#/components/schemas/AMCS.Core.Entity.Api.Workflow.ApiWorkflowProviderBrowser'
nullable: true
additionalProperties: false
ApiResourceResultEntityLinks:
type: object
properties:
self:
type: string
nullable: true
associations:
type: array
items:
type: string
nullable: true
expand:
type: array
items:
type: string
nullable: true
operations:
type: array
items:
type: string
nullable: true
additionalProperties: false
ApiResourceId:
type: object
properties:
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
resource:
type: integer
format: int32
additionalProperties: false
AMCS.Core.Entity.Api.Workflow.ApiWorkflowDefinitionBrowser:
type: object
properties:
isValid:
type: boolean
readOnly: true
id:
type: integer
format: int32
nullable: true
readOnly: true
id32:
type: integer
format: int32
readOnly: true
guid:
type: string
format: uuid
nullable: true
lastChangeReasonId:
type: integer
format: int32
nullable: true
tempIdentifier:
type: string
nullable: true
workflowDefinitionId:
type: string
format: uuid
name:
type: string
nullable: true
description:
type: string
nullable: true
providerId:
type: integer
format: int32
nullable: true
providerName:
type: string
nullable: true
providerDescription:
type: string
nullable: true
scheduleJobId:
type: integer
format: int32
nullable: true
designerUrl:
type: string
nullable: true
additionalProperties: false
ApiResourceErrors:
type: object
properties:
errors:
type: string
nullable: true
additionalProperties: false
ApiResourceResultEntity[ApiWorkflowDefinitionAndProviderResource]:
type: object
properties:
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
resource:
$ref: '#/components/schemas/AMCS.Core.Entity.Api.Workflow.ApiWorkflowDefinitionAndProvider'
links:
$ref: '#/components/schemas/ApiResourceResultEntityLinks'
extra:
$ref: '#/components/schemas/ApiResourceResultEntityExtra'
additionalProperties: false
ApiResourceResultCollectionExtra:
type: object
properties:
count:
type: integer
format: int32
nullable: true
additionalProperties: false
ApiResource:
type: object
properties:
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
additionalProperties: false
ApiResourceResultEntityExtra:
type: object
properties:
expand:
type: object
additionalProperties:
type: object
additionalProperties: {}
nullable: true
nullable: true
include:
type: object
additionalProperties:
type: array
items:
type: object
additionalProperties: {}
nullable: true
nullable: true
additionalProperties: false
ApiResourceResult[ApiWorkflowDefinitionAndProviderResource]:
type: object
properties:
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
resource:
$ref: '#/components/schemas/AMCS.Core.Entity.Api.Workflow.ApiWorkflowDefinitionAndProvider'
additionalProperties: false
AMCS.Core.Entity.Api.Workflow.ApiWorkflowProviderBrowser:
type: object
properties:
isValid:
type: boolean
readOnly: true
id:
type: integer
format: int32
nullable: true
readOnly: true
id32:
type: integer
format: int32
readOnly: true
guid:
type: string
format: uuid
nullable: true
lastChangeReasonId:
type: integer
format: int32
nullable: true
tempIdentifier:
type: string
nullable: true
workflowProviderId:
type: integer
format: int32
nullable: true
name:
type: string
nullable: true
description:
type: string
nullable: true
additionalProperties: false
ApiResourceChanges[ApiWorkflowDefinitionAndProviderResource]:
type: object
properties:
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
resource:
type: array
items:
$ref: '#/components/schemas/AMCS.Core.Entity.Api.Workflow.ApiWorkflowDefinitionAndProvider'
nullable: true
extra:
$ref: '#/components/schemas/ApiResourceResultUpdatesExtra'
additionalProperties: false
ApiResourceStatus:
type: object
properties:
id:
type: integer
format: int32
nullable: true
isSuccess:
type: boolean
additionalProperties: false