openapi: 3.2.0 info: title: AMCS Platform REST Service Category API description: '![latest End points](/amcsrestapi/diagram/endpointslatest.svg) # Overview ## Who Should Read this Document This document contains a technical description of the AMCS Platform REST API.' version: latest servers: - url: https://ete-p5-tst-svc-core.amcsplatform.com/erp/api/integrator/erp tags: - name: Service Category paths: /lists/serviceCategories/{guid}: get: tags: - Service Category summary: Find with GUID description: '| Property | Description | | ------------------------- | ------------------------------------------------------------------------ | | GUID | The GUID associated to the service category| | Description | The description of the service category| | IsDeleted | Whether the service category is deleted | | AnalysisCode| The analysis code of the service category|' operationId: ServiceCategory_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_ApiIntegratorServiceCategoryResource' /lists/serviceCategories: get: tags: - Service Category summary: Find with Filters description: '| Property | Description | | ------------------------- | ------------------------------------------------------------------------ | | GUID | The GUID associated to the service category| | Description | The description of the service category| | IsDeleted | Whether the service category is deleted | | AnalysisCode| The analysis code of the service category|' operationId: ServiceCategory_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_ApiIntegratorServiceCategoryResource' components: schemas: 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_ApiIntegratorServiceCategoryResource: type: object properties: resource: $ref: '#/components/schemas/ApiIntegratorServiceCategoryResource' 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 ApiResourceResultCollection_ApiIntegratorServiceCategoryResource: type: object properties: resource: type: array items: $ref: '#/components/schemas/ApiIntegratorServiceCategoryResource' extra: $ref: '#/components/schemas/ApiResourceResultCollectionExtra' 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 ApiIntegratorServiceCategoryResource: type: object properties: Description: type: string IsDeleted: type: boolean AnalysisCode: type: string GUID: type: string format: uuid example: 00000000-0000-0000-0000-000000000000 ApiResourceErrors: type: object properties: errors: type: string