AMCS Group Material API
The Material API from AMCS Group — 2 operation(s) for material.
OpenAPI Specification
openapi: 3.0.1
info:
title: Core AccessGroup Material API
version: core
tags:
- name: Material
paths:
/lists/materials/{guid}:
get:
tags:
- Material
summary: Find with GUID
description: "| Property | Description |\r\n| ------------------------- | ------------------------------------------------------------------------ |\r\n| GUID | The GUID associated to the material |\r\n| Description | The description of the material |\r\n| Color| The color of the material |\r\n| AnalysisCode | The analysis code of the material |\r\n| ShortName | The short name of the material |\r\n| MaterialStateListItem | The The GUID and material state of the material (various values) |\r\n| MaterialClassListItem | The The GUID and material class of the material (various values) |\r\n| EWCCodeListItem| The GUID and EWC Code of the material (various values) |\r\n| IsDeleted | Whether the material is deleted |\r\n"
operationId: Material_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[ApiIntegratorMaterialResource]'
/lists/materials:
get:
tags:
- Material
summary: Find with Filters
description: "| Property | Description |\r\n| ------------------------- | ------------------------------------------------------------------------ |\r\n| GUID | The GUID associated to the material |\r\n| Description | The description of the material |\r\n| Color| The color of the material |\r\n| AnalysisCode | The analysis code of the material |\r\n| ShortName | The short name of the material |\r\n| MaterialStateListItem | The The GUID and material state of the material (various values) |\r\n| MaterialClassListItem | The The GUID and material class of the material (various values) |\r\n| EWCCodeListItem| The GUID and EWC Code of the material (various values) |\r\n| IsDeleted | Whether the material is deleted |\r\n"
operationId: Material_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[ApiIntegratorMaterialResource]'
components:
schemas:
ApiIntegratorListItemResource:
type: object
properties:
Description:
type: string
Guid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
ApiResourceResultCollection[ApiIntegratorMaterialResource]:
type: object
properties:
resource:
type: array
items:
$ref: '#/components/schemas/ApiIntegratorMaterialResource'
extra:
$ref: '#/components/schemas/ApiResourceResultCollectionExtra'
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiResourceErrors:
type: object
properties:
errors:
type: string
ApiResourceResultCollectionExtra:
type: object
properties:
count:
type: integer
format: int32
ApiIntegratorMaterialResource:
type: object
properties:
Description:
type: string
IsDeleted:
type: boolean
Color:
type: string
AnalysisCode:
type: string
ShortName:
type: string
MaterialStateListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
MaterialClassListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
EWCCodeListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
GUID:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
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
ApiResourceResultEntity[ApiIntegratorMaterialResource]:
type: object
properties:
resource:
$ref: '#/components/schemas/ApiIntegratorMaterialResource'
links:
$ref: '#/components/schemas/ApiResourceResultEntityLinks'
extra:
$ref: '#/components/schemas/ApiResourceResultEntityExtra'
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiResourceStatus:
type: object
properties:
id:
type: integer
format: int32
isSuccess:
type: boolean