AMCS Group MaterialClass API
The MaterialClass API from AMCS Group — 3 operation(s) for materialclass.
OpenAPI Specification
openapi: 3.0.1
info:
title: Core AccessGroup MaterialClass API
version: core
tags:
- name: MaterialClass
paths:
/lists/materialClasses/changes:
get:
tags:
- MaterialClass
summary: Retrieve changes
description: "| Property| Description|\r\n| ----------------------------- | ------------------------------------------------------------------------- |\r\n| GUID| The GUID associated to the material class|\r\n| Description| The description of the material class|\r\n| AnalysisCode| The analysis code of the material class|\r\n| MaterialClassGroupListItem| The GUID and material class group of the material class (various values)|\r\n| IsDeleted| Whether the material class is deleted |\r\n"
operationId: MaterialClass_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[ApiIntegratorMaterialClassResource]'
/lists/materialClasses/{guid}:
get:
tags:
- MaterialClass
summary: Find with GUID
description: "| Property| Description|\r\n| ----------------------------- | ------------------------------------------------------------------------- |\r\n| GUID| The GUID associated to the material class|\r\n| Description| The description of the material class|\r\n| AnalysisCode| The analysis code of the material class|\r\n| MaterialClassGroupListItem| The GUID and material class group of the material class (various values)|\r\n| IsDeleted| Whether the material class is deleted |\r\n"
operationId: MaterialClass_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[ApiIntegratorMaterialClassResource]'
/lists/materialClasses:
get:
tags:
- MaterialClass
summary: Find with Filters
description: "| Property| Description|\r\n| ----------------------------- | ------------------------------------------------------------------------- |\r\n| GUID| The GUID associated to the material class|\r\n| Description| The description of the material class|\r\n| AnalysisCode| The analysis code of the material class|\r\n| MaterialClassGroupListItem| The GUID and material class group of the material class (various values)|\r\n| IsDeleted| Whether the material class is deleted |\r\n"
operationId: MaterialClass_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[ApiIntegratorMaterialClassResource]'
components:
schemas:
ApiIntegratorListItemResource:
type: object
properties:
Description:
type: string
Guid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
ApiResourceResultUpdatesExtra:
type: object
properties:
until:
type: string
cursor:
type: string
ApiResourceResultEntity[ApiIntegratorMaterialClassResource]:
type: object
properties:
resource:
$ref: '#/components/schemas/ApiIntegratorMaterialClassResource'
links:
$ref: '#/components/schemas/ApiResourceResultEntityLinks'
extra:
$ref: '#/components/schemas/ApiResourceResultEntityExtra'
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiResourceResultCollection[ApiIntegratorMaterialClassResource]:
type: object
properties:
resource:
type: array
items:
$ref: '#/components/schemas/ApiIntegratorMaterialClassResource'
extra:
$ref: '#/components/schemas/ApiResourceResultCollectionExtra'
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiResourceErrors:
type: object
properties:
errors:
type: string
ApiResourceChanges[ApiIntegratorMaterialClassResource]:
type: object
properties:
resource:
type: array
items:
$ref: '#/components/schemas/ApiIntegratorMaterialClassResource'
extra:
$ref: '#/components/schemas/ApiResourceResultUpdatesExtra'
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiResourceResultCollectionExtra:
type: object
properties:
count:
type: integer
format: int32
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
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
ApiIntegratorMaterialClassResource:
type: object
properties:
Description:
type: string
IsDeleted:
type: boolean
AnalysisCode:
type: string
MaterialClassGroupListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
GUID:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
ApiResourceStatus:
type: object
properties:
id:
type: integer
format: int32
isSuccess:
type: boolean