AMCS Group JobMaterials API

openapi: 3.0.1
info:
  title: Core AccessGroup JobMaterials API
  version: core
tags:
- name: JobMaterials
paths:
  /integrator/jobMaterials/{id}:
    get:
      tags:
      - JobMaterials
      summary: Find with GUID
      description: "| Property\t\t\t\t\t\t\t\t\t\t\t\t| Description                                                                       |\r\n|-------------------------------------------------------|-----------------------------------------------------------------------------------|\r\n| JobGUID\t\t\t\t\t\t\t\t\t\t\t\t| The Job GUID. Filterable.\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t|\r\n| LinkedMaterials[]\t\t\t\t\t\t\t\t\t\t| The linked materials for the job.\t\t\t\t\t\t\t\t\t\t\t\t\t|\r\n| LinkedMaterials[].MaterialGUID\t\t\t\t\t\t| The Material Guid\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t|\r\n| LinkedMaterials[].Material\t\t\t\t\t\t\t| The Material Description.\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t|\r\n| LinkedMaterials[].ShortCode\t\t\t\t\t\t\t| The Material ShortCode.\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t|\r\n| LinkedMaterials[].AnalysisCode\t\t\t\t\t\t| The Material AnalysisCode.\t\t\t\t\t\t\t\t\t\t\t\t\t\t|\r\n| LinkedMaterials[].EWCCode\t\t\t\t\t\t\t\t| The Material EWCCode.\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t|"
      operationId: JobMaterials_Get
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: id
        in: path
        required: true
        type: string
        format: uuid
      - name: links
        in: query
        required: false
        type: string
      - name: include
        in: query
        required: false
        type: string
      - name: expand
        in: query
        required: false
        type: string
      - name: udf
        in: query
        required: false
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ApiResourceResultEntity[ApiJobMaterialsResource]'
definitions:
  ApiMaterialResource:
    type: object
    properties:
      MaterialGUID:
        format: uuid
        type: string
        example: 00000000-0000-0000-0000-000000000000
      Material:
        type: string
      ShortCode:
        type: string
      AnalysisCode:
        type: string
      EWCCode:
        type: string
  ApiResourceErrors:
    type: object
    properties:
      errors:
        type: string
  ApiJobMaterialsResource:
    type: object
    properties:
      JobGUID:
        format: uuid
        type: string
        example: 00000000-0000-0000-0000-000000000000
      LinkedMaterials:
        type: array
        items:
          $ref: '#/definitions/ApiMaterialResource'
  ApiResourceResultEntity[ApiJobMaterialsResource]:
    type: object
    properties:
      resource:
        $ref: '#/definitions/ApiJobMaterialsResource'
      links:
        $ref: '#/definitions/ApiResourceResultEntityLinks'
      extra:
        $ref: '#/definitions/ApiResourceResultEntityExtra'
      errors:
        $ref: '#/definitions/ApiResourceErrors'
      status:
        $ref: '#/definitions/ApiResourceStatus'
  ApiResourceStatus:
    type: object
    properties:
      id:
        format: int32
        type: integer
      isSuccess:
        type: boolean
  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