AMCS Group OneOffAction API
The OneOffAction API from AMCS Group — 3 operation(s) for oneoffaction.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amcs-group:amcs-group-oneoffaction-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: AMCS Platform REST One Off Action API
description: '
# Overview
## Who Should Read this Document
This document contains a technical description of the AMCS Platform REST API. It is intended for:
· System integrators
· Customer IT team looking to integrate AMCS Platform with another system
· Third parties looking to integrate their system with AMCS Platform
## Document Scope
This document introduces the technical aspects of the AMCS Platform REST API. The purpose of this document is to provide readers with detail on how to:
· Access the REST API
· Make calls to the API to retrieve, append and update resources
· Retrieve the incremental changes to a collection
· Find more detail on the end points that are available from an environment. ## Summary
AMCS Platform REST API is designed to support the integration of AMCS Platform with other systems. With care and additional infrastructure, the REST API can be used to build functionality on top of Platform but that is not it’s primary purpose. The ‘changes since’ process provides the main means of performing an initial synchronisation of the AMCS Platform and another system, and then keeping them synchronised. Methods are also provided to create and update resources. # Integration Patterns and Tools
The AMCS Platform provides a number of tools that can be used to connect systems. Care should be taken to match the right tooling to the intended pattern of integration. · When an extract-based approach is needed, use BI reporting. · When derived values are require, use the data mart. · When business processes on different systems need to be integrated by synchronising the data on each through an event style interface, use the REST API. An integration using the REST API will need to take full responsibility for all aspects of the integration including:
· Pulling change events from AMCS Platform
· Filtering the changed resources for the ones that are of interest
· Pulling additional resources from the REST API in order the retrieve all the properties needed by the destination
· Mashing resources to create the complete view required
· Translating that into the form required by the destination
· Validating this to ensure it meet the entry rules of the destination
· Pushing the result to the destination
In the early stages of designing the interface care should be taken to ensure that the need for caching/staging has been considered. The changes since functionality is effectively a means of pulling create/change events from platform. The only filters available enable retrieval of related resources to build a view external to AMCS Platform
# Basics
The AMCS REST API provides a RESTful interface that allows access to the primary business resources of the AMCS platform. The interface follows general HATEOAS compliance principles. ## Quick start
A quickstart walkthrough based on node.js and covering authentication and getting a page of customers can be found here. ## Interface definitions
Swagger documentation for the end points available on an environment can be found at:
Before 8.5: https://{environment domain name}/swagger/ui/index
From 8.5: https://{environment domain name}/erp/api/swagger/ui/index
## HTTP Interface
The following HTTP RESTful methods are provided as part of this API:
· GET: Provides read access to retrieve details of one or more resources. · POST: Creates or updates a single resource or a set of resources. · PUT: Updates a single resource or a set of resources. Note:
· DELETE methods are currently not provided as part of the API. The REST API URIs begin with
https://{environment domain name}/erp/api/integrator/erp
For example:
https://prod.amcs-at-mycompany.com/erp/api/integrator/erp
This should be used as the base of the URI.'
version: latest
servers:
- url: https://ete-p5-tst-svc-core.amcsplatform.com/erp/api/integrator/erp
tags:
- name: OneOffAction
paths:
/transport/oneOffActions/changes:
get:
tags:
- OneOffAction
summary: Retrieve changes
description: '| Property| Description|
| ------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| GUID| The GUID associated to the one-off action.|
| RelatedOrderGuid| The GUID associated to the site order of the one-off action. Filterable.|
| RelatedPriceGuid| The GUID associated to the price of the one-off action.|
| RelatedPriceAdjustmentGuid| The GUID associated to the price adjustment of the one-off action. Filterable.|
| RelatedUserFinanciallyConfirmedByGuid| The GUID associated to the financially confirmed sysuser of the one-off action. Filterable.|
| RelatedJobGuid| The GUID associated to the job of the one-off action. Filterable.|
| RelatedRouteVisitGuid| The GUID associated to the route visit of the one-off action.Filterable.|
| RelatedPONumberGuid| The GUID associated to the PO number of the one-off action. Filterable.|
| RelatedServiceAgreementGuid| The GUID associated to the service agreement of the one-off action. Filterable.|
| RelatedWeighingInGuid| The GUID associated to the weighing in of the one-off action.Filterable.|
| RelatedWeighingOutGuid| The GUID associated to the weighing out of the one-off action. Filterable.|
| ContainerTypeListItem| The GUID and description of the container type associated to the one-off action.|
| MaterialListItem| The GUID and description of the material associated to the one-off action.|
| ReasonListItem| The GUID and description of the reason associated to the one-off action.|
| ServiceListItem| The GUID and description of the service associated to the one-off action.|
| ActionListItem| The GUID and description of the action associated to the one-off action.|
| DateCreated| The created date associated to the one-off action in ISO format (YYYY-MM-DD).|
| DateRequired| The required date associated to the one-off action in ISO format (YYYY-MM-DD).|
| IsDiscount| Is discount in the one-off action?|
| IsFinanciallyConfirmed| Is financially confirmed in the one-off action?|
| IsQuantityAdjustment| Is quantity adjustment in the one-off action?|
| IsRateAdjustment| Is rate adjustment in the one-off action?|
| IsWeightAdjustment| Is weight adjustment in the one-off action?|
| PriceOverride| Price override of the one-off action.|
| AdjustedRate| Adjusted rate of the one-off action.|
| AdjustedWeight| Adjusted weight of the one-off action.|
| CustomerOrderNo| Customer order no of the one-off action.|
| DateTo| The date to associated to the one-off action in ISO format (YYYY-MM-DD).|
| HoursChargable| Chargable hours of the one-off action.|
| Notes| Notes of the one-off action.|
| PONumber| PONumber of the one-off action.|
| Quantity| Quantity of the one-off action.|
| ReferenceNo| ReferenceNo of the one-off action. Filterable.|'
operationId: OneOffAction_GetChanges
parameters:
- name: since
in: query
schema:
type: string
- name: cursor
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceChanges_ApiIntegratorOneOffActionResource'
/transport/oneOffActions/{guid}:
get:
tags:
- OneOffAction
summary: Find with GUID
description: '| Property| Description|
| ------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| GUID| The GUID associated to the one-off action.|
| RelatedOrderGuid| The GUID associated to the site order of the one-off action. Filterable.|
| RelatedPriceGuid| The GUID associated to the price of the one-off action.|
| RelatedPriceAdjustmentGuid| The GUID associated to the price adjustment of the one-off action. Filterable.|
| RelatedUserFinanciallyConfirmedByGuid| The GUID associated to the financially confirmed sysuser of the one-off action. Filterable.|
| RelatedJobGuid| The GUID associated to the job of the one-off action. Filterable.|
| RelatedRouteVisitGuid| The GUID associated to the route visit of the one-off action.Filterable.|
| RelatedPONumberGuid| The GUID associated to the PO number of the one-off action. Filterable.|
| RelatedServiceAgreementGuid| The GUID associated to the service agreement of the one-off action. Filterable.|
| RelatedWeighingInGuid| The GUID associated to the weighing in of the one-off action.Filterable.|
| RelatedWeighingOutGuid| The GUID associated to the weighing out of the one-off action. Filterable.|
| ContainerTypeListItem| The GUID and description of the container type associated to the one-off action.|
| MaterialListItem| The GUID and description of the material associated to the one-off action.|
| ReasonListItem| The GUID and description of the reason associated to the one-off action.|
| ServiceListItem| The GUID and description of the service associated to the one-off action.|
| ActionListItem| The GUID and description of the action associated to the one-off action.|
| DateCreated| The created date associated to the one-off action in ISO format (YYYY-MM-DD).|
| DateRequired| The required date associated to the one-off action in ISO format (YYYY-MM-DD).|
| IsDiscount| Is discount in the one-off action?|
| IsFinanciallyConfirmed| Is financially confirmed in the one-off action?|
| IsQuantityAdjustment| Is quantity adjustment in the one-off action?|
| IsRateAdjustment| Is rate adjustment in the one-off action?|
| IsWeightAdjustment| Is weight adjustment in the one-off action?|
| PriceOverride| Price override of the one-off action.|
| AdjustedRate| Adjusted rate of the one-off action.|
| AdjustedWeight| Adjusted weight of the one-off action.|
| CustomerOrderNo| Customer order no of the one-off action.|
| DateTo| The date to associated to the one-off action in ISO format (YYYY-MM-DD).|
| HoursChargable| Chargable hours of the one-off action.|
| Notes| Notes of the one-off action.|
| PONumber| PONumber of the one-off action.|
| Quantity| Quantity of the one-off action.|
| ReferenceNo| ReferenceNo of the one-off action. Filterable.|'
operationId: OneOffAction_Get
parameters:
- name: guid
in: path
required: true
schema:
type: string
format: uuid
- name: udf
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceResultEntity_ApiIntegratorOneOffActionResource'
put:
tags:
- OneOffAction
summary: Partial update
description: '| Property| Description| Required |
| ------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -------- |
| GUID| The GUID associated to the one-off action.| No |
| RelatedOrderGuid| The GUID associated to the site order of the one-off action.| Yes |
| RelatedPriceGuid| The GUID associated to the price of the one-off action.| Yes |
| RelatedPriceAdjustmentGuid| The GUID associated to the price adjustment of the one-off action.| No |
| RelatedUserFinanciallyConfirmedByGuid| The GUID associated to the financially confirmed sysuser of the one-off action.| No |
| RelatedJobGuid| The GUID associated to the job of the one-off action.| No |
| RelatedRouteVisitGuid| The GUID associated to the route visit of the one-off action.| No |
| RelatedPONumberGuid| The GUID associated to the PO number of the one-off action.| No |
| RelatedServiceAgreementGuid| The GUID associated to the service agreement of the one-off action.| No |
| RelatedWeighingInGuid| The GUID associated to the weighing in of the one-off action.| No |
| RelatedWeighingOutGuid| The GUID associated to the weighing out of the one-off action.| No |
| ContainerTypeListItem| The GUID and description of the container type associated to the one-off action.| No |
| MaterialListItem| The GUID and description of the material associated to the one-off action.| No |
| ReasonListItem| The GUID and description of the reason associated to the one-off action.| No |
| ServiceListItem| The GUID and description of the service associated to the one-off action.| No |
| ActionListItem| The GUID and description of the action associated to the one-off action.| Yes |
| DateCreated| The created date associated to the one-off action in ISO format (YYYY-MM-DD).| Yes |
| DateRequired| The required date associated to the one-off action in ISO format (YYYY-MM-DD).| Yes |
| IsDiscount| Is discount in the one-off action?| Yes |
| IsFinanciallyConfirmed| Is financially confirmed in the one-off action?| Yes |
| IsQuantityAdjustment| Is quantity adjustment in the one-off action?| Yes |
| IsRateAdjustment| Is rate adjustment in the one-off action?| Yes |
| IsWeightAdjustment| Is weight adjustment in the one-off action?| Yes |
| PriceOverride| Price override of the one-off action.| No |
| AdjustedRate| Adjusted rate of the one-off action.| No |
| AdjustedWeight| Adjusted weight of the one-off action.| No |
| CustomerOrderNo| Customer order no of the one-off action.| No |
| DateTo| The date to associated to the one-off action in ISO format (YYYY-MM-DD).| No |
| HoursChargable| Chargable hours of the one-off action.| No |
| Notes| Notes of the one-off action.| No |
| PONumber| PONumber of the one-off action.| No |
| Quantity| Quantity of the one-off action.| No |
| ReferenceNo| ReferenceNo of the one-off action.| No |
**Extra validations**
| Condition | Error message |
| --------- | ------------- |
| When an existing one-off action IsFinancialyConfirmed is true | Attempted to update a financially confirmed one-off action. Could not update the one-off action. |
| If RelatedOrderGuid is being edited | RelatedOrderGuid is a read-only property. |
| If the provided RelatedPriceGuid is not in site order price with the provide ActionListItem.Guid. | OneOffAction has the property RelatedPriceGuid with value of guid that is not supported. The given RelatedPriceGuid is not found in siteorder price with ActionListItem.Guid - guid. |
| If RelatedPriceGuid is being edited | RelatedPriceGuid is a read-only property. |
| If RelatedPriceAdjustmentGuid is being edited | RelatedPriceAdjustmentGuid is a read-only property. |
| If RelatedUserFinanciallyConfirmedByGuid is being edited | RelatedUserFinanciallyConfirmedByGuid is a read-only property. |
| If RelatedJobGuid is being edited | RelatedJobGuid is a read-only property. |
| If RelatedRouteVisitGuid is being edited | RelatedRouteVisitGuid is a read-only property.'
operationId: OneOffAction_Update
parameters:
- name: guid
in: path
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiIntegratorOneOffActionResource'
required: true
x-bodyName: null
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
/transport/oneOffActions:
get:
tags:
- OneOffAction
summary: Find with Filters
description: '| Property| Description|
| ------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| GUID| The GUID associated to the one-off action.|
| RelatedOrderGuid| The GUID associated to the site order of the one-off action. Filterable.|
| RelatedPriceGuid| The GUID associated to the price of the one-off action.|
| RelatedPriceAdjustmentGuid| The GUID associated to the price adjustment of the one-off action. Filterable.|
| RelatedUserFinanciallyConfirmedByGuid| The GUID associated to the financially confirmed sysuser of the one-off action. Filterable.|
| RelatedJobGuid| The GUID associated to the job of the one-off action. Filterable.|
| RelatedRouteVisitGuid| The GUID associated to the route visit of the one-off action.Filterable.|
| RelatedPONumberGuid| The GUID associated to the PO number of the one-off action. Filterable.|
| RelatedServiceAgreementGuid| The GUID associated to the service agreement of the one-off action. Filterable.|
| RelatedWeighingInGuid| The GUID associated to the weighing in of the one-off action.Filterable.|
| RelatedWeighingOutGuid| The GUID associated to the weighing out of the one-off action. Filterable.|
| ContainerTypeListItem| The GUID and description of the container type associated to the one-off action.|
| MaterialListItem| The GUID and description of the material associated to the one-off action.|
| ReasonListItem| The GUID and description of the reason associated to the one-off action.|
| ServiceListItem| The GUID and description of the service associated to the one-off action.|
| ActionListItem| The GUID and description of the action associated to the one-off action.|
| DateCreated| The created date associated to the one-off action in ISO format (YYYY-MM-DD).|
| DateRequired| The required date associated to the one-off action in ISO format (YYYY-MM-DD).|
| IsDiscount| Is discount in the one-off action?|
| IsFinanciallyConfirmed| Is financially confirmed in the one-off action?|
| IsQuantityAdjustment| Is quantity adjustment in the one-off action?|
| IsRateAdjustment| Is rate adjustment in the one-off action?|
| IsWeightAdjustment| Is weight adjustment in the one-off action?|
| PriceOverride| Price override of the one-off action.|
| AdjustedRate| Adjusted rate of the one-off action.|
| AdjustedWeight| Adjusted weight of the one-off action.|
| CustomerOrderNo| Customer order no of the one-off action.|
| DateTo| The date to associated to the one-off action in ISO format (YYYY-MM-DD).|
| HoursChargable| Chargable hours of the one-off action.|
| Notes| Notes of the one-off action.|
| PONumber| PONumber of the one-off action.|
| Quantity| Quantity of the one-off action.|
| ReferenceNo| ReferenceNo of the one-off action. Filterable.|'
operationId: OneOffAction_GetCollection
parameters:
- name: filter
in: query
schema:
type: string
- name: max
in: query
schema:
type: integer
format: int32
- name: page
in: query
schema:
type: integer
format: int32
- name: includeCount
in: query
schema:
type: boolean
- name: udf
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceResultCollection_ApiIntegratorOneOffActionResource'
post:
tags:
- OneOffAction
summary: Create or update
description: '| Property| Description| Required |
| ------------------------------------------------- | --------------------------------------------------------------------------------------------------| -------- |
| GUID| The GUID associated to the one-off action.| No |
| RelatedOrderGuid| The GUID associated to the site order of the one-off action.| Yes |
| RelatedPriceGuid| The GUID associated to the price of the one-off action.| Yes |
| RelatedPriceAdjustmentGuid| The GUID associated to the price adjustment of the one-off action.| No |
| RelatedUserFinanciallyConfirmedByGuid| The GUID associated to the financially confirmed sysuser of the one-off action.| No |
| RelatedJobGuid| The GUID associated to the job of the one-off action.| No |
| RelatedRouteVisitGuid| The GUID associated to the route visit of the one-off action.| No |
| RelatedPONumberGuid| The GUID associated to the PO number of the one-off action.| No |
| RelatedServiceAgreementGuid| The GUID associated to the service agreement of the one-off action.| No |
| RelatedWeighingInGuid| The GUID associated to the weighing in of the one-off action.| No |
| RelatedWeighingOutGuid| The GUID associated to the weighing out of the one-off action.| No |
| ContainerTypeListItem| The GUID and description of the container type associated to the one-off action.| No |
| MaterialListItem| The GUID and description of the material associated to the one-off action.| No |
| ReasonListItem| The GUID and description of the reason associated to the one-off action.| No |
| ServiceListItem| The GUID and description of the service associated to the one-off action.| No |
| ActionListItem| The GUID and description of the action associated to the one-off action.| Yes |
| DateCreated| The created date associated to the one-off action in ISO format (YYYY-MM-DD).| No |
| DateRequired| The required date associated to the one-off action in ISO format (YYYY-MM-DD).| Yes |
| IsDiscount| Is discount in the one-off action?| Yes |
| IsFinanciallyConfirmed| Is financially confirmed in the one-off action?| Yes |
| IsQuantityAdjustment| Is quantity adjustment in the one-off action?| Yes |
| IsRateAdjustment| Is rate adjustment in the one-off action?| Yes |
| IsWeightAdjustment| Is weight adjustment in the one-off action?| Yes |
| PriceOverride| Price override of the one-off action.| No |
| AdjustedRate| Adjusted rate of the one-off action.| No |
| AdjustedWeight| Adjusted weight of the one-off action.| No |
| CustomerOrderNo| Customer order no of the one-off action.| No |
| DateTo| The date to associated to the one-off action in ISO format (YYYY-MM-DD).| No |
| HoursChargable| Chargable hours of the one-off action.| No |
| Notes| Notes of the one-off action.| No |
| PONumber| PONumber of the one-off action.| No |
| Quantity| Quantity of the one-off action.| No |
| ReferenceNo| ReferenceNo of the one-off action.| No |
**Extra validations**
| Condition | Error message |
| --------- | ------------- |
| If ReasonListItem is not in one of the following reason categories: One Off Charge. | ReasonListItem must be in one of the following reason categories: One Off Charge. |
| If the provided RelatedPriceGuid is not in site order price with the provide ActionListItem.Guid. | OneOffAction has the property RelatedPriceGuid with value of guid that is not supported. The given RelatedPriceGuid is not found in siteorder price with ActionListItem.Guid - guid. |
| If the action in the ActionListItem is not linked to Activity Type OneOffCharge | The given ActionListItem.Guid is not supported by OneOffAction. |
| If we provide value to DateCreated(As DateCreated would be auto populated with todays date). | DateCreated is not supported. |
| If RelatedOrderGuid provided is Deleted. | The provided RelatedOrderGuid is deleted. Could not update the resource. Please check the relevant list end point for the available options. |
| If RelatedPriceGuid provided is Deleted. | The provided RelatedPriceGuid is deleted.'
operationId: OneOffAction_Create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiIntegratorOneOffActionResource'
required: true
x-bodyName: null
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
components:
schemas:
ApiIntegratorOneOffActionResource:
type: object
properties:
RelatedOrderGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
RelatedPriceGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
RelatedPriceAdjustmentGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
RelatedUserFinanciallyConfirmedByGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
RelatedJobGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
RelatedRouteVisitGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
RelatedPONumberGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
RelatedServiceAgreementGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
RelatedWeighingInGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
RelatedWeighingOutGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
ContainerTypeListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
MaterialListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
ReasonListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
ServiceListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
ActionListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
DateCreated:
type: string
format: localDate
example: '2000-01-01'
DateRequired:
type: string
format: localDate
example: '2000-01-01'
IsDiscount:
type: boolean
IsFinanciallyConfirmed:
type: boolean
IsQuantityAdjustment:
type: boolean
IsRateAdjustment:
type: boolean
IsWeightAdjustment:
type: boolean
PriceOverride:
type: number
format: double
AdjustedRate:
type: number
format: double
AdjustedWeight:
type: number
format: double
CustomerOrderNo:
type: string
DateTo:
type: string
format: localDate
example: '2000-01-01'
HoursChargable:
type: number
format: double
Notes:
type: string
PONumber:
type: string
Quantity:
type: integer
format: int32
ReferenceNo:
type: string
GUID:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
ApiResourceResultCollectionExtra:
type: object
properties:
count:
type: integer
format: int32
ApiResourceResultEntityLinks:
type: object
properties:
self:
type: string
associations:
type: array
items:
type: string
expand:
type: array
items:
type: string
operations:
type: array
items:
type: string
ApiResourceResultEntity_ApiIntegratorOneOffActionResource:
type: object
properties:
resource:
$ref: '#/components/schemas/ApiIntegratorOneOffActionResource'
links:
$ref: '#/components/schemas/ApiResourceResultEntityLinks'
extra:
$ref: '#/components/schemas/ApiResourceResultEntityExtra'
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiResourceResultEntityExtra:
type: object
properties:
expand:
type: object
additionalProperties:
type: object
additionalProperties:
type: object
include:
type: object
additionalProperties:
type: array
items:
type: object
additionalProperties:
type: object
ApiResourceChanges_ApiIntegratorOneOffActionResource:
type: object
properties:
resource:
type: array
items:
$ref: '#/components/schemas/ApiIntegratorOneOffActionResource'
extra:
$ref: '#/components/schemas/ApiResourceResultUpdatesExtra'
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiResourceResultUpdatesExtra:
type: object
properties:
until:
type: string
cursor:
type: string
ApiResourceId:
type: object
properties:
resource:
type: string
format: uuid
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiIntegratorListItemResource:
type: object
properties:
Description:
type: string
Guid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
ApiResourceStatus:
type: object
properties:
id:
type: integer
format: int32
isSuccess:
type: boolean
ApiResourceResultCollection_ApiIntegratorOneOffActionResource:
type: object
properties:
resource:
type: array
items:
$ref: '#/components/schemas/ApiIntegratorOneOffActionResource'
extra:
$ref: '#/components/schemas/ApiResourceResultCollectionExtra'
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiResourceErrors:
type: object
properties:
errors:
type: string