swagger: '2.0' info: title: Odyssee Rest API version: 1.0.0 description: Odyssee Rest API tags: - name: ApiLog description: ApiLog tag - name: Article description: Article tag - name: ArticleCategory description: ArticleCategory tag - name: ArticleColor description: ArticleColor tag - name: ArticleGroup1 description: ArticleGroup1 tag - name: ArticleGroup2 description: ArticleGroup2 tag - name: ArticleGroup3 description: ArticleGroup3 tag - name: ArticleGroup4 description: ArticleGroup4 tag - name: ArticleGroup5 description: ArticleGroup5 tag - name: ArticleGroup6 description: ArticleGroup6 tag - name: ArticlePriceLabel description: ArticlePriceLabel tag - name: ArticlePriceList description: ArticlePriceList tag - name: ArticleStatusList description: ArticleStatusList tag - name: ArticleStockLocation description: ArticleStockLocation tag - name: ArticleStockLocationList description: ArticleStockLocationList tag - name: Car description: Car tag - name: CarTravel description: CarTravel tag - name: Company description: Company tag - name: CompanyContact description: CompanyContact tag - name: CompanySalesTerritoryList description: CompanySalesTerritoryList tag - name: CompanySector description: CompanySector tag - name: CompanyType description: CompanyType tag - name: Contact description: Contact tag - name: Contract description: Contract tag - name: Country description: Country tag - name: DbAddress description: DbAddress tag - name: DbFile description: DbFile tag - name: DbFileFolder description: DbFileFolder tag - name: DbInfo description: DbInfo tag - name: DbInfoData description: DbInfoData tag - name: DbInfoDataArticle description: DbInfoDataArticle tag - name: DbInfoDataCompany description: DbInfoDataCompany tag - name: DbInfoDataDbReport description: DbInfoDataDbReport tag - name: DbInfoDataJobs description: DbInfoDataJobs tag - name: DbInfoDataProject description: DbInfoDataProject tag - name: DbInfoDataTask description: DbInfoDataTask tag - name: DbInfoDataUser description: DbInfoDataUser tag - name: DbInfoField description: DbInfoField tag - name: DbInfoFieldProperty description: DbInfoFieldProperty tag - name: DbNotes description: DbNotes tag - name: DbPaymentMethods description: DbPaymentMethods tag - name: DbReport description: DbReport tag - name: EmailNotification description: EmailNotification tag - name: EmailNotificationList description: EmailNotificationList tag - name: EquipmentBrand description: EquipmentBrand tag - name: EquipmentFamily description: EquipmentFamily tag - name: EquipmentModel description: EquipmentModel tag - name: FeeList description: FeeList tag - name: FeeListPrice description: FeeListPrice tag - name: HourType description: HourType tag - name: HourTypeGroup description: HourTypeGroup tag - name: Invoice description: Invoice tag - name: InvoiceDetails description: InvoiceDetails tag - name: InvoiceView description: InvoiceView tag - name: JobApproval description: JobApproval tag - name: JobEstimatedQuantity description: JobEstimatedQuantity tag - name: JobFiles description: JobFiles tag - name: JobNonPartUsage description: JobNonPartUsage tag - name: JobPartUsage description: JobPartUsage tag - name: JobPlanning description: JobPlanning tag - name: JobPriority description: JobPriority tag - name: Jobs description: Jobs tag - name: JobStatus description: JobStatus tag - name: JobType description: JobType tag - name: JobWorkInstructionList description: JobWorkInstructionList tag - name: Language description: Language tag - name: Location description: Location tag - name: MarketingSegment description: MarketingSegment tag - name: Project description: Project tag - name: ProjectStatus description: ProjectStatus tag - name: PurchaseOrder description: PurchaseOrder tag - name: PurchaseOrderDetails description: PurchaseOrderDetails tag - name: SalesOrganization description: SalesOrganization tag - name: SalesTerritory description: SalesTerritory tag - name: Skill description: Skill tag - name: Task description: Task tag - name: TaskActivity description: TaskActivity tag - name: TaskActivityLog description: TaskActivityLog tag - name: TaskFiles description: TaskFiles tag - name: TaskPriority description: TaskPriority tag - name: TaskStatus description: TaskStatus tag - name: TaskType description: TaskType tag - name: User description: User tag - name: UserGroup description: UserGroup tag - name: UserPlanningSlot description: UserPlanningSlot tag - name: UserPlanningSlotType description: UserPlanningSlotType tag - name: UserSalesOrganizationList description: UserSalesOrganizationList tag - name: UserSalesTerritoryList description: UserSalesTerritoryList tag - name: UserSkillList description: UserSkillList tag - name: UserTimesheet description: UserTimesheet tag - name: UserUnavailability description: UserUnavailability tag - name: UserUnavailabilityType description: UserUnavailabilityType tag - name: UserWeekApproval description: UserWeekApproval tag - name: WorkInstruction description: WorkInstruction tag - name: WorkInstructionActionType description: WorkInstructionActionType tag - name: WorkInstructionDetails description: WorkInstructionDetails tag paths: /api/ApiLog({id}): get: tags: - ApiLog summary: Retrieves a api log with the specified key operationId: GET-api-ApiLog(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/api_log' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred delete: tags: - ApiLog summary: Deletes the api_log with the specified key operationId: DELETE-api-ApiLog(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/ApiLog: get: tags: - ApiLog summary: Retrieves all the api logs operationId: GET-api-ApiLog produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/api_log' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - ApiLog summary: Creates a new api log object operationId: POST-api-ApiLog produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/api_log' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/api_log' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/api_log' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/Article({id}): get: tags: - Article summary: Retrieves the article with the specified key operationId: GET-api-Article(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - Article summary: Updates the article with the specified key operationId: PUT-api-Article(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/article' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/Article: get: tags: - Article summary: Retrieves all the articles operationId: GET-api-Article produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - Article summary: Creates a new article operationId: POST-api-Article produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/article' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/article' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/ArticleCategory({id}): get: tags: - ArticleCategory summary: Retrieves the article category with the specified key operationId: GET-api-ArticleCategory(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_category' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - ArticleCategory summary: Updates the article category with the specified key operationId: PUT-api-ArticleCategory(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/article_category' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_category' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - ArticleCategory summary: Deletes the article category with the specified key operationId: DELETE-api-ArticleCategory(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/ArticleCategory: get: tags: - ArticleCategory summary: Retrieves all the article categories operationId: GET-api-ArticleCategory produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_category' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - ArticleCategory summary: Creates a new article category operationId: POST-api-ArticleCategory produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/article_category' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_category' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/article_category' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/ArticleColor({id}): get: tags: - ArticleColor summary: Retrieves the article color with the specified key operationId: GET-api-ArticleColor(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_color' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - ArticleColor summary: Updates the article color with the specified key operationId: PUT-api-ArticleColor(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/article_color' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_color' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/ArticleColor: get: tags: - ArticleColor summary: Retrieves all the article color operationId: GET-api-ArticleColor produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_color' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - ArticleColor summary: Creates a new article color operationId: POST-api-ArticleColor produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/article_color' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_color' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/article_color' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/ArticleGroup1({id}): get: tags: - ArticleGroup1 summary: Retrieves the item of article group 1 with the specified key operationId: GET-api-ArticleGroup1(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_group_1' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - ArticleGroup1 summary: Updates the item of article group 1 with the specified key operationId: PUT-api-ArticleGroup1(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/article_group_1' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_group_1' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - ArticleGroup1 summary: Deletes the item of article group 1 with the specified key operationId: DELETE-api-ArticleGroup1(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/ArticleGroup1: get: tags: - ArticleGroup1 summary: Retrieves all items of article group 1 operationId: GET-api-ArticleGroup1 produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_group_1' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - ArticleGroup1 summary: Creates a new item within article group 1 operationId: POST-api-ArticleGroup1 produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/article_group_1' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_group_1' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/article_group_1' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/ArticleGroup2({id}): get: tags: - ArticleGroup2 summary: Retrieves the item of article group 2 with the specified key operationId: GET-api-ArticleGroup2(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_group_2' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - ArticleGroup2 summary: Updates the item of article group 2 with the specified key operationId: PUT-api-ArticleGroup2(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/article_group_2' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_group_2' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - ArticleGroup2 summary: Deletes the item of article group 2 with the specified key operationId: DELETE-api-ArticleGroup2(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/ArticleGroup2: get: tags: - ArticleGroup2 summary: Retrieves all items of article group 2 operationId: GET-api-ArticleGroup2 produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_group_2' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - ArticleGroup2 summary: Creates a new item within article group 2 operationId: POST-api-ArticleGroup2 produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/article_group_2' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_group_2' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/article_group_2' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/ArticleGroup3({id}): get: tags: - ArticleGroup3 summary: Retrieves the item of article group 3 with the specified key operationId: GET-api-ArticleGroup3(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_group_3' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - ArticleGroup3 summary: Updates the item of article group 3 with the specified key operationId: PUT-api-ArticleGroup3(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/article_group_3' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_group_3' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - ArticleGroup3 summary: Deletes the item of article group 3 with the specified key operationId: DELETE-api-ArticleGroup3(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/ArticleGroup3: get: tags: - ArticleGroup3 summary: Retrieves all items of article group 3 operationId: GET-api-ArticleGroup3 produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_group_3' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - ArticleGroup3 summary: Creates a new item within article group 3 operationId: POST-api-ArticleGroup3 produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/article_group_3' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_group_3' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/article_group_3' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/ArticleGroup4({id}): get: tags: - ArticleGroup4 summary: Retrieves the item of article group 4 with the specified key operationId: GET-api-ArticleGroup4(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_group_4' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - ArticleGroup4 summary: Updates the item of article group 4 with the specified key operationId: PUT-api-ArticleGroup4(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/article_group_4' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_group_4' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - ArticleGroup4 summary: Deletes the item of article group 4 with the specified key operationId: DELETE-api-ArticleGroup4(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/ArticleGroup4: get: tags: - ArticleGroup4 summary: Retrieves all items of article group 4 operationId: GET-api-ArticleGroup4 produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_group_4' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - ArticleGroup4 summary: Creates a new item within article group 4 operationId: POST-api-ArticleGroup4 produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/article_group_4' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_group_4' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/article_group_4' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/ArticleGroup5({id}): get: tags: - ArticleGroup5 summary: Retrieves the item of article group 5 with the specified key operationId: GET-api-ArticleGroup5(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_group_5' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - ArticleGroup5 summary: Updates the item of article group 5 with the specified key operationId: PUT-api-ArticleGroup5(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/article_group_5' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_group_5' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - ArticleGroup5 summary: Deletes the item of article group 5 with the specified key operationId: DELETE-api-ArticleGroup5(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/ArticleGroup5: get: tags: - ArticleGroup5 summary: Retrieves all items of article group 5 operationId: GET-api-ArticleGroup5 produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_group_5' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - ArticleGroup5 summary: Creates a new item within article group 5 operationId: POST-api-ArticleGroup5 produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/article_group_5' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_group_5' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/article_group_5' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/ArticleGroup6({id}): get: tags: - ArticleGroup6 summary: Retrieves the item of article group 6 with the specified key operationId: GET-api-ArticleGroup6(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_group_6' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - ArticleGroup6 summary: Updates the item of article group 6 with the specified key operationId: PUT-api-ArticleGroup6(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/article_group_6' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_group_6' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - ArticleGroup6 summary: Deletes the item of article group 6 with the specified key operationId: DELETE-api-ArticleGroup6(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/ArticleGroup6: get: tags: - ArticleGroup6 summary: Retrieves all items of article group 6 operationId: GET-api-ArticleGroup6 produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_group_6' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - ArticleGroup6 summary: Creates a new item within article group 6 operationId: POST-api-ArticleGroup6 produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/article_group_6' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_group_6' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/article_group_6' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/ArticlePriceLabel({id}): get: tags: - ArticlePriceLabel summary: Retrieves the article price label with the specified key operationId: GET-api-ArticlePriceLabel(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_price_label' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - ArticlePriceLabel summary: Updates the article price label with the specified key operationId: PUT-api-ArticlePriceLabel(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/article_price_label' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_price_label' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/ArticlePriceLabel: get: tags: - ArticlePriceLabel summary: Retrieves all the article price label operationId: GET-api-ArticlePriceLabel produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_price_label' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - ArticlePriceLabel summary: Creates a new article price label operationId: POST-api-ArticlePriceLabel produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/article_price_label' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_price_label' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/article_price_label' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/ArticlePriceList({id}): get: tags: - ArticlePriceList summary: Retrieves the article price list with the specified key operationId: GET-api-ArticlePriceList(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_price_list' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - ArticlePriceList summary: Updates the article price list with the specified key operationId: PUT-api-ArticlePriceList(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/article_price_list' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_price_list' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/ArticlePriceList: get: tags: - ArticlePriceList summary: Retrieves all the article price list operationId: GET-api-ArticlePriceList produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_price_list' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - ArticlePriceList summary: Creates a new article price list operationId: POST-api-ArticlePriceList produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/article_price_list' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_price_list' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/article_price_list' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/ArticleStatusList({id}): get: tags: - ArticleStatusList summary: Retrieves the article status list with the specified key operationId: GET-api-ArticleStatusList(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_status_list' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - ArticleStatusList summary: Updates the article status list with the specified key operationId: PUT-api-ArticleStatusList(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/article_status_list' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_status_list' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/ArticleStatusList: get: tags: - ArticleStatusList summary: Retrieves all the article status list operationId: GET-api-ArticleStatusList produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_status_list' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - ArticleStatusList summary: Creates a new article status list operationId: POST-api-ArticleStatusList produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/article_status_list' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_status_list' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/article_status_list' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/ArticleStockLocation({id}): get: tags: - ArticleStockLocation summary: Retrieves the article stock location with the specified key operationId: GET-api-ArticleStockLocation(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_stock_location' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - ArticleStockLocation summary: Updates the article stock location with the specified key operationId: PUT-api-ArticleStockLocation(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/article_stock_location' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_stock_location' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/ArticleStockLocation: get: tags: - ArticleStockLocation summary: Retrieves all the article stock location operationId: GET-api-ArticleStockLocation produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_stock_location' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - ArticleStockLocation summary: Creates a new article stock location operationId: POST-api-ArticleStockLocation produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/article_stock_location' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_stock_location' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/article_stock_location' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/ArticleStockLocationList({id}): get: tags: - ArticleStockLocationList summary: Retrieves the article stock location list with the specified key operationId: GET-api-ArticleStockLocationList(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_stock_location_list' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - ArticleStockLocationList summary: Updates the article stock location list with the specified key operationId: PUT-api-ArticleStockLocationList(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/article_stock_location_list' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_stock_location_list' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - ArticleStockLocationList summary: Deletes the article stock location list object with the specified key operationId: DELETE-api-ArticleStockLocationList(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/ArticleStockLocationList: get: tags: - ArticleStockLocationList summary: Retrieves all the article stock location lists operationId: GET-api-ArticleStockLocationList produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_stock_location_list' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - ArticleStockLocationList summary: Creates a new article stock location list operationId: POST-api-ArticleStockLocationList produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/article_stock_location_list' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/article_stock_location_list' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/article_stock_location_list' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/Car({id}): get: tags: - Car summary: Retrieves a car with the specified key operationId: GET-api-Car(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/car' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - Car summary: Updates the car with the specified key operationId: PUT-api-Car(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/car' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/car' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - Car summary: Deletes the car object with the specified key operationId: DELETE-api-Car(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/Car: get: tags: - Car summary: Retrieves all the cars operationId: GET-api-Car produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/car' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - Car summary: Creates a new car operationId: POST-api-Car produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/car' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/car' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/car' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/CarTravel({id}): get: tags: - CarTravel summary: Retrieves a car travel with the specified key operationId: GET-api-CarTravel(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/car_travel' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/CarTravel: get: tags: - CarTravel summary: Retrieves all the car travels operationId: GET-api-CarTravel produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/car_travel' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/Company({id}): get: tags: - Company summary: Retrieves the company with the specified key operationId: GET-api-Company(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/company' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - Company summary: Updates the company with the specified key operationId: PUT-api-Company(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/company' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/company' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/Company: get: tags: - Company summary: Retrieves all the companies operationId: GET-api-Company produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/company' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - Company summary: Creates a new company operationId: POST-api-Company produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/company' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/company' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/company' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/CompanyContact({id}): get: tags: - CompanyContact summary: Retrieves the company contact with the specified key operationId: GET-api-CompanyContact(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/company_contact' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - CompanyContact summary: Updates the company contact with the specified key operationId: PUT-api-CompanyContact(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/company_contact' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/company_contact' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/CompanyContact: get: tags: - CompanyContact summary: Retrieves all the company contact operationId: GET-api-CompanyContact produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/company_contact' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - CompanyContact summary: Creates a new company contact object operationId: POST-api-CompanyContact produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/company_contact' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/company_contact' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/company_contact' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/CompanySalesTerritoryList({id}): get: tags: - CompanySalesTerritoryList summary: Retrieves the company_sales_territory_list object with the specified key operationId: GET-api-CompanySalesTerritoryList(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/company_sales_territory_list' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - CompanySalesTerritoryList summary: Updates the company_sales_territory_list object with the specified key operationId: PUT-api-CompanySalesTerritoryList(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/company_sales_territory_list' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/company_sales_territory_list' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - CompanySalesTerritoryList summary: Deletes the company_sales_territory_list object with the specified key operationId: DELETE-api-CompanySalesTerritoryList(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/CompanySalesTerritoryList: get: tags: - CompanySalesTerritoryList summary: Retrieves all the company_sales_territory_list objects operationId: GET-api-CompanySalesTerritoryList produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/company_sales_territory_list' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - CompanySalesTerritoryList summary: Creates a new company_sales_territory_list object operationId: POST-api-CompanySalesTerritoryList produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/company_sales_territory_list' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/company_sales_territory_list' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/company_sales_territory_list' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/CompanySector({id}): get: tags: - CompanySector summary: Retrieves the item of compay sector with the specified key operationId: GET-api-CompanySector(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/company_sector' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - CompanySector summary: Updates the item of company sector with the specified key operationId: PUT-api-CompanySector(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/company_sector' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/company_sector' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - CompanySector summary: Deletes the company sector with the specified key operationId: DELETE-api-CompanySector(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/CompanySector: get: tags: - CompanySector summary: Retrieves all items of company sector operationId: GET-api-CompanySector produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/company_sector' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - CompanySector summary: Creates a new item within company sector operationId: POST-api-CompanySector produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/company_sector' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/company_sector' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/company_sector' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/CompanyType({id}): get: tags: - CompanyType summary: Retrieves the type with the specified key operationId: GET-api-CompanyType(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/company_type' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - CompanyType summary: Updates the type with the specified key operationId: PUT-api-CompanyType(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/company_type' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/company_type' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - CompanyType summary: Deletes the type with the specified key operationId: DELETE-api-CompanyType(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/CompanyType: get: tags: - CompanyType summary: Retrieves all the type operationId: GET-api-CompanyType produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/company_type' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - CompanyType summary: Creates a new type operationId: POST-api-CompanyType produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/company_type' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/company_type' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/company_type' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/Contact({id}): get: tags: - Contact summary: Retrieves the contact with the specified key operationId: GET-api-Contact(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/contact' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - Contact summary: Updates the contact with the specified key operationId: PUT-api-Contact(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/contact' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/contact' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/Contact/GetByEmail?email={email}: get: tags: - Contact summary: Get Contact by email operationId: GET-api-Contact-GetByEmail_email produces: - application/json - application/xml parameters: - name: email in: path description: Email of contact required: true type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/contact' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/Contact?company_id={company_id}: get: tags: - Contact summary: Get Contact by Company Id operationId: GET-api-Contact_company_id produces: - application/json - application/xml parameters: - name: company_id in: path required: true type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/contact' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/Contact: get: tags: - Contact summary: Retrieves all the contacts operationId: GET-api-Contact produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/contact' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - Contact summary: Creates a new contact object operationId: POST-api-Contact produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/contact' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/contact' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/contact' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/Contract({id}): get: tags: - Contract summary: Retrieves the Contract with the specified key operationId: GET-api-Contract(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/contract' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - Contract summary: Updates the Contract with the specified key operationId: PUT-api-Contract(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/contract' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/contract' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/Contract: get: tags: - Contract summary: Retrieves all the contracts operationId: GET-api-Contract produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/contract' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - Contract summary: Creates a new Contract object operationId: POST-api-Contract produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/contract' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/contract' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/contract' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/Country({id}): get: tags: - Country summary: Retrieves the country with the specified key operationId: GET-api-Country(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_country' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/Country: get: tags: - Country summary: Retrieves all countries operationId: GET-api-Country produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_country' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/DbAddress({id}): get: tags: - DbAddress summary: Retrieves the db_address with the specified key operationId: GET-api-DbAddress(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_address' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - DbAddress summary: Updates the work order type with the specified key operationId: PUT-api-DbAddress(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/db_address' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_address' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/DbAddress: get: tags: - DbAddress summary: Retrieves all db_address operationId: GET-api-DbAddress produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_address' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - DbAddress summary: Create a a new db_address usable for a company operationId: POST-api-DbAddress produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/db_address' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_address' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/db_address' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/DbFile({id}): get: tags: - DbFile summary: Retrieves the db_file with the specified key operationId: GET-api-DbFile(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_file' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - DbFile summary: Update a db_file by supplying directly the field db_file.file_content as Byte Array operationId: PUT-api-DbFile(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/db_file' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_file' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - DbFile summary: Deletes the global db_file object (or files linked to entity but not JobApprovalPDF/OrderPDF/PurchaseOrderPDF) with the specified key operationId: DELETE-api-DbFile(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/DbFile/Add?db_table_id={db_table_id}&id_in_table={id_in_table}&description={description}: post: tags: - DbFile summary: Uses to upload files to a entity (like a task). Add file content into request body. operationId: POST-api-DbFile-Add_db_table_id_id_in_table_description produces: - application/json - application/xml parameters: - name: db_table_id in: path description: TableID of the object.For Task uses 448260E5-7A17-4381-A254-0B1D8FE53947 required: true type: string format: guid - name: id_in_table in: path description: ID of the object, like task.id required: true type: string format: guid - name: description in: path description: description of the file required: true type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_file' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/db_file' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/DbFile/GetFileContent/{id}: get: tags: - DbFile summary: Get the content of the file operationId: GET-api-DbFile-GetFileContent-id produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_file' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/DbFile: get: tags: - DbFile summary: Retrieves all db_file operationId: GET-api-DbFile produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_file' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - DbFile summary: Creates a new db_file by supplying directly the field db_file.file_content as Byte Array operationId: POST-api-DbFile produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/db_file' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_file' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/db_file' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/DbFileFolder({id}): get: tags: - DbFileFolder summary: No description operationId: GET-api-DbFileFolder(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_file_folder' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - DbFileFolder summary: No description operationId: PUT-api-DbFileFolder(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/db_file_folder' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_file_folder' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - DbFileFolder summary: No description operationId: DELETE-api-DbFileFolder(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/DbFileFolder: get: tags: - DbFileFolder summary: No description operationId: GET-api-DbFileFolder produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_file_folder' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - DbFileFolder summary: No description operationId: POST-api-DbFileFolder produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/db_file_folder' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_file_folder' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/db_file_folder' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/DbInfo({id}): get: tags: - DbInfo summary: Retrieves an object of the specified key if belongs to a static category (like Company,Project,...) operationId: GET-api-DbInfo(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - DbInfo summary: Updates the modifications done on the object that belongs to a static category (like Company,Project,...) operationId: PUT-api-DbInfo(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/db_info' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - DbInfo summary: Deletes the object of the specified key operationId: DELETE-api-DbInfo(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/DbInfo: get: tags: - DbInfo summary: Retrieves all objects db_info that belongs to a static category (like Company,Project,...) operationId: GET-api-DbInfo produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - DbInfo summary: Creates a new object that belongs to a static category (like Company,Project,...) operationId: POST-api-DbInfo produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/db_info' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/db_info' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/DbInfoData({id}): get: tags: - DbInfoData summary: Retrieves the db_info_data object with the specified key operationId: GET-api-DbInfoData(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_data' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - DbInfoData summary: Updates the db_info_data object with the specified key /// operationId: PUT-api-DbInfoData(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/db_info_data' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_data' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - DbInfoData summary: Deletes the db_info_data object with the specified key operationId: DELETE-api-DbInfoData(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/DbInfoData: get: tags: - DbInfoData summary: Retrieves all the db_info_data objects operationId: GET-api-DbInfoData produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_data' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - DbInfoData summary: Creates a new db_info_data object operationId: POST-api-DbInfoData produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/db_info_data' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_data' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/db_info_data' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/DbInfoDataArticle({id}): get: tags: - DbInfoDataArticle summary: Retrieves the db_info_data_article object with the specified key operationId: GET-api-DbInfoDataArticle(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_data_article' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - DbInfoDataArticle summary: Updates the db_info_data_article object with the specified key /// operationId: PUT-api-DbInfoDataArticle(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/db_info_data_article' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_data_article' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - DbInfoDataArticle summary: Deletes the db_info_data_article object with the specified key operationId: DELETE-api-DbInfoDataArticle(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/DbInfoDataArticle: get: tags: - DbInfoDataArticle summary: Retrieves all the db_info_data_article objects operationId: GET-api-DbInfoDataArticle produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_data_article' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - DbInfoDataArticle summary: Creates a new db_info_data_article object operationId: POST-api-DbInfoDataArticle produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/db_info_data_article' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_data_article' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/db_info_data_article' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/DbInfoDataCompany({id}): get: tags: - DbInfoDataCompany summary: Retrieves the db_info_data_company object with the specified key operationId: GET-api-DbInfoDataCompany(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_data_company' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - DbInfoDataCompany summary: Updates the db_info_data_company object with the specified key /// operationId: PUT-api-DbInfoDataCompany(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/db_info_data_company' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_data_company' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - DbInfoDataCompany summary: Deletes the db_info_data_company object with the specified key operationId: DELETE-api-DbInfoDataCompany(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/DbInfoDataCompany: get: tags: - DbInfoDataCompany summary: Retrieves all the db_info_data_company objects operationId: GET-api-DbInfoDataCompany produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_data_company' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - DbInfoDataCompany summary: Creates a new db_info_data_company object operationId: POST-api-DbInfoDataCompany produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/db_info_data_company' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_data_company' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/db_info_data_company' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/DbInfoDataDbReport({id}): get: tags: - DbInfoDataDbReport summary: Retrieves the db_info_data_db_report object with the specified key operationId: GET-api-DbInfoDataDbReport(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_data_db_report' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - DbInfoDataDbReport summary: Updates the db_info_data_db_report object with the specified key /// operationId: PUT-api-DbInfoDataDbReport(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/db_info_data_db_report' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_data_db_report' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - DbInfoDataDbReport summary: Deletes the db_info_data_db_report object with the specified key operationId: DELETE-api-DbInfoDataDbReport(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/DbInfoDataDbReport: get: tags: - DbInfoDataDbReport summary: Retrieves all the db_info_data_db_report objects operationId: GET-api-DbInfoDataDbReport produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_data_db_report' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - DbInfoDataDbReport summary: Creates a new db_info_data_db_report object operationId: POST-api-DbInfoDataDbReport produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/db_info_data_db_report' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_data_db_report' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/db_info_data_db_report' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/DbInfoDataJobs({id}): get: tags: - DbInfoDataJobs summary: Retrieves the db_info_data_jobs object with the specified key operationId: GET-api-DbInfoDataJobs(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_data_jobs' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - DbInfoDataJobs summary: Updates the db_info_data_jobs object with the specified key /// operationId: PUT-api-DbInfoDataJobs(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/db_info_data_jobs' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_data_jobs' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - DbInfoDataJobs summary: Deletes the db_info_data_jobs object with the specified key operationId: DELETE-api-DbInfoDataJobs(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/DbInfoDataJobs: get: tags: - DbInfoDataJobs summary: Retrieves all the db_info_data_jobs objects operationId: GET-api-DbInfoDataJobs produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_data_jobs' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - DbInfoDataJobs summary: Creates a new db_info_data_jobs object operationId: POST-api-DbInfoDataJobs produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/db_info_data_jobs' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_data_jobs' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/db_info_data_jobs' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/DbInfoDataProject({id}): get: tags: - DbInfoDataProject summary: Retrieves the db_info_data_project object with the specified key operationId: GET-api-DbInfoDataProject(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_data_project' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - DbInfoDataProject summary: Updates the db_info_data_project object with the specified key /// operationId: PUT-api-DbInfoDataProject(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/db_info_data_project' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_data_project' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - DbInfoDataProject summary: Deletes the db_info_data_project object with the specified key operationId: DELETE-api-DbInfoDataProject(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/DbInfoDataProject: get: tags: - DbInfoDataProject summary: Retrieves all the db_info_data_project objects operationId: GET-api-DbInfoDataProject produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_data_project' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - DbInfoDataProject summary: Creates a new db_info_data_project object operationId: POST-api-DbInfoDataProject produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/db_info_data_project' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_data_project' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/db_info_data_project' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/DbInfoDataTask({id}): get: tags: - DbInfoDataTask summary: Retrieves the db_info_data_task object with the specified key operationId: GET-api-DbInfoDataTask(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_data_task' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - DbInfoDataTask summary: Updates the db_info_data_task object with the specified key /// operationId: PUT-api-DbInfoDataTask(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/db_info_data_task' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_data_task' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - DbInfoDataTask summary: Deletes the db_info_data_task object with the specified key operationId: DELETE-api-DbInfoDataTask(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/DbInfoDataTask: get: tags: - DbInfoDataTask summary: Retrieves all the db_info_data_task objects operationId: GET-api-DbInfoDataTask produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_data_task' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - DbInfoDataTask summary: Creates a new db_info_data_task object operationId: POST-api-DbInfoDataTask produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/db_info_data_task' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_data_task' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/db_info_data_task' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/DbInfoDataUser({id}): get: tags: - DbInfoDataUser summary: Retrieves the db_info_data_user object with the specified key operationId: GET-api-DbInfoDataUser(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_data_user' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - DbInfoDataUser summary: Updates the db_info_data_user object with the specified key /// operationId: PUT-api-DbInfoDataUser(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/db_info_data_user' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_data_user' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - DbInfoDataUser summary: Deletes the db_info_data_user object with the specified key operationId: DELETE-api-DbInfoDataUser(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/DbInfoDataUser: get: tags: - DbInfoDataUser summary: Retrieves all the db_info_data_user objects operationId: GET-api-DbInfoDataUser produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_data_user' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - DbInfoDataUser summary: Creates a new db_info_data_user object operationId: POST-api-DbInfoDataUser produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/db_info_data_user' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_data_user' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/db_info_data_user' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/DbInfoField({id}): get: tags: - DbInfoField summary: Retrieves the item with the specified key operationId: GET-api-DbInfoField(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_field' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - DbInfoField summary: Updates the item with the specified key operationId: PUT-api-DbInfoField(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/db_info_field' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_field' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - DbInfoField summary: Deletes the item with the specified key operationId: DELETE-api-DbInfoField(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/DbInfoField: get: tags: - DbInfoField summary: Retrieves all items operationId: GET-api-DbInfoField produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_field' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - DbInfoField summary: Creates a new item operationId: POST-api-DbInfoField produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/db_info_field' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_field' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/db_info_field' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/DbInfoFieldProperty({id}): get: tags: - DbInfoFieldProperty summary: Retrieves the item with the specified key operationId: GET-api-DbInfoFieldProperty(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_field_property' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - DbInfoFieldProperty summary: Updates the item with the specified key operationId: PUT-api-DbInfoFieldProperty(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/db_info_field_property' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_field_property' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - DbInfoFieldProperty summary: Deletes the item with the specified key operationId: DELETE-api-DbInfoFieldProperty(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/DbInfoFieldProperty: get: tags: - DbInfoFieldProperty summary: Retrieves all items operationId: GET-api-DbInfoFieldProperty produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_field_property' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - DbInfoFieldProperty summary: Creates a new item operationId: POST-api-DbInfoFieldProperty produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/db_info_field_property' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_info_field_property' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/db_info_field_property' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/DbNotes({id}): get: tags: - DbNotes summary: Retrieves the db note with the specified key operationId: GET-api-DbNotes(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_notes' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - DbNotes summary: Updates the db note with the specified key operationId: PUT-api-DbNotes(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/db_notes' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_notes' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - DbNotes summary: Deletes the db note with the specified key operationId: DELETE-api-DbNotes(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/DbNotes: get: tags: - DbNotes summary: Retrieves all db notes operationId: GET-api-DbNotes produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_notes' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - DbNotes summary: Create a new db note operationId: POST-api-DbNotes produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/db_notes' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_notes' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/db_notes' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/DbPaymentMethods({id}): get: tags: - DbPaymentMethods summary: Retrieves the item of db payment methods with the specified key operationId: GET-api-DbPaymentMethods(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_payment_methods' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - DbPaymentMethods summary: Updates the item of db payment methods with the specified key operationId: PUT-api-DbPaymentMethods(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/db_payment_methods' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_payment_methods' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - DbPaymentMethods summary: Deletes the item of db payment methods with the specified key operationId: DELETE-api-DbPaymentMethods(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/DbPaymentMethods: get: tags: - DbPaymentMethods summary: Retrieves all items of db payment methods operationId: GET-api-DbPaymentMethods produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_payment_methods' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - DbPaymentMethods summary: Creates a new item within db payment methods operationId: POST-api-DbPaymentMethods produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/db_payment_methods' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_payment_methods' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/db_payment_methods' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/DbReport({id}): get: tags: - DbReport summary: Retrieves the db report with the specified key operationId: GET-api-DbReport(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_report' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - DbReport summary: Updates the db report with the specified key operationId: PUT-api-DbReport(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/db_report' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_report' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - DbReport summary: Deletes the db report with the specified key operationId: DELETE-api-DbReport(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/DbReport: get: tags: - DbReport summary: Retrieves all db Reports operationId: GET-api-DbReport produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_report' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - DbReport summary: Creates a new db report operationId: POST-api-DbReport produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/db_report' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_report' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/db_report' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/EmailNotification({id}): get: tags: - EmailNotification summary: Retrieves the email notification with the specified key operationId: GET-api-EmailNotification(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/email_notification' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/EmailNotification: get: tags: - EmailNotification summary: Retrieves all the email notification operationId: GET-api-EmailNotification produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/email_notification' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/EmailNotificationList({id}): get: tags: - EmailNotificationList summary: Retrieves the email notification list with the specified key operationId: GET-api-EmailNotificationList(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/email_notification_list' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/EmailNotificationList: get: tags: - EmailNotificationList summary: Retrieves all the email notification list operationId: GET-api-EmailNotificationList produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/email_notification_list' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/EquipmentBrand({id}): get: tags: - EquipmentBrand summary: Retrieves the equipment_brand object with the specified key operationId: GET-api-EquipmentBrand(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/equipment_brand' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - EquipmentBrand summary: Updates the equipment_brand object with the specified key operationId: PUT-api-EquipmentBrand(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/equipment_brand' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/equipment_brand' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - EquipmentBrand summary: Deletes the equipment_brand object with the specified key operationId: DELETE-api-EquipmentBrand(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/EquipmentBrand: get: tags: - EquipmentBrand summary: Retrieves all the equipment_brand objects operationId: GET-api-EquipmentBrand produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/equipment_brand' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - EquipmentBrand summary: Creates a new equipment_brand object operationId: POST-api-EquipmentBrand produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/equipment_brand' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/equipment_brand' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/equipment_brand' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/EquipmentFamily({id}): get: tags: - EquipmentFamily summary: Retrieves the equipment_family object with the specified key operationId: GET-api-EquipmentFamily(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/equipment_family' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - EquipmentFamily summary: Updates the equipment_family object with the specified key operationId: PUT-api-EquipmentFamily(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/equipment_family' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/equipment_family' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - EquipmentFamily summary: Deletes the equipment_family object with the specified key operationId: DELETE-api-EquipmentFamily(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/EquipmentFamily: get: tags: - EquipmentFamily summary: Retrieves all the equipment_family objects operationId: GET-api-EquipmentFamily produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/equipment_family' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - EquipmentFamily summary: Creates a new equipment_family object operationId: POST-api-EquipmentFamily produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/equipment_family' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/equipment_family' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/equipment_family' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/EquipmentModel({id}): get: tags: - EquipmentModel summary: Retrieves the equipment_model object with the specified key operationId: GET-api-EquipmentModel(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/equipment_model' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - EquipmentModel summary: Updates the equipment_model object with the specified key operationId: PUT-api-EquipmentModel(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/equipment_model' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/equipment_model' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - EquipmentModel summary: Deletes the equipment_model object with the specified key operationId: DELETE-api-EquipmentModel(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/EquipmentModel: get: tags: - EquipmentModel summary: Retrieves all the equipment_model objects operationId: GET-api-EquipmentModel produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/equipment_model' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - EquipmentModel summary: Creates a new equipment_model object operationId: POST-api-EquipmentModel produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/equipment_model' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/equipment_model' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/equipment_model' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/FeeList({id}): get: tags: - FeeList summary: Retrieves the fee list with the specified key operationId: GET-api-FeeList(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/feelist' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - FeeList summary: Updates the fee list with the specified key operationId: PUT-api-FeeList(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/feelist' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/feelist' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/FeeList: get: tags: - FeeList summary: Retrieves all the fee lists operationId: GET-api-FeeList produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/feelist' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - FeeList summary: Creates a new fee list object operationId: POST-api-FeeList produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/feelist' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/feelist' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/feelist' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/FeeListPrice({id}): get: tags: - FeeListPrice summary: Retrieves the fee list price with the specified key operationId: GET-api-FeeListPrice(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/feelist_price' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - FeeListPrice summary: Updates the fee list price with the specified key operationId: PUT-api-FeeListPrice(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/feelist_price' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/feelist_price' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/FeeListPrice: get: tags: - FeeListPrice summary: Retrieves all the fee list prices operationId: GET-api-FeeListPrice produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/feelist_price' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - FeeListPrice summary: Creates a new fee list price object operationId: POST-api-FeeListPrice produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/feelist_price' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/feelist_price' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/feelist_price' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/HourType({id}): get: tags: - HourType summary: Retrieves the hour_type object with the specified key operationId: GET-api-HourType(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/hour_type' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - HourType summary: Updates the hour_type object with the specified key operationId: PUT-api-HourType(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/hour_type' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/hour_type' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - HourType summary: Deletes the hour_type object with the specified key operationId: DELETE-api-HourType(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/HourType: get: tags: - HourType summary: Retrieves all the hour_type objects operationId: GET-api-HourType produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/hour_type' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - HourType summary: Creates a new hour_type object operationId: POST-api-HourType produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/hour_type' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/hour_type' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/hour_type' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/HourTypeGroup({id}): get: tags: - HourTypeGroup summary: Retrieves the hour_type_group object with the specified key operationId: GET-api-HourTypeGroup(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/hour_type_group' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - HourTypeGroup summary: Updates the hour_type_group object with the specified key operationId: PUT-api-HourTypeGroup(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/hour_type_group' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/hour_type_group' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - HourTypeGroup summary: Deletes the hour_type_group object with the specified key operationId: DELETE-api-HourTypeGroup(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/HourTypeGroup: get: tags: - HourTypeGroup summary: Retrieves all the hour_type_group objects operationId: GET-api-HourTypeGroup produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/hour_type_group' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - HourTypeGroup summary: Creates a new hour_type_group object operationId: POST-api-HourTypeGroup produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/hour_type_group' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/hour_type_group' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/hour_type_group' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/Invoice({id}): get: tags: - Invoice summary: Get invoice using specific key. operationId: GET-api-Invoice(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/invoice' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/Invoice: get: tags: - Invoice summary: Get all invoices operationId: GET-api-Invoice produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/invoice' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/InvoiceDetails({id}): get: tags: - InvoiceDetails summary: Get invoice details using specific key. operationId: GET-api-InvoiceDetails(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/invoice_details' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/InvoiceDetails: get: tags: - InvoiceDetails summary: Get all invoice details operationId: GET-api-InvoiceDetails produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/invoice_details' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/InvoiceView({id}): get: tags: - InvoiceView summary: Get invoice using specific key. operationId: GET-api-InvoiceView(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/invoice_view' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/InvoiceView: get: tags: - InvoiceView summary: Get all invoices operationId: GET-api-InvoiceView produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/invoice_view' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/JobApproval({id}): get: tags: - JobApproval summary: Retrieves the job approval with the specified key operationId: GET-api-JobApproval(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/job_approval' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/JobApproval: get: tags: - JobApproval summary: Retrieves all the job approvals operationId: GET-api-JobApproval produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/job_approval' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/JobEstimatedQuantity({id}): get: tags: - JobEstimatedQuantity summary: Retrieves the job_estimated_quantity with the specified key operationId: GET-api-JobEstimatedQuantity(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/job_estimated_quantity' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - JobEstimatedQuantity summary: Updates the job_estimated_quantity object with the specified key operationId: PUT-api-JobEstimatedQuantity(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/job_estimated_quantity' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/job_estimated_quantity' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - JobEstimatedQuantity summary: Deletes the job_estimated_quantity object with the specified key operationId: DELETE-api-JobEstimatedQuantity(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/JobEstimatedQuantity: get: tags: - JobEstimatedQuantity summary: Retrieves all the job_estimated_quantity objects operationId: GET-api-JobEstimatedQuantity produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/job_estimated_quantity' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - JobEstimatedQuantity summary: Creates a new job_estimated_quantity object operationId: POST-api-JobEstimatedQuantity produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/job_estimated_quantity' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/job_estimated_quantity' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/job_estimated_quantity' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/JobFiles({id}): get: tags: - JobFiles summary: Retrieves the job_files with the specified key operationId: GET-api-JobFiles(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/job_files' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - JobFiles summary: Update a job_files by supplying directly the field job_files.file_content as Byte Array operationId: PUT-api-JobFiles(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/job_files' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/job_files' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - JobFiles summary: Deletes the global job_files object (or files linked to entity but not JobApprovalPDF/OrderPDF/PurchaseOrderPDF) with the specified key operationId: DELETE-api-JobFiles(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/JobFiles/GetFileContent/{id}: get: tags: - JobFiles summary: Get the content of the file operationId: GET-api-JobFiles-GetFileContent-id produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/job_files' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/JobFiles: get: tags: - JobFiles summary: Retrieves all job_files operationId: GET-api-JobFiles produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/job_files' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - JobFiles summary: Creates a new job_files by supplying directly the field job_files.file_content as Byte Array operationId: POST-api-JobFiles produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/job_files' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/job_files' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/job_files' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/JobNonPartUsage({id}): get: tags: - JobNonPartUsage summary: Retrieves the job_non_part_usage object with the specified key operationId: GET-api-JobNonPartUsage(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/job_non_part_usage' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/JobNonPartUsage: get: tags: - JobNonPartUsage summary: Retrieves all the job_non_part_usage objects operationId: GET-api-JobNonPartUsage produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/job_non_part_usage' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/JobPartUsage({id}): get: tags: - JobPartUsage summary: Retrieves the used part with the specified key operationId: GET-api-JobPartUsage(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/job_part_usage' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/JobPartUsage: get: tags: - JobPartUsage summary: Retrieves all used parts operationId: GET-api-JobPartUsage produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/job_part_usage' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/JobPlanning({id}): get: tags: - JobPlanning summary: Get all job planning operationId: GET-api-JobPlanning(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/job_planning' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/JobPlanning: get: tags: - JobPlanning summary: Get job planning using specific key. operationId: GET-api-JobPlanning produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/job_planning' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/JobPriority({id}): get: tags: - JobPriority summary: Retrieves the job_priority object with the specified key operationId: GET-api-JobPriority(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/job_priority' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - JobPriority summary: Updates the job_priority object with the specified key operationId: PUT-api-JobPriority(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/job_priority' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/job_priority' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - JobPriority summary: Deletes the job_priority object with the specified key operationId: DELETE-api-JobPriority(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/JobPriority: get: tags: - JobPriority summary: Retrieves all the job_priority objects operationId: GET-api-JobPriority produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/job_priority' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - JobPriority summary: Creates a new job_priority object operationId: POST-api-JobPriority produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/job_priority' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/job_priority' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/job_priority' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/Jobs({id}): get: tags: - Jobs summary: Retrieves the work order with the specified key operationId: GET-api-Jobs(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/jobs' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - Jobs summary: Updates the work order with the specified key operationId: PUT-api-Jobs(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/jobs' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/jobs' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - Jobs summary: Deletes the work order with the specified key operationId: DELETE-api-Jobs(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/Jobs/AddUsersAsWorkshopInQueue: post: tags: - Jobs summary: Force a job going to WorkshopInQueue and will assign to user in the list operationId: POST-api-Jobs-AddUsersAsWorkshopInQueue produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/jobs' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/jobs' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/jobs' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/Jobs: get: tags: - Jobs summary: Retrieves all the work orders operationId: GET-api-Jobs produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/jobs' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - Jobs summary: Creates a new work order operationId: POST-api-Jobs produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/jobs' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/jobs' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/jobs' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/JobStatus({id}): get: tags: - JobStatus summary: Retrieves the job status with the specified key operationId: GET-api-JobStatus(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/job_status' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - JobStatus summary: Updates the job status with the specified key operationId: PUT-api-JobStatus(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/job_status' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/job_status' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/JobStatus: get: tags: - JobStatus summary: Retrieves all job status operationId: GET-api-JobStatus produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/job_status' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - JobStatus summary: Creates a new job status operationId: POST-api-JobStatus produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/job_status' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/job_status' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/job_status' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/JobType({id}): get: tags: - JobType summary: Retrieves the work order type with the specified key operationId: GET-api-JobType(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/job_type' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - JobType summary: Updates the work order type with the specified key operationId: PUT-api-JobType(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/job_type' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/job_type' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - JobType summary: Deletes the work order type with the specified key operationId: DELETE-api-JobType(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/JobType: get: tags: - JobType summary: Retrieves all work order types operationId: GET-api-JobType produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/job_type' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - JobType summary: Creates a new work order type operationId: POST-api-JobType produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/job_type' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/job_type' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/job_type' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/JobWorkInstructionList({id}): get: tags: - JobWorkInstructionList summary: Retrieves the job work instruction list with the specified key. operationId: GET-api-JobWorkInstructionList(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/job_work_instruction_list' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - JobWorkInstructionList summary: Updates the job work instruction list with the specified key operationId: PUT-api-JobWorkInstructionList(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/job_work_instruction_list' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/job_work_instruction_list' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/JobWorkInstructionList: get: tags: - JobWorkInstructionList summary: Retrieves all the job work instruction list. operationId: GET-api-JobWorkInstructionList produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/job_work_instruction_list' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - JobWorkInstructionList summary: Creates a new job work instruction list. operationId: POST-api-JobWorkInstructionList produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/job_work_instruction_list' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/job_work_instruction_list' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/job_work_instruction_list' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/Language({id}): get: tags: - Language summary: Retrieves the language with the specified key operationId: GET-api-Language(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_language' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/Language: get: tags: - Language summary: Retrieves all languages operationId: GET-api-Language produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/db_language' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/Location({id}): get: tags: - Location summary: Retrieves an object of the specified key operationId: GET-api-Location(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/location' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - Location summary: Updates the location object operationId: PUT-api-Location(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/location' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/location' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - Location summary: Deletes the object of the specified key operationId: DELETE-api-Location(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/Location: get: tags: - Location summary: Retrieves all the locations operationId: GET-api-Location produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/location' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - Location summary: Creates a new location object operationId: POST-api-Location produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/location' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/location' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/location' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/MarketingSegment({id}): get: tags: - MarketingSegment summary: Retrieves the type with the specified key operationId: GET-api-MarketingSegment(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/marketing_segment' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - MarketingSegment summary: Updates the type with the specified key /// operationId: PUT-api-MarketingSegment(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/marketing_segment' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/marketing_segment' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - MarketingSegment summary: Deletes the type with the specified key operationId: DELETE-api-MarketingSegment(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/MarketingSegment: get: tags: - MarketingSegment summary: Retrieves all the type operationId: GET-api-MarketingSegment produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/marketing_segment' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - MarketingSegment summary: Creates a new type operationId: POST-api-MarketingSegment produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/marketing_segment' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/marketing_segment' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/marketing_segment' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/Project({id}): get: tags: - Project summary: Retrieves the project with the specified key operationId: GET-api-Project(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/project' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - Project summary: Updates the project with the specified key operationId: PUT-api-Project(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/project' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/project' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - Project summary: Deletes the project with the specified key operationId: DELETE-api-Project(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/Project: get: tags: - Project summary: Retrieves all the projects operationId: GET-api-Project produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/project' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - Project summary: Creates a new project operationId: POST-api-Project produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/project' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/project' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/project' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/ProjectStatus({id}): get: tags: - ProjectStatus summary: Retrieves the project status with the specified key operationId: GET-api-ProjectStatus(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/project_status' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - ProjectStatus summary: Updates the project status with the specified key operationId: PUT-api-ProjectStatus(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/project_status' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/project_status' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - ProjectStatus summary: Deletes the project status with the specified key operationId: DELETE-api-ProjectStatus(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/ProjectStatus: get: tags: - ProjectStatus summary: Retrieves project statuses operationId: GET-api-ProjectStatus produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/project_status' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - ProjectStatus summary: Creates a new project status operationId: POST-api-ProjectStatus produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/project_status' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/project_status' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/project_status' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/PurchaseOrder({id}): get: tags: - PurchaseOrder summary: Retrieves the purchase order with the specified key operationId: GET-api-PurchaseOrder(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/purchase_order' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - PurchaseOrder summary: Updates the purchase order with the specified key operationId: PUT-api-PurchaseOrder(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/purchase_order' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/purchase_order' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - PurchaseOrder summary: Deletes the purchase order with the specified key operationId: DELETE-api-PurchaseOrder(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/PurchaseOrder: get: tags: - PurchaseOrder summary: Retrieves all the purchase orders operationId: GET-api-PurchaseOrder produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/purchase_order' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - PurchaseOrder summary: Creates a new purchase order operationId: POST-api-PurchaseOrder produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/purchase_order' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/purchase_order' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/purchase_order' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/PurchaseOrderDetails({id}): get: tags: - PurchaseOrderDetails summary: Retrieves the purchase order order lines with the specified key operationId: GET-api-PurchaseOrderDetails(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/purchase_order_details' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - PurchaseOrderDetails summary: Updates the purchase order order lines with the specified key operationId: PUT-api-PurchaseOrderDetails(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/purchase_order_details' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/purchase_order_details' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - PurchaseOrderDetails summary: Deletes the purchase order order lines with the specified key operationId: DELETE-api-PurchaseOrderDetails(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/PurchaseOrderDetails: get: tags: - PurchaseOrderDetails summary: Retrieves all the purchase order order lines operationId: GET-api-PurchaseOrderDetails produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/purchase_order_details' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - PurchaseOrderDetails summary: Creates a new purchase order order line operationId: POST-api-PurchaseOrderDetails produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/purchase_order_details' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/purchase_order_details' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/purchase_order_details' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/SalesOrganization({id}): get: tags: - SalesOrganization summary: Retrieves organization with the specified key operationId: GET-api-SalesOrganization(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/sales_organization' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - SalesOrganization summary: Updates the organization with the specified key /// operationId: PUT-api-SalesOrganization(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/sales_organization' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/sales_organization' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - SalesOrganization summary: Deletes the organization with the specified key operationId: DELETE-api-SalesOrganization(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/SalesOrganization: get: tags: - SalesOrganization summary: Retrieves all organizations operationId: GET-api-SalesOrganization produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/sales_organization' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - SalesOrganization summary: Creates a new organization operationId: POST-api-SalesOrganization produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/sales_organization' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/sales_organization' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/sales_organization' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/SalesTerritory({id}): get: tags: - SalesTerritory summary: Retrieves the territory with the specified key operationId: GET-api-SalesTerritory(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/sales_territory' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - SalesTerritory summary: Updates the territory with the specified key /// operationId: PUT-api-SalesTerritory(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/sales_territory' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/sales_territory' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - SalesTerritory summary: Deletes the territory with the specified key operationId: DELETE-api-SalesTerritory(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/SalesTerritory: get: tags: - SalesTerritory summary: Retrieves all territories operationId: GET-api-SalesTerritory produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/sales_territory' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - SalesTerritory summary: Creates a new territory operationId: POST-api-SalesTerritory produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/sales_territory' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/sales_territory' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/sales_territory' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/Skill({id}): get: tags: - Skill summary: Retrieves the skill with the specified key operationId: GET-api-Skill(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/skill' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - Skill summary: Updates the skill with the specified key operationId: PUT-api-Skill(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/skill' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/skill' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - Skill summary: Deletes the skill with the specified key operationId: DELETE-api-Skill(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/Skill: get: tags: - Skill summary: Retrieves all skills operationId: GET-api-Skill produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/skill' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - Skill summary: Creates a new skill operationId: POST-api-Skill produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/skill' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/skill' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/skill' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/Task({id}): get: tags: - Task summary: Retrieves the task with the specified key operationId: GET-api-Task(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/task' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - Task summary: Updates the task with the specified key operationId: PUT-api-Task(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/task' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/task' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/TaskActivity({id}): get: tags: - TaskActivity summary: Retrieves the task activity with the specified key operationId: GET-api-TaskActivity(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/task_activity' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - TaskActivity summary: Updates the task activity with the specified key operationId: PUT-api-TaskActivity(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/task_activity' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/task_activity' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/TaskActivity: get: tags: - TaskActivity summary: Retrieves all the task activities operationId: GET-api-TaskActivity produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/task_activity' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - TaskActivity summary: Creates a new task activity operationId: POST-api-TaskActivity produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/task_activity' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/task_activity' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/task_activity' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/TaskActivityLog({id}): get: tags: - TaskActivityLog summary: Retrieves the task_activity_log with the specified key operationId: GET-api-TaskActivityLog(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/task_activity_log' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - TaskActivityLog summary: Updates the task_activity_log with the specified key operationId: PUT-api-TaskActivityLog(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/task_activity_log' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/task_activity_log' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/TaskActivityLog: get: tags: - TaskActivityLog summary: Retrieves all the task_activity_log operationId: GET-api-TaskActivityLog produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/task_activity_log' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - TaskActivityLog summary: Creates a new task_activity_log operationId: POST-api-TaskActivityLog produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/task_activity_log' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/task_activity_log' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/task_activity_log' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/Task: get: tags: - Task summary: Retrieves all the tasks operationId: GET-api-Task produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/task' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - Task summary: Creates a new task operationId: POST-api-Task produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/task' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/task' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/task' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/TaskFiles({id}): get: tags: - TaskFiles summary: Retrieves the task_files with the specified key operationId: GET-api-TaskFiles(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/task_files' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - TaskFiles summary: Update a task_files by supplying directly the field task_files.file_content as Byte Array operationId: PUT-api-TaskFiles(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/task_files' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/task_files' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - TaskFiles summary: Deletes the global task_files object with the specified key operationId: DELETE-api-TaskFiles(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/TaskFiles/GetFileContent/{id}: get: tags: - TaskFiles summary: Get the content of the file operationId: GET-api-TaskFiles-GetFileContent-id produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/task_files' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/TaskFiles: get: tags: - TaskFiles summary: Retrieves all task_files operationId: GET-api-TaskFiles produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/task_files' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - TaskFiles summary: Creates a new task_files by supplying directly the field task_files.file_content as Byte Array operationId: POST-api-TaskFiles produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/task_files' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/task_files' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/task_files' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/TaskPriority({id}): get: tags: - TaskPriority summary: Retrieves the task priority with the specified key operationId: GET-api-TaskPriority(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/task_priority' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - TaskPriority summary: Updates the task priority with the specified key operationId: PUT-api-TaskPriority(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/task_priority' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/task_priority' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - TaskPriority summary: Deletes the task priority with the specified key operationId: DELETE-api-TaskPriority(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/TaskPriority: get: tags: - TaskPriority summary: Retrieves all task priorities operationId: GET-api-TaskPriority produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/task_priority' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - TaskPriority summary: Creates a new task priority operationId: POST-api-TaskPriority produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/task_priority' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/task_priority' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/task_priority' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/TaskStatus({id}): get: tags: - TaskStatus summary: Retrieves the task status with the specified key operationId: GET-api-TaskStatus(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/task_status' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - TaskStatus summary: Updates the task status with the specified key operationId: PUT-api-TaskStatus(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/task_status' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/task_status' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - TaskStatus summary: Deletes the task status with the specified key operationId: DELETE-api-TaskStatus(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/TaskStatus: get: tags: - TaskStatus summary: Retrieves all task status operationId: GET-api-TaskStatus produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/task_status' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - TaskStatus summary: Creates a new task status operationId: POST-api-TaskStatus produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/task_status' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/task_status' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/task_status' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/TaskType({id}): get: tags: - TaskType summary: Retrieves the task type with the specified key operationId: GET-api-TaskType(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/task_type' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - TaskType summary: Updates the task type with the specified key operationId: PUT-api-TaskType(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/task_type' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/task_type' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - TaskType summary: Deletes the task type with the specified key operationId: DELETE-api-TaskType(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/TaskType: get: tags: - TaskType summary: Retrieves all task types operationId: GET-api-TaskType produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/task_type' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - TaskType summary: Creates a new task type operationId: POST-api-TaskType produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/task_type' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/task_type' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/task_type' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/User({id}): get: tags: - User summary: Retrieves the user with the specified key operationId: GET-api-User(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - User summary: Updates the user with the specified key operationId: PUT-api-User(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/user' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/User/Me: get: tags: - User summary: Get method to return the login and domain of current authorization value. Fields returned are Domain and User operationId: GET-api-User-Me produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/User: get: tags: - User summary: Retrieves all users operationId: GET-api-User produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - User summary: Creates a new user operationId: POST-api-User produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/user' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/user' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/UserGroup({id}): get: tags: - UserGroup summary: Retrieves the user group with the specified key operationId: GET-api-UserGroup(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_group' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - UserGroup summary: Updates the user group with the specified key operationId: PUT-api-UserGroup(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/user_group' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_group' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/UserGroup: get: tags: - UserGroup summary: Retrieves all user group operationId: GET-api-UserGroup produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_group' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - UserGroup summary: Creates a new user group operationId: POST-api-UserGroup produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/user_group' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_group' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/user_group' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/UserPlanningSlot({id}): get: tags: - UserPlanningSlot summary: Retrieves the user_planning_slot with the specified key operationId: GET-api-UserPlanningSlot(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_planning_slot' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - UserPlanningSlot summary: Updates the user_planning_slot with the specified key operationId: PUT-api-UserPlanningSlot(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/user_planning_slot' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_planning_slot' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - UserPlanningSlot summary: Deletes the user_planning_slot with the specified key operationId: DELETE-api-UserPlanningSlot(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/UserPlanningSlot: get: tags: - UserPlanningSlot summary: Retrieves all the user_planning_slot operationId: GET-api-UserPlanningSlot produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_planning_slot' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - UserPlanningSlot summary: Creates a new user_planning_slot operationId: POST-api-UserPlanningSlot produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/user_planning_slot' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_planning_slot' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/user_planning_slot' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/UserPlanningSlotType({id}): get: tags: - UserPlanningSlotType summary: Retrieves the user_planning_slot_type with the specified key operationId: GET-api-UserPlanningSlotType(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_planning_slot_type' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - UserPlanningSlotType summary: Updates the user_planning_slot_type with the specified key operationId: PUT-api-UserPlanningSlotType(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/user_planning_slot_type' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_planning_slot_type' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - UserPlanningSlotType summary: Deletes the user_planning_slot_type with the specified key operationId: DELETE-api-UserPlanningSlotType(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/UserPlanningSlotType: get: tags: - UserPlanningSlotType summary: Retrieves all the user_planning_slot_type operationId: GET-api-UserPlanningSlotType produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_planning_slot_type' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - UserPlanningSlotType summary: Creates a new user_planning_slot_type operationId: POST-api-UserPlanningSlotType produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/user_planning_slot_type' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_planning_slot_type' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/user_planning_slot_type' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/UserSalesOrganizationList({id}): get: tags: - UserSalesOrganizationList summary: Retrieves the user_sales_organization_list object with the specified key operationId: GET-api-UserSalesOrganizationList(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_sales_organization_list' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - UserSalesOrganizationList summary: Updates the user_sales_organization_list object with the specified key operationId: PUT-api-UserSalesOrganizationList(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/user_sales_organization_list' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_sales_organization_list' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - UserSalesOrganizationList summary: Deletes the user_sales_organization_list object with the specified key operationId: DELETE-api-UserSalesOrganizationList(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/UserSalesOrganizationList: get: tags: - UserSalesOrganizationList summary: Retrieves all the user_sales_organization_list objects operationId: GET-api-UserSalesOrganizationList produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_sales_organization_list' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - UserSalesOrganizationList summary: Creates a new user_sales_organization_list object operationId: POST-api-UserSalesOrganizationList produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/user_sales_organization_list' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_sales_organization_list' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/user_sales_organization_list' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/UserSalesTerritoryList({id}): get: tags: - UserSalesTerritoryList summary: Retrieves the user_sales_territory_list object with the specified key operationId: GET-api-UserSalesTerritoryList(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_sales_territory_list' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - UserSalesTerritoryList summary: Updates the user_sales_territory_list object with the specified key operationId: PUT-api-UserSalesTerritoryList(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/user_sales_territory_list' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_sales_territory_list' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - UserSalesTerritoryList summary: Deletes the user_sales_territory_list object with the specified key operationId: DELETE-api-UserSalesTerritoryList(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/UserSalesTerritoryList: get: tags: - UserSalesTerritoryList summary: Retrieves all the user_sales_territory_list objects operationId: GET-api-UserSalesTerritoryList produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_sales_territory_list' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - UserSalesTerritoryList summary: Creates a new user_sales_territory_list object operationId: POST-api-UserSalesTerritoryList produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/user_sales_territory_list' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_sales_territory_list' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/user_sales_territory_list' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/UserSkillList({id}): get: tags: - UserSkillList summary: Retrieves the user_skill_list object with the specified key operationId: GET-api-UserSkillList(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_skill_list' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - UserSkillList summary: Updates the user_skill_list object with the specified key operationId: PUT-api-UserSkillList(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/user_skill_list' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_skill_list' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - UserSkillList summary: Deletes the user_skill_list object with the specified key operationId: DELETE-api-UserSkillList(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/UserSkillList: get: tags: - UserSkillList summary: Retrieves all the user_skill_list objects operationId: GET-api-UserSkillList produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_skill_list' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - UserSkillList summary: Creates a new user_skill_list object operationId: POST-api-UserSkillList produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/user_skill_list' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_skill_list' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/user_skill_list' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/UserTimesheet({id}): get: tags: - UserTimesheet summary: Retrieves a user timesheet with the specified key operationId: GET-api-UserTimesheet(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_timesheet' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/UserTimesheet: get: tags: - UserTimesheet summary: No description operationId: GET-api-UserTimesheet produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_timesheet' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/UserUnavailability({id}): get: tags: - UserUnavailability summary: Retrieves the unavailability with the specified key operationId: GET-api-UserUnavailability(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_unavailability' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - UserUnavailability summary: Updates the unavailability with the specified key operationId: PUT-api-UserUnavailability(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/user_unavailability' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_unavailability' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - UserUnavailability summary: Deletes the unavailability with the specified key operationId: DELETE-api-UserUnavailability(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/UserUnavailability: get: tags: - UserUnavailability summary: Retrieves all unavailabilities operationId: GET-api-UserUnavailability produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_unavailability' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - UserUnavailability summary: Creates a new unavailability operationId: POST-api-UserUnavailability produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/user_unavailability' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_unavailability' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/user_unavailability' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/UserUnavailabilityType({id}): get: tags: - UserUnavailabilityType summary: Retrieves the unavailability type with the specified key operationId: GET-api-UserUnavailabilityType(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_unavailability_type' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - UserUnavailabilityType summary: Updates the unavailability type with the specified key operationId: PUT-api-UserUnavailabilityType(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/user_unavailability_type' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_unavailability_type' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred delete: tags: - UserUnavailabilityType summary: Deletes the unavailability type with the specified key operationId: DELETE-api-UserUnavailabilityType(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 204: description: Request has been successfully processed and that the response is intentionally blank 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/UserUnavailabilityType: get: tags: - UserUnavailabilityType summary: Retrieves all unavailability types operationId: GET-api-UserUnavailabilityType produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_unavailability_type' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - UserUnavailabilityType summary: Creates a new unavailability type operationId: POST-api-UserUnavailabilityType produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/user_unavailability_type' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_unavailability_type' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/user_unavailability_type' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/UserWeekApproval({id}): get: tags: - UserWeekApproval summary: Retrieves a user week approval with the specified key operationId: GET-api-UserWeekApproval(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_week_approval' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/UserWeekApproval: get: tags: - UserWeekApproval summary: Retrieves all the user week approval operationId: GET-api-UserWeekApproval produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/user_week_approval' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred /api/WorkInstruction({id}): get: tags: - WorkInstruction summary: Retrieves the work instruction with the specified key. operationId: GET-api-WorkInstruction(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/work_instruction' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - WorkInstruction summary: Updates the work instruction with the specified key operationId: PUT-api-WorkInstruction(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/work_instruction' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/work_instruction' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/WorkInstructionActionType({id}): get: tags: - WorkInstructionActionType summary: Retrieves the work instraction action type with the specified key operationId: GET-api-WorkInstructionActionType(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/work_instruction_action_type' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - WorkInstructionActionType summary: Updates the work instruction action type with the specified key operationId: PUT-api-WorkInstructionActionType(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/work_instruction_action_type' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/work_instruction_action_type' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/WorkInstructionActionType: get: tags: - WorkInstructionActionType summary: Retrieves all work instruction action types operationId: GET-api-WorkInstructionActionType produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/work_instruction_action_type' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - WorkInstructionActionType summary: Creates a new work instruction action type operationId: POST-api-WorkInstructionActionType produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/work_instruction_action_type' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/work_instruction_action_type' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/work_instruction_action_type' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/WorkInstruction: get: tags: - WorkInstruction summary: Retrieves all the work instructions. operationId: GET-api-WorkInstruction produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/work_instruction' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - WorkInstruction summary: Creates a new work instruction. operationId: POST-api-WorkInstruction produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/work_instruction' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/work_instruction' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/work_instruction' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/WorkInstructionDetails({id}): get: tags: - WorkInstructionDetails summary: Retrieves the work instruction details with the specified key. operationId: GET-api-WorkInstructionDetails(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/work_instruction_details' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred put: tags: - WorkInstructionDetails summary: Updates the work instruction details with the specified key operationId: PUT-api-WorkInstructionDetails(id) produces: - application/json - application/xml parameters: - name: id in: path required: true type: string format: guid - in: body name: body required: true schema: $ref: '#/definitions/work_instruction_details' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/work_instruction_details' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred /api/WorkInstructionDetails: get: tags: - WorkInstructionDetails summary: Retrieves all the work instructions details. operationId: GET-api-WorkInstructionDetails produces: - application/json - application/xml parameters: - name: $top in: query description: Top record required: false type: integer - name: $select in: query description: Select column for the output required: false type: string - name: $skip in: query description: Skip record from top required: false type: integer - name: $filter in: query description: Filter APIs required: false type: string - name: $orderby in: query description: System query option specifies the order in which items are returned from APIs required: false type: string responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/work_instruction_details' 400: description: The entity you passed has missing or invalid field values (you can see the validation exception in the http response) 401: description: you did not include your credentials or you are not allowed to views the requested resources 404: description: Either you forgot to indicate the version or you have entered an incorrect url 500: description: While processing your request some unknown error occurred post: tags: - WorkInstructionDetails summary: Creates a new work instruction details. operationId: POST-api-WorkInstructionDetails produces: - application/json - application/xml parameters: - in: body name: body required: true schema: $ref: '#/definitions/work_instruction_details' responses: 200: description: Your request was processed successfully schema: $ref: '#/definitions/work_instruction_details' 201: description: Your request resulted in a new resource created schema: $ref: '#/definitions/work_instruction_details' 401: description: you did not include your credentials or you are not allowed to views the requested resources 409: description: The request could not be completed due to a conflict with the current state of the resource 500: description: While processing your request some unknown error occurred definitions: api_log: type: object properties: id: type: string format: guid description: 'Primary key' date_create_utc: type: string format: date-time description: 'Creation date of the log, in UTC format' api_version: type: string description: 'Api version Max length: 50' api_type: type: string description: 'Api type, Automatically filled by "ODSAPI" Max length: 50' http_method: type: string description: 'Request Http Method (like GET,POST,PUT,DELETE) Max length: 50' url: type: string description: 'Full Request Url (including the ODATA Query String) Max length: 4000' user_username: type: string description: 'Username of the request (based on the request.Headers Authorization tag) Max length: 255' request_headers: type: string description: 'Headers of the request (but without the key "Authorization") Max length: 4000' request_body: type: string description: 'Body of the request as it has been sent by the Client' request_controller: type: string description: 'Requested Controller, like Company, Article, ... Max length: 255' request_ip: type: string description: 'IP Address of the client that send the request Max length: 255' response_code: type: integer format: int32 description: 'HTTP Response Code returned by the API' response_headers: type: string description: 'Response Headers returned by the API Max length: 4000' response_body: type: string description: 'Response Body returned by the API' time_needed: type: integer format: int32 description: 'Time Needed in milliseconds' is_error: type: boolean description: 'Is Error' article: type: object required: - id - name properties: id: type: string format: guid description: 'Primary Key' article_category_id: type: string format: guid description: 'Foreign key to article category' article_category: $ref: '#/definitions/article_category' article_category_code: type: string description: 'Embedded entity "article_category" using ERP PK when adding/updating article' article_group_1_id: type: string format: guid description: 'Foreign key to article_group_1' article_group_1_code: type: string description: 'Embedded entity "article_group_1" using ERP PK when adding/updating article' article_group_1: $ref: '#/definitions/article_group_1' article_group_2_id: type: string format: guid description: 'Foreign key to article_group_2' article_group_2_code: type: string description: 'Embedded entity "article_group_2" using ERP PK when adding/updating article' article_group_2: $ref: '#/definitions/article_group_2' article_group_3_id: type: string format: guid description: 'Foreign key to article_group_3' article_group_3_code: type: string description: 'Embedded entity "article_group_3" using ERP PK when adding/updating article' article_group_3: $ref: '#/definitions/article_group_3' article_group_4_id: type: string format: guid description: 'Foreign key to article_group_4' article_group_4_code: type: string description: 'Embedded entity "article_group_4" using ERP PK when adding/updating article' article_group_4: $ref: '#/definitions/article_group_4' article_group_5_id: type: string format: guid description: 'Foreign key to article_group_5' article_group_5_code: type: string description: 'Embedded entity "article_group_5" using ERP PK when adding/updating article' article_group_5: $ref: '#/definitions/article_group_5' article_group_6_id: type: string format: guid description: 'Foreign key to article_group_6' article_group_6_code: type: string description: 'Embedded entity "article_group_6" using ERP PK when adding/updating article' article_group_6: $ref: '#/definitions/article_group_6' physical_stock: type: integer format: int32 description: 'Physical stock from the ERP (used for Eco Stock)' back_order_client: type: integer format: int32 description: 'Number of pieces reserved for clients (used for Eco Stock)' back_order_supplier: type: integer format: int32 description: 'Number of pieces that should arrive from the supplier (used for Eco stock if expected delivery is in the past)' expected_delivery_date_bo_supplier: type: string format: date-time description: 'Date when the delivery from the supplier should arrive (used for Eco stock)' article_increment: type: integer format: int32 description: 'For Sales : Increment used to order (by 2, by 4 etc)' min_article_quantity: type: integer format: int32 description: 'For Sales : Minimum amount to be ordered' entered_price: type: number format: decimal description: 'Standard article price' cost_price: type: number format: single no_stock: type: boolean description: 'For Sales : Disables the stock check' archived: type: boolean description: 'Archives an article (cannot be deleted)' is_travel_fee: type: boolean description: 'Indicate that this article will be used to compute the fee based on the car travel time' is_mileage_fee: type: boolean description: 'Indicate that this article will be used to compute the fee based on the distance.' code: type: string description: 'The Id/Ref of the back office. Used by Embedded entity Max length: 50' name: type: string description: 'Name of the article Max length: 50' description_short: type: string description: 'Description (if exists, otherwhise name will be used) Max length: 100' description_long: type: string description: 'Long description' barcode: type: string description: 'Barcode of the article (fast search) Max length: 50' notes: type: string description: 'Notes (remark, details) Max length: 255' date_create: type: string format: date-time description: 'Creation date, auto filled by Now if no value received' date_update: type: string format: date-time description: 'Update date, auto filled by Now if no value received' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' article_color_id: type: string format: guid description: 'Foreign key to article_color' article_color_code: type: string description: 'Embedded entity "article_color" using ERP PK when adding/updating article' article_color: $ref: '#/definitions/article_color' warranty_period_nb_months: type: integer format: int32 description: 'warranty_period_nb_months' use_serial: type: boolean description: 'use_serial' _replace_id: type: string format: guid description: 'Foreign key to article that replace the current article' replace_article: $ref: '#/definitions/article' replace_article_code: type: string description: 'Embedded code "article" of replace, when adding/updating article' db_unit_of_measure_id_selling: type: string format: guid description: 'Applicable db_unit_of_measure' db_unit_of_measure_code_selling: type: string description: 'Applicable db_unit_of_measure' translations: type: list`1 format: list`1 description: 'List of translation of specific field name' article_category: type: object required: - id - name properties: id: type: string format: guid description: 'Primary Key' parent_id: type: string format: guid description: 'Parent Article Category (Parent / Child)' parent_code: type: string description: 'Embedded entity "article_category" for parent using ERP PK when adding/updating article_category' parent_article_category: $ref: '#/definitions/article_category' code: type: string description: 'Field used for Embedded entity (store there your ERP PK) Max length: 50' name: type: string description: 'Name of the article category Max length: 50' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by the database, filled with GetUtcDate when adding,updating' article_color: type: object required: - name properties: id: type: string format: guid description: 'Primary Key' name: type: string code: type: string modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' article_group_1: type: object required: - name properties: id: type: string format: guid description: 'Primary Key' name: type: string description: 'Name of the Group item Max length: 255' code: type: string description: 'Field used for Embedded entity (store there your ERP PK) Max length: 255' article_group_2: type: object required: - name properties: id: type: string format: guid description: 'Primary Key' name: type: string description: 'Name of the Group item Max length: 255' code: type: string description: 'Field used for Embedded entity (store there your ERP PK) Max length: 255' article_group_3: type: object required: - name properties: id: type: string format: guid description: 'Primary Key' name: type: string description: 'Name of the Group item Max length: 255' code: type: string description: 'Field used for Embedded entity (store there your ERP PK) Max length: 255' article_group_4: type: object required: - name properties: id: type: string format: guid description: 'Primary Key' name: type: string description: 'Name of the Group item Max length: 255' code: type: string description: 'Field used for Embedded entity (store there your ERP PK) Max length: 255' article_group_5: type: object required: - name properties: id: type: string format: guid description: 'Primary Key' name: type: string description: 'Name of the Group item Max length: 255' code: type: string description: 'Field used for Embedded entity (store there your ERP PK) Max length: 255' article_group_6: type: object required: - name properties: id: type: string format: guid description: 'Primary Key' name: type: string description: 'Name of the Group item Max length: 255' code: type: string description: 'Field used for Embedded entity (store there your ERP PK) Max length: 255' article_price_label: type: object required: - id - name properties: id: type: string format: guid description: 'Primary Key' name: type: string description: 'Name of article price label' code: type: string description: 'Code of article price label' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' db_currency_id: type: string format: guid description: 'FK of db_currency' db_currency_code: type: string description: 'Currency code using for adding/updating currency' article_price_list: type: object required: - id - price properties: id: type: string format: guid description: 'Primary Key' article_id: type: string format: guid description: 'Foreign key of article Optionally required : article_id, article_code or article must be provided' article_code: type: string description: 'Embedded entity "article" using ERP PK when adding/updating Optionally required : article_id, article_code or article must be provided' article: $ref: '#/definitions/article' article_price_label_id: type: string format: guid description: 'Foreign key of article price label Optionally required : article_price_label_id or article_price_label must be provided' article_price_label: $ref: '#/definitions/article_price_label' price: type: number format: decimal description: 'Article price, If value not given set as 0.' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' article_status_list: type: object required: - article_status_id - sales_organization_id properties: id: type: string format: guid description: 'Primary Key' article_status_id: type: string format: guid description: 'Foreign key of the article_status' article_id: type: string format: guid description: 'Foreign key of article Optionally required : article_id, article_code or article must be provided' article_code: type: string description: 'Embedded entity "article" using ERP PK when adding/updating Optionally required : article_id, article_code or article must be provided' article: $ref: '#/definitions/article' sales_organization_id: type: string format: guid modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' article_stock_location: type: object required: - name properties: id: type: string format: guid description: 'Primary Key' name: type: string description: 'Name of the article stock location Max length: 64' sequence: type: integer format: int32 description: 'Sorting field (0 first), to order them' city: type: string description: 'Address:City Max length: 50' street: type: string description: 'Address:Street Max length: 50' street2: type: string description: 'Address:Street2 Max length: 50' street_number: type: string description: 'Address:Street Number. If your ERP doesn"t have this field, then only use field "street" and disable the street number on Odyssee/Admin/Impl Settings/Global Settings:Hide Street Number Max length: 50' zip: type: string description: 'Address:Zip Max length: 50' db_country_id: type: string format: guid description: 'Address:Country' db_country_code: type: string description: 'Address:CountryCode entity using international code when adding/updating article_stock_location' reference_back_office: type: string description: 'Field used for Embedded entity (store there your ERP PK) Max length: 255' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' linked_db_table_id: type: string format: guid description: 'Foreign key to the table that is linked to this stock (like car or company) using Guid' linked_db_table_name: type: string description: 'Foreign key to the table that is linked to this stock (Allowed is car or company) using table name' linked_car_id: type: string format: guid description: 'Foreign key to the object id that is linked to this stock (car.id) using Guid' linked_car_reference_back_office: type: string description: 'Embedded entity "car" (when the linked object is a car) using ERP PK when adding/updating article_stock_locatioon' linked_car: $ref: '#/definitions/car' linked_company_id: type: string format: guid description: 'Foreign key to the object id that is linked to this stock (company.id) using Guid' linked_company_code: type: string description: 'Embedded entity "company" (when the linked object is a company) using ERP PK when adding/updating article_stock_locatioon' linked_company: $ref: '#/definitions/company' article_stock_location_list: type: object required: - quantity properties: id: type: string format: guid description: 'Primary Key' article_stock_location_id: type: string format: guid description: 'Foreign key of the article_stock_location Optionally required : article_stock_location_id, article_stock_location_reference_back_office or article_stock_location must be provided' article_stock_location_reference_back_office: type: string description: ' Optionally required : article_stock_location_id, article_stock_location_reference_back_office or article_stock_location must be provided' article_stock_location: $ref: '#/definitions/article_stock_location' article_id: type: string format: guid description: 'Foreign key of article Optionally required : article_id, article_code or article must be provided' article_code: type: string description: 'Embedded entity "article" using ERP PK when adding/updating Optionally required : article_id, article_code or article must be provided' article: $ref: '#/definitions/article' quantity: type: integer format: int32 description: 'Quantity in stock for this article, for this stock' reference_back_office: type: string description: 'Field used for Embedded entity (store there your ERP PK) Max length: 255' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' car: type: object required: - name properties: id: type: string format: guid description: 'Primary Key' name: type: string description: 'Name of the car Max length: 64' licence_plate: type: string description: 'Licence Plate Of the car' initial_km: type: integer format: int32 description: 'Actual KM value of the car before starting to add car travel on odyssee' reference_back_office: type: string description: 'Field used for Embedded entity (store there your ERP PK) Max length: 255' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' car_travel: type: object required: - user_id - car_id - hour_type_id - date_from_rounded - date_to_rounded - to_travel_type_code properties: id: type: string format: guid description: 'Primary Key' user_id: type: string format: guid description: 'Foreign key of User' car_id: type: string format: guid description: 'Foreign key of Car' hour_type_id: type: string format: guid description: 'Foreign key of the hour type' date_from_rounded: type: string format: date-time description: 'Date+Time travel FROM' date_to_rounded: type: string format: date-time description: 'Date+Time travel TO' notes: type: string description: 'Additional notes field' to_travel_type_code: type: string description: 'Kind of travel. Can be' is_approved: type: boolean description: 'Inform if this user_timesheet belongs to a week approved (readonly)' property_1_checked: type: boolean description: 'True/False status of property 1' property_2_checked: type: boolean description: 'True/False status of property 2' property_3_checked: type: boolean description: 'True/False status of property 3' property_4_checked: type: boolean description: 'True/False status of property 4' property_5_checked: type: boolean description: 'True/False status of property 5' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' km_distance: type: integer format: int32 description: 'Distance traveled' km_private: type: integer format: int32 description: 'Personal distance traveled' from_travel_type_code: type: string description: 'Travel type when going to location' from_db_table_name: type: string description: 'Value of linked table' from_id_in_table: type: string format: guid description: 'Foreign key to object traveling from' to_db_table_name: type: string description: 'Value of linked table' to_id_in_table: type: string format: guid description: 'Foreign key to object traveling from' company: type: object required: - id - name properties: id: type: string format: guid description: 'Primary Key' is_client: type: boolean description: 'SALES : Indicate if can be used for ordering' is_supplier: type: boolean description: 'SERVICES : indicate if this company is a supplier' archived: type: boolean description: 'Archive this company to not have it anymore on the search' name: type: string description: ' Max length: 64' notes: type: string description: 'Notes/Remark field' create_date: type: string format: date-time description: 'Creation date+time' sales_territory_id: type: string format: guid description: 'Territory of the company (Sales+Services).If more than one sales_territory exists, then it must be filled' sales_territory_code: type: string description: 'Embedded entity "sales_territory" using ERP PK when adding/updating company' sales_territory: $ref: '#/definitions/sales_territory' marketing_segment_id: type: string format: guid description: 'Marketing Segment of the company (Sales (Visit frequency logic) +Services (Planning Jobs To Be Planned) )' marketing_segment_code: type: string description: 'Embedded entity "marketing_segment" using ERP PK when adding/updating company' marketing_segment: $ref: '#/definitions/marketing_segment' sales_organization_id: type: string format: guid description: 'Organization on which belongs the company.If more than one sales_organization exists, then it must be filled' sales_organization_code: type: string description: 'Embedded entity "sales_organization" using ERP PK when adding/updating company' sales_organization: $ref: '#/definitions/sales_organization' company_sales_status_code: type: string description: 'Foreign key of company_sales_status using code. Use "Normal,CreditRisk, BlockedbyCM or OrderBlocked"' vat_reg_code: type: string description: 'VAT number Max length: 50' is_working_address: type: boolean description: 'Services : If False, you cannot create project/installation on this company.Default=true' parent_id: type: string format: guid description: 'Reference to a parent company (in case of Child/Parent) when adding/updating company' parent_company_code: type: string description: 'Embedded entity "company" for parent (in case of Child/Parent) using ERP PK when adding/updating company' parent_company: $ref: '#/definitions/company' phone: type: string description: 'Phone number of the company Max length: 50' fax: type: string description: 'Fax number of the company Max length: 50' url: type: string description: 'URL of the company website Max length: 255' email: type: string description: 'email Max length: 250' street: type: string description: 'Address:Street Max length: 100' street_number: type: string description: 'Address:Street Number. If your ERP doesn"t have this field, then only use field "street" and disable the street number on Odyssee/Admin/Impl Settings/Global Settings:Hide Street Number Max length: 50' city: type: string description: 'Address:City Max length: 50' zip: type: string description: 'Address:Zip Max length: 50' db_country_id: type: string format: guid description: 'Address:Country' db_country_code: type: string description: 'Address:CountryCode entity using international code when adding/updating company' feelist_id: type: string format: guid description: 'FeeList activated for the company (On Service, Feelist determines the price of the invoicable timesheets)' feelist_reference_back_office: type: string description: 'Embedded entity "feelist" using ERP PK when adding/updating company' feelist: $ref: '#/definitions/feelist' company_type_id: type: string format: guid description: 'Company Type' company_type_name: type: string description: 'Embedded entity "company_type" using ERP PK when adding/updating company' company_type: $ref: '#/definitions/company_type' db_language_id: type: string format: guid description: 'Language of the company.If empty, will use the default on the system' db_language_code: type: string description: 'Language code entity using international isocode when adding/updating company' code: type: string description: 'Field used for Embedded entity (store there your ERP PK) Max length: 50' article_price_label_id: type: string format: guid description: 'Foreign key of article price label' article_price_label_code: type: string description: 'Embedded entity "article price label" using ERP PK when adding/updating' article_price_label: $ref: '#/definitions/article_price_label' db_payment_method_id: type: string format: guid description: 'Embedded entity "db payment methods" using ERP PK when adding/updating company' db_payment_method_reference_back_office: type: string description: 'Embedded entity "db payment methods" using ERP PK when adding/updating company' db_payment_methods: $ref: '#/definitions/db_payment_methods' company_sector_id: type: string format: guid description: 'Foreign key to company_sector' company_sector_code: type: string description: 'Embedded code for the company_sector using ERP PK when adding/updating' company_sector: $ref: '#/definitions/company_sector' is_lead: type: boolean description: 'Indicate that company is not already a customer' is_subcontractor: type: boolean description: 'For Service, that company is one of your subcontractors' latitude: type: number format: decimal description: 'Decimal coordonate for the latitude. (-1;-1) means invalid and (0;0) means not already geo-encoded' longitude: type: number format: decimal description: 'Decimal coordonate for the longitude. (-1;-1) means invalid and (0;0) means not already geo-encoded' street2: type: string description: 'Additional information on the address not part of the postal address' bic_code: type: string description: 'bic code' specialities: type: string description: 'specialities' register_number: type: string description: 'register_number' register_city: type: string description: 'register_city' bankaccount: type: string description: 'Bank account of the company.' mobile: type: string description: 'Mobile number of the company Max length: 50' service_manager_user_id: type: string format: guid description: 'ID of the service manager. Auto selected user when creating location, installation. Used also inside communication and tags' service_manager_user_code: type: string description: 'Embedded code of the service manager. Auto selected user when creating location, installation. Used also inside communication and tags' service_manager_user: $ref: '#/definitions/user' finance_manager_user_id: type: string format: guid description: 'ID of the finance manager. Only used inside communication and tags' finance_manager_user_code: type: string description: 'Embedded code of the finance manager. Only used inside communication and tags' finance_manager_user: $ref: '#/definitions/user' account_manager_user_id: type: string format: guid description: 'ID of the account manager. Only used inside communication and tags' account_manager_user_code: type: string description: 'Embedded code of the account manager. Only used inside communication and tags' account_manager_user: $ref: '#/definitions/user' company_status_id: type: string format: guid description: 'Company Status' invoice_email_to: type: string description: 'Email to send invoice' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' id2: type: integer format: int32 description: 'Internal ID (numeric)' company_contact: type: object required: - id properties: id: type: string format: guid description: 'Primary key' contact_id: type: string format: guid description: 'Company of the contact Optionally required : contact_id must be provided' company_id: type: string format: guid description: 'Company of the contact Optionally required : company_id must be provided' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' company_sales_territory_list: type: object properties: id: type: string format: guid description: 'Primary Key' company_id: type: string format: guid description: 'Foreign key to company Optionally required : company_id, company_code or company must be provided' company_code: type: string description: 'Embedded entity "company" using ERP PK when adding/updating company_sales_territory_list Optionally required : company_id, company_code or company must be provided' company: $ref: '#/definitions/company' sales_territory_id: type: string format: guid description: 'Foreign key to sales_territory Optionally required : sales_territory_id, sales_territory_code or sales_territory must be provided' sales_territory_code: type: string description: 'Embedded entity "sales_territory" using ERP PK when adding/updating company_sales_territory_list Optionally required : sales_territory_id, sales_territory_code or sales_territory must be provided' sales_territory: $ref: '#/definitions/sales_territory' reference_back_office: type: string description: 'Field used for Embedded entity (store there your ERP PK) Max length: 50' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' company_sector: type: object required: - id - name properties: id: type: string format: guid description: 'Primary Key' parent_id: type: string format: guid description: 'Key of parent company_sector' code: type: string description: 'Field used for embedded entity, to be used for key from external system Max length: 50' name: type: string description: 'Name of the company sector Max length: 50' company_type: type: object required: - name properties: id: type: string format: guid description: 'Primary key' name: type: string description: 'Name of the type' description: type: string description: 'Description of the type' sales_organization_id: type: string format: guid description: 'FK of sales_organization. Filled if specific of one SO, empty if can be used by all' sales_organization_code: type: string description: 'Embedded entity "sales_organization" using ERP PK when adding/updating company_type' sales_organization: $ref: '#/definitions/sales_organization' contact: type: object required: - id - lastname properties: id: type: string format: guid description: 'Primary key' firstname: type: string description: 'Firstname of the contact Max length: 50' lastname: type: string description: 'Lastname of the contact. If you have one single field available for firstname+lastname then use Lastname Max length: 50' company_id: type: string format: guid description: 'Company of the contact Optionally required : company_id,company_code or company must be provided' company_code: type: string description: 'Embedded entity "company" using ERP PK when adding/updating contact Optionally required : company_id,company_code or company must be provided' company: $ref: '#/definitions/company' db_language_id: type: string format: guid description: 'Language of the contact.If empty, will use the default on the system' db_language_code: type: string description: 'Language code entity using international isocode when adding/updating contact' db_title_id: type: string format: guid description: 'The title of the contact' archived: type: boolean description: 'Archive this contact to not have it anymore on the search' functions: type: string description: 'Function of the contact (ServiceManager,...) Max length: 64' e_login: type: string description: 'Login of the contact (if have access to ServiceDesk) Max length: 50' e_password: type: string description: 'Password in clear text of the contact (if have access to ServiceDesk) Max length: 50' notes: type: string description: 'Notes/Remark field' birthdate: type: string format: date-time description: 'Birthday date' create_date: type: string format: date-time description: 'Creation date+time' phone: type: string description: 'Phone number of the contact Max length: 50' mobile: type: string description: 'a number of the contact Max length: 50' email: type: string description: 'email Max length: 250' skype: type: string description: 'skype Max length: 250' private_phone: type: string description: 'Private phone number of the contact Max length: 50' private_mobile: type: string description: 'Private mobile number of the contact Max length: 50' private_email: type: string description: 'Private email Max length: 250' reference_back_office: type: string description: 'Field used for Embedded entity (store there your ERP PK) Max length: 50' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' contract: type: object required: - id - id2 properties: id: type: string format: guid description: 'Primary key' id2: type: integer format: int32 description: 'id2' company_id: type: string format: guid description: 'The company owner of this contract Optionally required : company_id, company_code or company must be provided' company_code: type: string description: 'Embedded entity "company" using ERP PK when adding/updating contract Optionally required : company_id, company_code or company must be provided' company: $ref: '#/definitions/company' reference: type: string description: 'Reference' reference_back_office: type: string description: 'Backoffice reference' reference_customer: type: string description: 'Customer Reference' date_start: type: string format: date-time description: 'Start Date of the contract' date_end: type: string format: date-time description: 'Contract End date' date_cancel: type: string format: date-time description: 'Readonly , date +time when the contract goes in status Cancelled' date_last_invoiced: type: string format: date-time description: 'Readonly contains the last date an invoice has been generated for this contract' name: type: string description: 'Name of the contract' description: type: string description: 'Description of Contract' feelist_id: type: string format: guid description: 'Feelist ID' article_price_label_id: type: string format: guid description: 'Article Price Llabel Id' account_manager_user_id: type: string format: guid description: 'FK of Account manager user' account_manager_user: $ref: '#/definitions/user' account_manager_user_code: type: string description: 'Embedded entity "account_manager_user" using ERP PK when adding/updating account_manager_user' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' renewal_term_months: type: integer format: int32 description: 'Renewal Term Months Range: inclusive between 0 and 1000000' feelist_warranty_discount: type: number format: decimal description: 'Feelist Warranty Discount Range: inclusive between 0 and 100' price_label_warranty_discount: type: number format: decimal description: 'Price Label Warranty Discount Range: inclusive between 0 and 100' driving_distance: type: number format: decimal description: 'Distance in km that are used to invoice the travel' travel_fee_fix_discount: type: number format: decimal description: 'Discount applied when computing the fee for travel' db_address: type: object properties: id: type: string format: guid description: 'Primary key' company_id: type: string format: guid description: 'The company owner of this address Optionally required : company_id, company_code or company must be provided' company_code: type: string description: 'Embedded entity "company" using ERP PK when adding/updating address Optionally required : company_id, company_code or company must be provided' company: $ref: '#/definitions/company' db_address_type_id: type: string format: guid description: 'Foreign key to the db_address_type. Please use controller DbAddressType to find the correct it to use' code: type: string description: 'Field used for Embedded entity (store there your ERP PK)' archived: type: boolean description: 'You cannot delete an address. The only way is to archive it.' name: type: string description: 'Name of the address' street: type: string description: 'Street Max length: 100' street_number: type: string description: 'Street number. Can be not used Max length: 50' zip: type: string description: 'Zip code Max length: 50' city: type: string description: 'City Max length: 50' phone: type: string description: 'Phone number' mobile: type: string description: 'Cell phone number' fax: type: string description: 'Fax number' email: type: string description: 'Email address Max length: 250' url: type: string description: 'Url' db_country_id: type: string format: guid description: 'Foreign key to table Country' db_country_code: type: string description: 'CountryCode entity using international code when adding/updating company' street2: type: string description: 'Additional information on the address not part of the postal address Max length: 50' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' db_country: type: object properties: id: type: string format: guid description: 'Primary Key' code: type: string description: 'Code in 2 letters, following ISO 3166' country_name: type: string description: 'Name of the country' is_default: type: boolean default_db_language_id: type: string format: guid disabled: type: boolean default_language: $ref: '#/definitions/db_language' db_file: type: object required: - id - name properties: id: type: string format: guid description: 'Primary key' db_table_id: type: string format: guid description: 'Table.id of the linked entity' db_table_name: type: string description: 'Foreign key to the table of the linked entity using table name. Can be article,company,contact,jobs,job_approval,project or task.Will be also filled on Get to allow Odata Filter on it' id_in_table: type: string format: guid description: 'Id of the linked entity' name: type: string description: 'Name of the file Max length: 100' description: type: string description: 'Description of the file Max length: 4000' file_name: type: string description: 'File_name of the file Max length: 100' image_width: type: integer format: int32 description: 'In case of picture, the original width' image_heigth: type: integer format: int32 description: 'In case of picture, the original heigth' mime_type: type: string description: 'Mime-type of the file.Used when redirect user to the data, like application/pdf or image/jpeg Max length: 100' file_content: type: array items: type: string description: 'The file content, in Byte Array. Use this field when using POST/Put' db_file_folder_id: type: string format: guid description: 'For Global Files : Foreign key to db file folder' db_file_folder_reference_back_office: type: string description: 'Embedded entity "db_file_folder" using ERP PK when adding/updating db_file' db_file_folder: $ref: '#/definitions/db_file_folder' sales_organization_id: type: string format: guid description: 'In case of global files - you can specifiy if it is available for all organization or only one' sales_organization_code: type: string description: 'Embedded entity "sales_organization" using ERP PK when adding/updating db_file' sales_organization: $ref: '#/definitions/sales_organization' file_type_name: type: string description: 'Readonly :Constant in case of specific file. Can be JOB_APPROVAL, ORDERPDF, PURCHASE_ORDERPDF' file_size: type: integer format: int64 description: 'Size in bytes of the file_content' user_notification: type: boolean description: 'For Global files - indicate if user should be informed that this file is available' is_archived: type: boolean description: 'Indicate if the file has been deleted (content flushed)' date_add: type: string format: date-time description: 'Date when file has been added' date_update: type: string format: date-time description: 'Update date, auto filled by Now if no value received' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' db_file_folder: type: object required: - name properties: id: type: string format: guid description: 'Primary Key' parent_id: type: string format: guid description: 'Reference to a parent folder (in case of Child/Parent) when adding/updating folder' parent_reference_back_office: type: string description: 'Reference to a parent folder (in case of Child/Parent) when adding/updating folder' parent_db_file_folder: $ref: '#/definitions/db_file_folder' name: type: string description: ' Max length: 255' description: type: string description: 'Description of the folder Max length: 255' sequence: type: integer format: int32 description: 'Sorting field (0 first)' is_sales: type: boolean description: 'Indicate that this folder should be shown on the Sales environemnt (Company/Contact details)' is_services: type: boolean description: 'Indicate that this folder should be shown on the Services environemnt (Task/Project and Jobs details)' is_articles: type: boolean description: 'Indicate that this folder should be shown on the Article Details' reference_back_office: type: string description: ' Max length: 255' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' db_info: type: object required: - name - db_info_category_code properties: id: type: string format: guid description: 'Primary key' name: type: string description: 'Name of the db_info (Chapter name) Max length: 50' code: type: string description: 'The Id/Ref of the back office. Used by Embedded entity Max length: 50' sequence: type: integer format: int32 description: 'Sorting field (0 first), to order them' db_info_category_id: type: string format: guid description: 'Main Category this chapter belongs using real foreign keys. Needed to extract "DbReport" where the category is the db_report_type' db_info_category_code: type: string description: 'Specify on which main category this chapter should be shown. Possible values : Article,Company,Contact,Project,User,Jobs,Task,Opportunity,EquipmentFamily. Read more on API / HELP / Info Fields' parent_id: type: string format: guid description: 'Parent Db_info (chapter) (Parent / Child)' parent_db_info_code: type: string description: 'Embedded entity "db_info" for parent using ERP PK when adding/updating db_info' parent_db_info: $ref: '#/definitions/db_info' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' db_info_data: type: object required: - value properties: id: type: string format: guid description: 'Primary key' target_id: type: string format: guid description: 'Foreign key of the object using his Odyssee Guid Primary Key Optionally required : target_id or target_code must be provided' target_code: type: string description: 'Foreign key of the object using ERP PK when adding/updating db_info_data Optionally required : target_id or target_code must be provided' db_table_id: type: string format: guid description: 'Foreign key to the table that own the "target_id" (Example:article,company,project) using Guid Optionally required : db_table_id or db_table_name must be provided' db_table_name: type: string description: 'Foreign key to the table that own the "target_id" (Example:article,company,project) using table name Optionally required : db_table_id or db_table_name must be provided' db_info_field_id: type: string format: guid description: ' Optionally required : db_info_field_id, db_info_field_name or db_info_field must be provided' db_info_field_name: type: string description: ' Optionally required : db_info_field_id, db_info_field_name or db_info_field must be provided' db_info_field: $ref: '#/definitions/db_info_field' value: type: string description: 'The value of this info fields for this targetId. Follow the formating rules (API / HELP / Info Fields)' reference_back_office: type: string description: 'The Id/Ref of the back office for this object Max length: 50' sys_logical_delete: type: boolean description: 'sys_logical_delete' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' db_info_data_article: type: object required: - value properties: id: type: string format: guid description: 'Primary key' article_id: type: string format: guid description: 'Foreign key of the object using his Odyssee Guid Primary Key Optionally required : article_id or article_code must be provided' article_code: type: string description: 'Foreign key of the object using ERP PK when adding/updating db_info_data Optionally required : article_id or article_code must be provided' db_info_field_id: type: string format: guid description: ' Optionally required : db_info_field_id, db_info_field_name or db_info_field must be provided' db_info_field_name: type: string description: ' Optionally required : db_info_field_id, db_info_field_name or db_info_field must be provided' db_info_field: $ref: '#/definitions/db_info_field' value: type: string description: 'The value of this info fields for this targetId. Follow the formating rules (API / HELP / Info Fields)' reference_back_office: type: string description: 'The Id/Ref of the back office for this object Max length: 50' sys_logical_delete: type: boolean description: 'sys_logical_delete' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' db_info_data_company: type: object required: - value properties: id: type: string format: guid description: 'Primary key' company_id: type: string format: guid description: 'Foreign key of the object using his Odyssee Guid Primary Key Optionally required : company_id or company_code must be provided' company_code: type: string description: 'Foreign key of the object using ERP PK when adding/updating db_info_data Optionally required : company_id or company_code must be provided' db_info_field_id: type: string format: guid description: ' Optionally required : db_info_field_id, db_info_field_name or db_info_field must be provided' db_info_field_name: type: string description: ' Optionally required : db_info_field_id, db_info_field_name or db_info_field must be provided' db_info_field: $ref: '#/definitions/db_info_field' value: type: string description: 'The value of this info fields for this targetId. Follow the formating rules (API / HELP / Info Fields)' reference_back_office: type: string description: 'The Id/Ref of the back office for this object Max length: 50' sys_logical_delete: type: boolean description: 'sys_logical_delete' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' db_info_data_db_report: type: object required: - value properties: id: type: string format: guid description: 'Primary key' db_report_id: type: string format: guid description: 'Foreign key of the object using his Odyssee Guid Primary Key Optionally required : db_report_id or db_report_reference_back_office must be provided' db_report_reference_back_office: type: string description: 'Foreign key of the object using ERP PK when adding/updating db_info_data Optionally required : db_report_id or db_report_reference_back_office must be provided' db_info_field_id: type: string format: guid description: ' Optionally required : db_info_field_id, db_info_field_name or db_info_field must be provided' db_info_field_name: type: string description: ' Optionally required : db_info_field_id, db_info_field_name or db_info_field must be provided' db_info_field: $ref: '#/definitions/db_info_field' value: type: string description: 'The value of this info fields for this targetId. Follow the formating rules (API / HELP / Info Fields)' reference_back_office: type: string description: 'The Id/Ref of the back office for this object Max length: 50' sys_logical_delete: type: boolean description: 'sys_logical_delete' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' db_info_data_jobs: type: object required: - value properties: id: type: string format: guid description: 'Primary key' jobs_id: type: string format: guid description: 'Foreign key of the object using his Odyssee Guid Primary Key Optionally required : jobs_id or job_reference_back_office must be provided' job_reference_back_office: type: string description: 'Foreign key of the object using ERP PK when adding/updating db_info_data Optionally required : jobs_id or job_reference_back_office must be provided' db_info_field_id: type: string format: guid description: ' Optionally required : db_info_field_id, db_info_field_name or db_info_field must be provided' db_info_field_name: type: string description: ' Optionally required : db_info_field_id, db_info_field_name or db_info_field must be provided' db_info_field: $ref: '#/definitions/db_info_field' value: type: string description: 'The value of this info fields for this targetId. Follow the formating rules (API / HELP / Info Fields)' reference_back_office: type: string description: 'The Id/Ref of the back office for this object Max length: 50' sys_logical_delete: type: boolean description: 'sys_logical_delete' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' db_info_data_project: type: object required: - value properties: id: type: string format: guid description: 'Primary key' project_id: type: string format: guid description: 'Foreign key of the object using his Odyssee Guid Primary Key Optionally required : project_id or project_reference_back_office must be provided' project_reference_back_office: type: string description: 'Foreign key of the object using ERP PK when adding/updating db_info_data Optionally required : project_id or project_reference_back_office must be provided' db_info_field_id: type: string format: guid description: ' Optionally required : db_info_field_id, db_info_field_name or db_info_field must be provided' db_info_field_name: type: string description: ' Optionally required : db_info_field_id, db_info_field_name or db_info_field must be provided' db_info_field: $ref: '#/definitions/db_info_field' value: type: string description: 'The value of this info fields for this targetId. Follow the formating rules (API / HELP / Info Fields)' reference_back_office: type: string description: 'The Id/Ref of the back office for this object Max length: 50' sys_logical_delete: type: boolean description: 'sys_logical_delete' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' db_info_data_task: type: object required: - value properties: id: type: string format: guid description: 'Primary key' task_id: type: string format: guid description: 'Foreign key of the object using his Odyssee Guid Primary Key Optionally required : task_id or task_reference_back_office must be provided' task_reference_back_office: type: string description: 'Foreign key of the object using ERP PK when adding/updating db_info_data Optionally required : task_id or task_reference_back_office must be provided' db_info_field_id: type: string format: guid description: ' Optionally required : db_info_field_id, db_info_field_name or db_info_field must be provided' db_info_field_name: type: string description: ' Optionally required : db_info_field_id, db_info_field_name or db_info_field must be provided' db_info_field: $ref: '#/definitions/db_info_field' value: type: string description: 'The value of this info fields for this targetId. Follow the formating rules (API / HELP / Info Fields)' reference_back_office: type: string description: 'The Id/Ref of the back office for this object Max length: 50' sys_logical_delete: type: boolean description: 'sys_logical_delete' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' db_info_data_user: type: object required: - value properties: id: type: string format: guid description: 'Primary key' user_id: type: string format: guid description: 'Foreign key of the object using his Odyssee Guid Primary Key Optionally required : user_id or user_code must be provided' user_code: type: string description: 'Foreign key of the object using ERP PK when adding/updating db_info_data Optionally required : user_id or user_code must be provided' db_info_field_id: type: string format: guid description: ' Optionally required : db_info_field_id, db_info_field_name or db_info_field must be provided' db_info_field_name: type: string description: ' Optionally required : db_info_field_id, db_info_field_name or db_info_field must be provided' db_info_field: $ref: '#/definitions/db_info_field' value: type: string description: 'The value of this info fields for this targetId. Follow the formating rules (API / HELP / Info Fields)' reference_back_office: type: string description: 'The Id/Ref of the back office for this object Max length: 50' sys_logical_delete: type: boolean description: 'sys_logical_delete' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' db_info_field: type: object required: - name - title properties: id: type: string format: guid description: 'Primary key' db_info_id: type: string format: guid description: 'Foreign key to db_info (chapters) Optionally required : db_info_id,db_info_code or node db_info must be provided' db_info_code: type: string description: 'Embedded entity "db_info" using ERP PK when adding/updating db_info_field Optionally required : db_info_id ,db_info_code or node db_info must be provided' db_info: $ref: '#/definitions/db_info' db_input_type_id: type: string format: guid description: 'Type of the fied (like Textbox,TextArea) Optionally required : db_input_type_id or db_input_type_code must be provided' db_input_type_code: type: string description: 'Use of the possible type : TextBox,TextArea,SelectBox,RadioButton,DateTime,NumericField,Checkbox,ComboBox,Email,Url,DatePicker,MonthCalendar,TimePiker,Number Optionally required : db_input_type_id or db_input_type_code must be provided' name: type: string description: 'Name/Code of the info field.Field used for Embedded entity (store there your ERP PK) Max length: 50' title: type: string description: 'Title that will be shown on the UI of the info field Max length: 50' sequence: type: integer format: int32 description: 'Sorting field (0 first), to order them inside the chapter' description: type: string description: 'Description of the field Max length: 255' is_mandatory: type: boolean description: 'Force user to fill it before saving' is_readonly: type: boolean description: 'Avoid user to edit the value using the UI' hide_in_view_if_empty: type: boolean description: 'Hide this field in view mode if no value' db_info_field_property: type: object required: - name - value properties: id: type: string format: guid description: 'Primary key' db_info_field_id: type: string format: guid description: 'Foreign key to db_info_field Optionally required : db_info_field_id, db_info_field_name or db_info_field must be provided' db_info_field_name: type: string description: 'Embedded entity "db_info_field" using ERP PK when adding/updating db_info_field_property Optionally required : db_info_field_id, db_info_field_name or db_info_field must be provided' db_info_field: $ref: '#/definitions/db_info_field' name: type: string description: 'Item.DisplayText, value that will be shown on the UI Max length: 50' value: type: string description: 'Value of the db_info_property.Store there your ERP PK Max length: 50' sequence: type: integer format: int32 description: 'Sorting field (0 first), to order them' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' db_language: type: object properties: id: type: string format: guid description: 'Primary Key' code: type: string description: 'Code of the language, 2 letters, following ISO 639-1' name: type: string description: 'Name of the language' is_default: type: boolean description: 'Is the default language to be used when nothing set' disabled: type: boolean description: 'Disable the language to not have it on the interface' db_notes: type: object required: - id_in_table - notes properties: id: type: string format: guid description: 'Primary Key' db_table_id: type: string format: guid description: 'Table Id db notes linked to Optionally required : db_table_id or db_table_name must be provided' db_table_name: type: string description: 'Foreign key to the table this db_notes is linked to (Possibles values are company,jobs,project,task) using table name Optionally required : db_table_id or db_table_name must be provided' id_in_table: type: string format: guid description: 'Item id on the given table on which db note linked to' user_id: type: string format: guid description: 'Created User ID Optionally required : user_id, user_code or user must be provided' user_code: type: string description: 'Embedded entity "user" using ERP PK when adding/updating a db_notes Optionally required : user_id, user_code or user must be provided' user: $ref: '#/definitions/user' date_add: type: string format: date-time description: 'Date Added. is on the local user time.' dateutc_add: type: string format: date-time description: 'Date Added. Auto-filled by NOW if empty' notes: type: string description: 'Notes' reference_back_office: type: string description: ' Max length: 255' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' db_payment_methods: type: object required: - name properties: id: type: string format: guid description: 'Primary Key' name: type: string description: 'Name of the db payment method. Max length: 255' description: type: string description: 'Description of the db payment method. Max length: 4000' reference_back_office: type: string description: 'The Id/Ref of the back office for this db payment method. Used by Embedded entity. Max length: 50' activated: type: boolean description: 'If true db payment method is activated.' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' db_report: type: object required: - db_report_type_id properties: id: type: string format: guid description: 'Primary Key' db_report_type_id: type: string format: guid description: 'db report type id' user_id: type: string format: guid description: 'Created user id' company_id: type: string format: guid description: 'The Final company that own this report (If WO Report, the company that owns the installation/project) Optionally required : company_id,company_code or node company must be provided' company_code: type: string description: 'Embedded entity "company" using ERP PK when adding/updating db_report Optionally required : company_id, company_code or company must be provided' company: $ref: '#/definitions/company' db_table_name: type: string description: 'TableName which db report linked to. Possible value are jobs or meeting Optionally required : db_table_id or db_table_name must be provided' db_table_id: type: string format: guid description: 'Table ID which db report linked to. Optionally required : db_table_id or db_table_name must be provided' id_in_table: type: string format: guid description: 'Item id of the table which db report linked to' date_last_update: type: string format: date-time description: 'Date last updated' reference_back_office: type: string description: ' Max length: 255' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' email_notification: type: object required: - id properties: id: type: string format: guid description: 'Primary Key' db_table_id: type: string format: guid description: 'db_table_id' id_in_table: type: string format: guid description: 'id_in_table' date_sent: type: string format: date-time description: 'utc date time email sent.' type: type: string description: 'type, like CONTRACT_RENEW , IMPORT_DONE , JOB_APPROVAL , JOB_PLANNING , ORDER , PURCHASE_ORDER , TASK' subject: type: string description: 'subject of email' message: type: string description: 'email message in html format' email_notification_list: type: object required: - id properties: id: type: string format: guid description: 'Primary Key' email_notification_id: type: string format: guid description: 'email_notification_id' to_email_address: type: string description: 'email address of receiver.' to_display_name: type: string description: 'email display name' destination_type: type: string description: 'destination type like TO,CC or BCC.' equipment_brand: type: object required: - name properties: id: type: string format: guid description: 'Primary Key' name: type: string description: 'Name of the equipment brand Max length: 50' code: type: string description: 'The Id/Ref of the back office. Used by Embedded entity Max length: 50' sales_organization_id: type: string format: guid description: 'FK of sales_organization. Filled if specific of one SO, empty if can be used by all' sales_organization_code: type: string description: 'Embedded entity "sales_organization" using ERP PK when adding/updating company_type' sales_organization: $ref: '#/definitions/sales_organization' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' equipment_family: type: object required: - id - name properties: id: type: string format: guid description: 'Primary Key' name: type: string description: 'Name of the equipment family Max length: 50' description: type: string description: 'Description of the equipment family Max length: 4000' code: type: string description: 'The Id/Ref of the back office. Used by Embedded entity Max length: 50' _parent_id: type: string format: guid description: 'Parent Equipment Family (Parent / Child) when adding/updating equipment_family' _parent_code: type: string description: 'Embedded entity "equipment_family" for parent (Parent / Child) using ERP PK when adding/updating equipment_family' _parent_equipment_family: $ref: '#/definitions/equipment_family' sales_organization_id: type: string format: guid description: 'FK of sales_organization. Filled if specific of one SO, empty if can be used by all' sales_organization_code: type: string description: 'Embedded entity "sales_organization" using ERP PK when adding/updating company_type' sales_organization: $ref: '#/definitions/sales_organization' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' equipment_model: type: object required: - name properties: id: type: string format: guid description: 'Primary Key' code: type: string description: 'The Id/Ref of the back office. Used by Embedded entity Max length: 50' name: type: string description: 'Name of the equipment model Max length: 50' description: type: string description: 'Description of the equipment model' equipment_brand_id: type: string format: guid description: 'FK Of Equipment brand' equipment_brand_code: type: string description: 'Embedded entity "equipment_brand" using ERP PK when adding/updating equipment_model' equipment_brand: $ref: '#/definitions/equipment_brand' equipment_family_id: type: string format: guid description: 'FK Of equipment_family' equipment_family_code: type: string description: 'Embedded entity "equipment_family" using ERP PK when adding/updating equipment_model' equipment_family: $ref: '#/definitions/equipment_family' date_in_production_since: type: string format: date-time description: 'Date in production since' date_out_of_production_since: type: string format: date-time description: 'Date Out Of production since' date_end_support: type: string format: date-time description: 'Date end support' sales_organization_id: type: string format: guid description: 'FK of sales_organization. Filled if specific of one SO, empty if can be used by all' sales_organization_code: type: string description: 'Embedded entity "sales_organization" using ERP PK when adding/updating equipment_model' sales_organization: $ref: '#/definitions/sales_organization' replacement_period_nb_months: type: integer format: int32 description: 'replacement_period_nb_months' warranty_period_nb_months: type: integer format: int32 description: 'warranty_period_nb_months' translations: type: list`1 format: list`1 description: 'List of translation of specific field name' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' feelist: type: object required: - name - default_price properties: id: type: string format: guid description: 'Primary key' name: type: string description: 'Feelist Name Max length: 50' description: type: string description: 'Fee list description Max length: 255' is_default: type: boolean description: 'is default fee list' default_price: type: number format: decimal sales_organization_id: type: string format: guid description: 'FK of sales_organization. Filled if specific of one SO, empty if can be used by all' sales_organization_code: type: string description: 'Embedded entity "sales_organization" using ERP PK when adding/updating feelist' sales_organization: $ref: '#/definitions/sales_organization' reference_back_office: type: string description: 'Field used for Embedded entity (store there your ERP PK) Max length: 255' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' db_currency_id: type: string format: guid description: 'FK of db_currency' db_currency_code: type: string description: 'Currency code using for adding/updating currency' feelist_price: type: object required: - price properties: id: type: string format: guid description: 'Primary key' feelist_id: type: string format: guid description: 'Feelist on which this price belongs to Optionally required : feelist_id, feelist_reference_back_office or feelist must be provided' feelist_reference_back_office: type: string description: 'Embedded entity "feelist" using ERP PK when adding/updating feelist_price Optionally required : feelist_id, feelist_reference_back_office or feelist must be provided' feelist: $ref: '#/definitions/feelist' hour_type_id: type: string format: guid description: 'Foreign key to hour_type. You need to supply at one one of the following value : hour_type,equipment_family,job_type Optionally required : hour_type_id, hour_type_code or hour_type must be provided' hour_type_code: type: string description: 'Embedded entity "hour_type" using ERP PK when adding/updating feelist_price (CF hour_type_id) Optionally required : hour_type_id, hour_type_code or hour_type must be provided' hour_type: $ref: '#/definitions/hour_type' equipment_family_id: type: string format: guid description: 'Foreign key to equipment_family. You need to supply at one one of the following value : hour_type,equipment_family,job_type' equipment_family_code: type: string description: 'Embedded entity "equipment_family" using ERP PK when adding/updating feelist_price (CF equipment_family_id)' equipment_family: $ref: '#/definitions/equipment_family' job_type_id: type: string format: guid description: 'Foreign key to job_type. You need to supply at one one of the following value : hour_type,equipment_family,job_type' job_type_code: type: string description: 'Embedded entity "job_type_id" using ERP PK when adding/updating feelist_price (CF job_type_id)' job_type: $ref: '#/definitions/job_type' price: type: number format: decimal reference_back_office: type: string description: 'Field used for Embedded entity (store there your ERP PK) Max length: 255' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' hour_type: type: object required: - description properties: id: type: string format: guid description: 'Primary Key' code: type: string description: 'Code of Hour (will be used for job_non_part_usage.line_code). Field also used for Embedded entity (store there your ERP PK) Max length: 50' description: type: string description: 'Description of the hour type Max length: 255' archived: type: boolean description: 'Archive this hour_type to be sure no new user_timesheet/car_travel will be created with this hour_type' is_travel: type: boolean description: 'This hour_type is for travel' hour_type_group_id: type: string format: guid description: 'Foreign key to hour_type_group, to group hour_type together Optionally required : hour_type_group_id, hour_type_group_code or hour_type_group must be provided' hour_type_group_code: type: string description: 'Embedded entity "hour_type_group" using ERP PK when adding/updating hour_type Optionally required : hour_type_group_id, hour_type_group_code or hour_type_group must be provided' hour_type_group: $ref: '#/definitions/hour_type_group' property_1_is_enabled: type: boolean description: 'CF Properties of HourType.Enable or not for this hour_type the property 1' property_1_auto_checked: type: boolean description: 'User_timesheet+car_travel property_1_checked will be filled with this value' property_2_is_enabled: type: boolean description: 'CF Properties of HourType.Enable or not for this hour_type the property 2' property_2_auto_checked: type: boolean description: 'User_timesheet+car_travel property_2_checked will be filled with this value' property_3_is_enabled: type: boolean description: 'CF Properties of HourType.Enable or not for this hour_type the property 3' property_3_auto_checked: type: boolean description: 'User_timesheet+car_travel property_3_checked will be filled with this value' property_4_is_enabled: type: boolean description: 'CF Properties of HourType.Enable or not for this hour_type the property 4' property_4_auto_checked: type: boolean description: 'User_timesheet+car_travel property_4_checked will be filled with this value' property_5_is_enabled: type: boolean description: 'CF Properties of HourType.Enable or not for this hour_type the property 5' property_5_auto_checked: type: boolean description: 'User_timesheet+car_travel property_5_checked will be filled with this value' sales_organization_id: type: string format: guid description: 'FK of sales_organization. Filled if specific of one SO, empty if can be used by all' sales_organization_code: type: string description: 'Embedded entity "sales_organization" using ERP PK when adding/updating hour_type' sales_organization: $ref: '#/definitions/sales_organization' is_billing_hour: type: boolean description: 'Need to be TRUE if needed inside the Work Order Billable hours' is_other: type: boolean description: 'When the technician is not driving and not working' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' hour_type_group: type: object required: - name properties: id: type: string format: guid description: 'Primary Key' name: type: string description: 'Name of the hour type group Max length: 255' description: type: string description: 'Description of the hour type group Max length: 255' is_normal_hour: type: boolean description: 'Is normal hour (to sum the total working time (normal hour) by week by user).Default=true' code: type: string description: 'Code of the hour type group. Field used for Embedded entity (store there your ERP PK) Max length: 255' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' invoice: type: object required: - id properties: id: type: string format: guid description: 'Primary Key' internal_number: type: string description: 'Internal number to identify the invoice' company_id: type: string format: guid description: 'Foreign key to company, identifies the company of the invoice' company_code: type: string description: 'Company code of the invoice' company_name: type: string description: 'Company name of the invoice' date_create: type: string format: date-time description: 'Invoice creation date in utc' memo: type: string description: 'Memo field for invoice' description: type: string description: 'Decription field for invoice' invoice_type: type: string description: 'Invoice type, possible values “ContractGenerated“ and “WorkOrderApproval“' source_type: type: string description: 'Source of invoice, refers to the type of the object from which invoice is derived' source_id_in_table: type: string format: guid description: 'Key of the object from which the invoice is derived' total_lines: type: integer format: int32 description: 'Total amount of lines linked to the invoice' total_amount: type: number format: decimal description: 'Total value of items in lines linked to the invoice' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' invoice_details: type: object required: - id properties: id: type: string format: guid description: 'Primary Key' invoice_id: type: string format: guid description: 'Key of invoice to which this line belongs' article_id: type: string format: guid description: 'Key of article on this line' article_name: type: string description: 'Name of article on this line' article_description: type: string description: 'Description of article on this line' article_code: type: string description: 'Code of article on this line' line_num: type: integer format: int32 description: 'Number of this line within the invoice' quantity: type: integer format: int32 description: 'Quantity of article' article_price: type: number format: decimal description: 'Price of article' discount: type: number format: decimal description: 'Discount value (absolute) applied to this line' vat_rate: type: number format: decimal description: 'VAT ratio applied to this line' vat_value: type: number format: decimal description: 'Value (absolute) of VAT on this line' total_line: type: number format: decimal description: 'quantity*(article_price-discount+vat_value)' article_stock_location_id: type: string format: guid description: 'In case of stock management enabled, the stock that has been used' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' invoice_details_view: type: object properties: id: type: string format: guid description: 'Primary Key' invoice_id: type: string format: guid description: 'Key of invoice to which this line belongs' article_id: type: string format: guid description: 'Key of article on this line' article_name: type: string description: 'Name of article on this line' article_description: type: string description: 'Description of article on this line' article_code: type: string description: 'Code of article on this line' line_num: type: integer format: int32 description: 'Number of this line within the invoice' quantity_decimal: type: number format: decimal description: 'Quantity' article_price: type: number format: decimal description: 'Unit Price of article' discount: type: number format: decimal description: 'Unit Discount value (absolute) applied to this line' vat_rate: type: number format: decimal description: 'VAT ratio applied to this line' vat_value: type: number format: decimal description: 'Value (absolute) of VAT on this line' total_vat: type: number format: decimal description: 'vat_value * quantity_decimal' total_line: type: number format: decimal description: 'quantity*(article_price-discount)' total_line_with_vat: type: number format: decimal description: 'total_line + total_vat' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' invoice_view: type: object properties: id: type: string format: guid description: 'Primary Key' internal_number: type: string description: 'Internal number to identify the invoice' company_id: type: string format: guid description: 'Foreign key to company, identifies the company of the invoice' company_code: type: string description: 'Company code of the invoice' company_name: type: string description: 'Company name of the invoice' company_email: type: string description: 'Company email of the invoice' company_phone: type: string description: 'Company phone of the invoice' date_create: type: string format: date-time description: 'Invoice creation date in utc' memo: type: string description: 'Memo field for invoice' description: type: string description: 'Decription field for invoice' invoice_type: type: string description: 'Invoice type, possible values “ContractGenerated“ and “WorkOrderApproval“' source_type: type: string description: 'Source of invoice, refers to the type of the object from which invoice is derived' source_id_in_table: type: string format: guid description: 'Key of the object from which the invoice is derived' total_lines: type: integer format: int32 description: 'Total amount of lines linked to the invoice' total_amount: type: number format: decimal description: 'Total value of items in lines linked to the invoice' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' invoice_details: type: array items: type: string description: 'Details of invoice' job_approval: type: object required: - id - jobs_id - user_id properties: id: type: string format: guid description: 'Primary Key' jobs_id: type: string format: guid description: 'Foreign key of jobs' user_id: type: string format: guid description: 'Foreign key, user that makes the approval' ready_for_multi_approval: type: boolean description: 'Inform if this is a temp approval prepared for a future approval with the customer (multi approval)' is_daily_approval: type: boolean description: 'Intermediate approval of full approval' contact_id: type: string format: guid description: 'Foreign key of contact, that signed the approval' contact_name: type: string description: 'Contact fullname that sign the approval if not already exists Max length: 255' customer_remarks: type: string description: 'Remarks of the customer during the approval Max length: 4000' date_generated: type: string format: date-time description: 'Local Date+Time of the approval generation' additional_email: type: string description: 'Additional emails that should receive the approval pdf Max length: 4000' is_signed: type: boolean description: 'Inform if a signature is available (cf db_signature)' job_status_id: type: string format: guid description: 'Job Status that will be used to alter the jobs (WaitingFurtherAction,Completed)' rating: type: integer format: int32 description: 'Rating (0,5) the quality of the jobs' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' job_estimated_quantity: type: object required: - id - estimated_quantity properties: id: type: string format: guid description: 'Primary Key' estimated_quantity: type: number format: decimal description: 'Estimated quantity Range: inclusive between 0.1 and 1.79769313486232E+308' article_id: type: string format: guid description: 'Foreign key of the article Optionally required : article_id, article_code or article must be provided' article_code: type: string description: 'Embedded entity "article" using ERP PK when adding/updating Optionally required : article_id, article_code or article must be provided' article: $ref: '#/definitions/article' jobs_id: type: string format: guid description: 'Foreign key of the jobs Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided' jobs_reference_back_office: type: string description: 'Embedded entity "jobs" using ERP PK when adding/updating Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided' jobs: $ref: '#/definitions/jobs' reference_back_office: type: string description: 'The Id/Ref of the back office for this job. Used by Embedded entity Max length: 50' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' job_files: type: object required: - id - jobs_id - job_approval_id - file_name properties: id: type: string format: guid description: 'Primary key' jobs_id: type: string format: guid description: 'Job Id' job_approval_id: type: string format: guid description: 'Job approval Id' file_name: type: string description: 'Name of the file Max length: 100' name: type: string description: ' Max length: 100' description: type: string description: 'Description of the file' tags: type: string description: 'Tags of the file' mime_type: type: string description: 'Mime-type of the file.Used when redirect user to the data, like application/pdf or image/jpeg Max length: 100' file_type: type: string description: 'Readonly: Constant in case of specific file. Can be JOB_APPROVAL, ORDERPDF, PURCHASE_ORDERPDF Max length: 200' image_height: type: integer format: int32 description: 'In case of picture, the original heigth' image_width: type: integer format: int32 description: 'In case of picture, the original width' file_size: type: integer format: int32 description: 'Size in bytes of the file_content' sales_organization_id: type: string format: guid sales_organization_code: type: string description: 'Embedded entity "sales_organization" using ERP PK when adding/updating db_file' sales_organization: $ref: '#/definitions/sales_organization' file_content: type: array items: type: string description: 'The file content, in Byte Array. Use this field when using POST/PUT' dateutc_added: type: string format: date-time description: 'Date UTC when file has been added' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' user_id: type: string format: guid show_on_web: type: boolean db_report_id: type: string format: guid description: 'The id of db_report' job_non_part_usage: type: object required: - id - jobs_id - working_date - type_code - quantity properties: id: type: string format: guid description: 'Primary Key' jobs_id: type: string format: guid description: 'Foreign key of jobs' user_id: type: string format: guid description: 'Foreign key, user that makes the approval' source_db_table_id: type: string format: guid description: 'Source Table used to generate this non part usage (Car_travel or user_timesheet)' source_id_in_table: type: string format: guid description: 'Source Object Id used to generate this non part usage (car_travel.id or user_timesheet.id)' working_date: type: string format: date-time description: 'Date when the object has been generated' timesheet_date_from: type: string format: date-time description: 'In the case of a timesheet, the date+time FROM' timesheet_date_to: type: string format: date-time description: 'In the case of a timesheet, the date+time TO' type_code: type: string description: 'Type of Non part (WorkingTime or TravelTime) Max length: 50' line_code: type: string description: 'code generated from the hour_type.code Max length: 50' description: type: string description: 'description generated from the hour_type.commercial_description Max length: 255' quantity: type: number format: decimal description: 'Quantity converted in decimal (45 minutes is 0.75) Range: inclusive between 0.1 and 1.79769313486232E+308' price: type: number format: decimal description: 'Unit Price computed via the hour_type Matching regular expression pattern: ^[0-9]\d*(\.\d+)?$' line_memo: type: string description: 'Extra memo on the line filled by the User Max length: 4000' signed_by_company: type: boolean description: 'Object was included in a job approval and signed (readonly)' job_approval_id: type: string format: guid description: 'Foreign key to the approval this lines belongs' is_under_warranty: type: boolean description: 'If the system detects that line was included in the warranty, price will be 0' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' job_part_usage: type: object required: - id - jobs_id - user_id - quantity properties: id: type: string format: guid description: 'Primary Key' jobs_id: type: string format: guid description: 'Foreign key of jobs' article_id: type: string format: guid description: 'Foreign key of article. Can be empty if user keys in manually the object' user_id: type: string format: guid description: 'Foreign key, user that uses this part' article_stock_location_id: type: string format: guid description: 'In case of stock management enabled, the stock that has been used' working_date: type: string format: date-time description: 'Date when the part has been used' code: type: string description: 'Code of the part (filled by article.code or manually by the user) Max length: 255' name: type: string description: 'Name of the part (filled by article.name or manually by the user) Max length: 255' description: type: string description: 'Description of the part (filled by article.description or manually by the user) Max length: 255' quantity: type: number format: decimal description: 'Quantity Range: inclusive between 0.1 and 1.79769313486232E+308' price: type: number format: decimal description: 'Unit price of the part. Computed with the price logic or filled via purchase_order_details.price' remark: type: string description: 'Remark / Line memo Max length: 255' purchase_order_details_id: type: string format: guid description: 'Foreign key of purchase_order_details, if the line was generated based on a purchase_order_details' signed_by_company: type: boolean description: 'Object was included in a job approval and signed (readonly)' job_approval_id: type: string format: guid description: 'Foreign key to the approval this lines belongs' is_under_warranty: type: boolean description: 'If the system detects that line was included in the warranty, price will be 0' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' job_planning: type: object required: - id properties: id: type: string format: guid description: 'Primary Key' jobs_id: type: string format: guid description: 'Foreign key to jobs id.' user_id: type: string format: guid description: 'Foreign key to user id.' date_from: type: string format: date-time description: 'Job planning date from' date_to: type: string format: date-time description: 'Job planning date to' sys_logical_delete: type: boolean description: 'Logical Delete. If true, means that row has been flagged deleted and will be physically deleted in the next months' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' job_priority: type: object required: - name properties: id: type: string format: guid description: 'Primary Key' name: type: string description: 'Name of the priority Max length: 50' is_default: type: boolean description: 'If default, will be auto selected when creating new jobs' sequence: type: integer format: int32 description: 'Sorting field (0 first)' sales_organization_id: type: string format: guid description: 'FK of sales_organization. Filled if specific of one SO, empty if can be used by all' sales_organization_code: type: string description: 'Embedded entity "sales_organization" using ERP PK when adding/updating job_priority' sales_organization: $ref: '#/definitions/sales_organization' code: type: string description: 'Field used for Embedded entity (store there your ERP PK) Max length: 255' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' job_status: type: object properties: id: type: string format: guid description: 'Primary Key' code: type: string description: 'Status code' name: type: string description: 'Status name' sequence: type: integer format: int32 description: 'Status order' color_text: type: string description: 'Status color' archived: type: boolean description: 'Status archived?' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating.' job_type: type: object required: - name properties: id: type: string format: guid description: 'Primary Key' name: type: string description: 'Name of the job type Max length: 50' sales_organization_id: type: string format: guid description: 'Filled if specific to one organization, empty if global and can be used by all' description: type: string description: 'Description of the job type Max length: 4000' is_default: type: boolean description: 'Used to auto select one object when creating a jobs' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' code: type: string description: 'Field used for Embedded entity (store there your ERP PK) Max length: 50' job_work_instruction_list: type: object required: - id - name properties: id: type: string format: guid description: 'Primary Key' jobs_id: type: string format: guid description: 'Foreign key of the jobs Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided' jobs_reference_back_office: type: string description: 'Embedded entity "jobs" using ERP PK when adding/updating Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided' jobs: $ref: '#/definitions/jobs' work_instruction_details_id: type: string format: guid description: 'work instruction details id' work_instruction_details_reference_back_office: type: string description: 'Embedded code "work instruction details" when adding/updating' work_instruction_details: $ref: '#/definitions/work_instruction_details' user_id: type: string format: guid description: 'Filled by the person that completed that item on the checklist' work_instruction_action_type: type: string description: 'Value from work_instruction_action_type.name' work_instruction_id: type: string format: guid description: 'work instruction id Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided' work_instruction_reference_back_office: type: string description: 'Embedded code "work instruction" when adding/updating Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided' work_instruction: $ref: '#/definitions/work_instruction' name: type: string description: 'The "on what" Max length: 4000' status: type: string description: 'Status can be Ok,NotOk,Replaced,NotApplicable Max length: 50' date_done: type: string format: date-time description: 'Datetime filled when status goes to one valable status.' remark: type: string description: 'Additional remark from the technician. Max length: 255' advise: type: string description: 'Additional advice from the technician. Max length: 255' sequence: type: integer format: int32 description: 'To order it.' reference_back_office: type: string description: 'The Id/Ref of the back office for this job work instruction. Used by Embedded entity Max length: 255' group_name: type: string description: 'Name of the group Max length: 4000' group_sequence: type: integer format: int32 description: 'Order of the group' type: type: string description: 'One of the possible types which are Regular, Form, Picture, UsedParts, BillableHours. Regular is the default' instruction_document_count: type: integer format: int32 description: 'Specify how many documents/photos must be added if type is Picture' db_report_type_id: type: string format: guid description: 'When type is Form, you must specify which db_report_type must be filled' db_report_type_name: type: string description: 'When type is Form, you must specify which db_report_type must be filled' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' jobs: type: object required: - name properties: id: type: string format: guid description: 'Primary Key' _parent_id: type: string format: guid description: 'Reference to a parent job (in case of Multi Job)' _parent_job: $ref: '#/definitions/jobs' _parent_jobs_reference_back_office: type: string description: 'Embedded entity "job" for parent (multi job level) using ERP PK when adding/updating job' project_id: type: string format: guid description: 'Foreign key of project for this job Optionally required : project_id, project_reference_back_office or project must be provided' project_reference_back_office: type: string description: 'Embedded entity "project" using ERP PK when adding/updating job Optionally required : project_id, project_reference_back_office or project must be provided' project: $ref: '#/definitions/project' job_type_id: type: string format: guid description: 'Foreign key of job type for this job Optionally required : job_type_id, job_type_code or job_type must be provided' job_type_code: type: string description: 'Embedded entity "job_type" using ERP PK when adding/updating job Optionally required : job_type_id, job_type_code or job_type must be provided' job_type: $ref: '#/definitions/job_type' job_priority_id: type: string format: guid description: 'Foreign key of job priority for this job' job_priority_code: type: string description: 'Foreign key of job status for this job. If you don"t know the GUID, use job_type_code' job_priority: $ref: '#/definitions/job_priority' job_status_id: type: string format: guid description: 'Foreign key of job status for this job Optionally required : job_status_id or job_status_code must be provided' job_status_code: type: string description: 'Foreign key of job status using code. Use "Canceled,ToBePlanned, Waiting, Pooling, Suggested, Activated or Open" If Status=Suggested AND suggested_user filled AND suggested_date_start filled THEN a job_planning will be added Optionally required : job_status_id or job_status_code must be provided' db_address_id: type: string format: guid description: 'Foreign key of db_address if job is not on a mobile equipment.Must be the address_id of the location or the equipment' contact_id: type: string format: guid description: 'Foreign key of contact if the main contact of the job is different than the one of the project' requested_by_company_id: type: string format: guid description: 'Foreign key of company if a specific company makes the request for this job' requested_by_contact_id: type: string format: guid description: 'Foreign key of contact to specify why contact of the requested_company_id makes the request' reference_back_office: type: string description: 'The Id/Ref of the back office for this job. Used by Embedded entity Max length: 50' name: type: string description: 'Name of the Job Max length: 255' description: type: string description: 'Description of the job Max length: 4000' working_sequence: type: integer format: int32 description: 'In case of mutli job, they will be ordered by this sequence' internal_memo: type: string description: 'Internal field for communication between BackOffice/Planners/Technicians' prejob_information: type: string description: 'Information usefull for the technician before start (Call the customer,...)' estimated_time: type: integer format: int32 description: 'Estimation of the time needed (in minute). Will be used for planning and statistic' earliest_date_plannable: type: string format: date-time description: 'Use this field if there is a minimum date for the planning (Not Before)' due_date: type: string format: date-time description: 'Deadline of Max date for the planning (Not After)' date_create: type: string format: date-time description: 'Creation date+time' date_update: type: string format: date-time description: 'Update date+time' date_closed: type: string format: date-time description: 'Date+time job goes to completed' suggested_user_id: type: string format: guid description: 'Foreign key of user if there is a suggested user (used for planning) If Status=Suggested AND suggested_user filled AND suggested_date_start filled THEN a job_planning will be added' suggested_user_code: type: string description: 'Embedded entity "suggested user" using ERP PK when adding/updating job' suggested_user: $ref: '#/definitions/user' suggested_date_start: type: string format: date-time description: 'Suggested date+time start (used for planning) If Status=Suggested AND suggested_user filled AND suggested_date_start filled THEN a job_planning will be added' skill_id: type: string format: guid description: 'Foreign key of skill if the job requires a specific skill (used for planning)' skill_code: type: string description: 'Embedded entity "skill" using ERP PK when adding/updating job' skill: $ref: '#/definitions/skill' customer_reference: type: string description: 'Reference of this job for the customer Max length: 50' approval_responsible_user_id: type: string format: guid description: 'In case of multi user job, foreign key of user that is the "WO Leader"' date_reported_by_company: type: string format: date-time description: 'Date+time when company reported the problem' id2: type: integer format: int32 description: 'Internal ID (numeric). Will be used if reference_back_office is empty' company_id: type: string format: guid description: 'This field will be filled automatically based on the project_id' company_code: type: string description: 'This field will be filled automatically based on the project_id' db_address_name: type: string description: 'When mobile equipment, the address to use Max length: 100' db_address_street: type: string description: 'When mobile equipment, the address to use and this field is mandatory Max length: 50' db_address_street2: type: string description: 'It is sub street Max length: 50' db_address_street_number: type: string description: 'When mobile equipment, the address to use Max length: 50' db_address_city: type: string description: 'When mobile equipment, the address to use and this field is mandatory Max length: 50' db_address_zip: type: string description: 'When mobile equipment, the address to use and this field is mandatory Max length: 50' db_address_db_country_id: type: string format: guid description: 'When mobile equipment, the address to use' db_address_db_country_code: type: string description: 'When mobile equipment, the address to use' db_address_phone: type: string description: 'When mobile equipment, the address to use Max length: 50' db_address_email: type: string description: 'When mobile equipment, the address to use Max length: 250' db_address_latitude_decimal: type: number format: decimal description: 'Latitude' db_address_longitude_decimal: type: number format: decimal description: 'Latitude' estimated_quantity_remark: type: string description: 'Description of the parts your technician should use or pick up Max length: 4000' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' jobs_workshop_in_queue: type: object properties: jobs_id: type: string format: guid description: 'Job id' user_ids: type: array items: type: string description: 'List of User Id' location: type: object required: - id - name properties: id: type: string format: guid _parent_id: type: string format: guid description: 'Reference to a parent location' _parent_reference_back_office: type: string description: 'Embedded entity "location" for parent location using ERP PK when adding/updating location' _parent_location: $ref: '#/definitions/location' project_status_id: type: string format: guid description: 'Foreign key to project_status_id' company_id: type: string format: guid description: 'The company owner of this location Optionally required : company_id, company_code or company must be provided' company_code: type: string description: 'Embedded entity "company" using ERP PK when adding/updating location Optionally required : company_id, company_code or company must be provided' company: $ref: '#/definitions/company' name: type: string description: 'Name of the location Max length: 50' extra_information: type: string description: 'extra_information Max length: 255' reference_back_office: type: string description: 'The Id/Ref of the back office for this location. Used by Embedded entity Max length: 255' street: type: string description: 'Street Max length: 100' street_number: type: string description: 'Street number. Max length: 50' zip: type: string description: 'Zip code Max length: 50' city: type: string description: 'City Max length: 50' phone: type: string description: 'Phone number Max length: 50' email: type: string description: 'Email address Max length: 250' db_country_id: type: string format: guid description: 'Foreign key to table Country' db_country_code: type: string description: 'CountryCode entity using international code when adding/updating company' street2: type: string description: 'Additional information on the address not part of the postal address Max length: 50' latitude_decimal: type: number format: decimal description: 'Decimal coordonate for the latitude. (-1;-1) means invalid and (0;0) means not already geo-encoded' longitude_decimal: type: number format: decimal description: 'Decimal coordonate for the longitude. (-1;-1) means invalid and (0;0) means not already geo-encoded' contact_id: type: string format: guid description: 'Foreign key of contact for this location' contact_reference_back_office: type: string description: 'Foreign key of contact for this location. If you don"t know the GUID, use contact_reference_back_office' contact: $ref: '#/definitions/contact' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' id2: type: integer format: int32 description: 'Internal ID (numeric). Will be used if reference_back_office is empty' marketing_segment: type: object required: - segment properties: id: type: string format: guid description: 'Primary Key' code: type: string description: ' Max length: 50' segment: type: string description: 'Marketing segment Name Max length: 50' description: type: string description: 'Description of the segment Max length: 255' visit_frequency_days_interval: type: integer format: int32 description: 'Number of days between 2 visits' frequency_logic: type: string description: 'Logic to apply for the frequency, which last events (value can be ORDER,MEETING_COMPLETED or ORDER_OR_MEETING_COMPLETED )' sales_organization_id: type: string format: guid description: 'FK of sales_organization. Filled if specific of one SO, empty if can be used by all' sales_organization_code: type: string description: 'Embedded entity "sales_organization" using ERP PK when adding/updating company_type' sales_organization: $ref: '#/definitions/sales_organization' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' project: type: object required: - id - name properties: id: type: string format: guid description: 'Primary Key' _parent_id: type: string format: guid description: 'Reference to a parent installation' root_parent_id: type: string format: guid description: 'This field will be filled automatically based on the parent_id' _parent_reference_back_office: type: string description: 'Embedded entity "project" for parent installation using ERP PK when adding/updating project' _parent_project: $ref: '#/definitions/project' equipment_family_id: type: string format: guid description: 'Foreign key to equipment_family. It can be taken via equipment_family_code, equipment_family or equipment model that links to a valid equipment family' equipment_family_code: type: string description: 'Embedded entity "equipment_family" using ERP PK when adding/updating project' equipment_family: $ref: '#/definitions/equipment_family' equipment_model_id: type: string format: guid description: 'Foreign key to equipment model. It can get via equipment_family_code, equipment_family or equipment_model' equipment_model_code: type: string description: 'Embedded entity "equipment_model" using ERP PK when adding/updating project' equipment_model: $ref: '#/definitions/equipment_model' project_status_id: type: string format: guid description: 'Foreign key to project_status Optionally required : project_status_id, project_status_code or project_status must be provided' project_status_code: type: string description: 'Embedded entity "project_status" using ERP PK when adding/updating project Optionally required : project_status_id, project_status_code or project_status must be provided' project_status: $ref: '#/definitions/project_status' company_id: type: string format: guid description: 'The company owner of this project/installation Optionally required : company_id, company_code or company must be provided' company_code: type: string description: 'Embedded entity "company" using ERP PK when adding/updating project Optionally required : company_id, company_code or company must be provided' company: $ref: '#/definitions/company' db_address_id: type: string format: guid description: 'Specific db_address_id of the %company_id% if different than the company default address' db_address_code: type: string description: 'Embedded entity "db_address" using ERP PK when adding/updating project' db_address: $ref: '#/definitions/db_address' location: type: string description: 'Additional text to describe the location Max length: 255' contact_id: type: string format: guid description: 'Main contact for this project/installation' contact_reference_back_office: type: string description: 'Embedded entity "contact" using ERP PK when adding/updating project' contact: $ref: '#/definitions/contact' owner_user_id: type: string format: guid description: 'User owner/manager of this project/installation' name: type: string description: 'Name of the project/installation Max length: 50' description: type: string description: 'Long description' reference_back_office: type: string description: 'The Id/Ref of the back office for this project/installation. Used by Embedded entity Max length: 255' serial_number: type: string description: 'Serial number Max length: 255' barcode: type: string description: 'Barcode Max length: 50' date_start_production: type: string format: date-time description: 'Date project/installation becomes active' date_create: type: string format: date-time description: 'Creation date+time' date_update: type: string format: date-time description: 'Update date+time' updated_by_user_id: type: string format: guid description: 'Last User that updates the object' customer_reference: type: string description: 'Reference of this project/installation for the customer Max length: 50' warranty_date_until: type: string format: date-time description: 'End date of the warranty (if applicable)' last_standard_result_score_1: type: string description: 'Last result score 1 (CF Standard module) Max length: 50' last_standard_result_score_2: type: string description: 'Last result score 2 (CF Standard module)' target_standard_result_score_1: type: string description: 'Target result score 1 (CF Standard module) Max length: 50' target_standard_result_score_2: type: string description: 'Target result score 2 (CF Standard module) Max length: 50' date_built: type: string format: date-time description: 'Build date of the installation (if applicable)' shutdown_consequence: type: string description: 'Consequence of the installation is shut down (CEO has no air cooling anymore,..) Max length: 4000' id2: type: integer format: int32 description: 'Internal ID (numeric). Will be used if reference_back_office is empty' nb_open_jobs: type: integer format: int32 description: 'Readonly - Number of open jobs' date_next_job: type: string format: date-time description: 'Date+time of the next job planned' date_last_job: type: string format: date-time description: 'Date+time of the last job completed' nb_jobs_planned: type: integer format: int32 description: 'Number of jobs with status Planned' nb_jobs_tobeplanned: type: integer format: int32 description: 'Number of jobs with status To Be Planned' nb_jobs_waitingfurtheraction: type: integer format: int32 description: 'Number of jobs with status Waiting Further Action' back_office_timestamp: type: string format: date-time description: 'Back Office timestamp value (conflict detection purpose)' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' is_mobile_installation: type: boolean description: 'Set it TRUE if this is a mobile installation.' project_status: type: object required: - name - is_closed properties: id: type: string format: guid description: 'Primary Key' name: type: string description: 'Name of the project status Max length: 50' is_default: type: boolean description: 'Is default (auto selected when creating new project)' is_closed: type: boolean description: 'Inform if this status means that the project/installation is archived' sales_organization_id: type: string format: guid description: 'FK of sales_organization. Filled if specific of one SO, empty if can be used by all' sales_organization_code: type: string description: 'Embedded entity "sales_organization" using ERP PK when adding/updating project_status' sales_organization: $ref: '#/definitions/sales_organization' code: type: string description: 'Field used for Embedded entity (store there your ERP PK) Max length: 255' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' purchase_order: type: object properties: id: type: string format: guid description: 'Primary Key' id2: type: integer format: int32 description: 'Internal ID (numeric) automatically filled if empty' jobs_id: type: string format: guid description: 'Foreign key to Jobs Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided' jobs_reference_back_office: type: string description: 'Embedded entity "jobs" using ERP PK when adding/updating Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided' jobs: $ref: '#/definitions/jobs' supplier_company_id: type: string format: guid description: 'Foreign key to company, contains the supplier' supplier_company_code: type: string description: 'Embedded entity "company" for the supplier using ERP PK when adding/updating' supplier_company: $ref: '#/definitions/company' user_id: type: string format: guid description: 'Creator of the purchase order' user_code: type: string description: 'Embedded entity "user" for creator using ERP PK when adding/updating purchase_order' user: $ref: '#/definitions/user' description: type: string description: 'Description of the purchase order Max length: 4000' memo: type: string description: 'Memo, remark' total_lines: type: integer format: int32 description: 'Number of lines, automatically filled when adding/updating/deleting lines' date_create: type: string format: date-time description: 'Creation date' date_update: type: string format: date-time description: 'Last update date' date_delivery: type: string format: date-time description: 'Estimated date of delivery' confirmed_date_delivery: type: string format: date-time description: 'Date of the delivery' delivery_db_address_id: type: string format: guid description: 'If Delivery and no picking, AddressID of the company (if not the main)' approved_by_user_id: type: string format: guid description: 'If approval was needed, which user approves it' approved_by_user_code: type: string description: 'Embedded entity "user" for approver using ERP PK when adding/updating purchase_order' approved_by_user: $ref: '#/definitions/user' technical_user_id: type: string format: guid description: 'User to contact if case of technical question about the purchase order' technical_user_code: type: string description: 'Embedded entity "user" for technical user using ERP PK when adding/updating purchase_order' technical_user: $ref: '#/definitions/user' purchase_order_status_id: type: string format: guid description: 'Foreign key to purchase_order_status Optionally required : purchase_order_status_id or purchase_order_status_code must be provided' purchase_order_status_code: type: string description: 'Foreign key to purchase_order_status using code. Use "Approved","SentToSupplier","Cancelled" or "Delivered" Optionally required : purchase_order_status_id or purchase_order_status_code must be provided' article_stock_location_id: type: string format: guid description: 'Stock location that will receive the articles' is_pickup: type: boolean description: 'If pickup, the technician will go himself to the supplier to take the goods' reference_back_office: type: string description: 'Field used for Embedded entity (store there your ERP PK) Max length: 50' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' purchase_order_details: type: object required: - quantity properties: id: type: string format: guid description: 'Primary Key' purchase_order_id: type: string format: guid description: 'Foreign key of the purchase_order Optionally required : purchase_order_id, purchase_order_reference or purchase_order must be provided' purchase_order_reference_back_office: type: string description: 'Embedded entity "purchase_order" using ERP PK when adding/updating Optionally required : purchase_order_id, purchase_order_reference_back_office or purchase_order must be provided' purchase_order: $ref: '#/definitions/purchase_order' article_id: type: string format: guid description: 'Foreign key of article Optionally required : article_id, article_code or article must be provided' article_code: type: string description: 'Embedded entity "article" using ERP PK when adding/updating Optionally required : article_id, article_code or article must be provided' article: $ref: '#/definitions/article' line_number: type: integer format: int32 description: 'Line Number, auto filled with (Highest+1) if value is 0/null' code: type: string description: 'Code of the article (auto filled if empty) Max length: 255' supplier_code: type: string description: 'Code of the supplier for this article Max length: 255' name: type: string description: 'Article Name (will be auto filled if article.name+description are empty) Max length: 255' description: type: string description: 'Article description (will be auto filled by article.short_description if name+description are empty) Max length: 255' price: type: number format: decimal description: 'Unit Price Range: inclusive between 0.1 and 1.79769313486232E+308' quantity: type: number format: decimal description: 'Quantity Range: inclusive between 0.1 and 1.79769313486232E+308' memo: type: string description: 'Line memo/remark' cost_price: type: number format: decimal description: 'Unit Cost Price (statistic purpose) Matching regular expression pattern: ^[0-9]\d*(\.\d+)?$' reference_back_office: type: string description: 'Field used for Embedded entity (store there your ERP PK) Max length: 50' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' sales_organization: type: object required: - id - name properties: id: type: string format: guid description: 'Primary Key' code: type: string description: 'Field used for Embedded entity (store there your ERP PK) Max length: 50' name: type: string description: 'Name of the organization Max length: 50' description: type: string description: 'Description field Max length: 255' db_country_id: type: string format: guid description: 'Default country to be used when creating new company' db_currency_id: type: string format: guid description: 'Currency of the organization' db_language_id: type: string format: guid description: 'Default language of the organization (will be used when nothing is set)' accountancy_code: type: string description: 'Accountancy code for this organization Max length: 50' archived: type: boolean description: 'Valid / Archive' default_unit_of_measure_system_type: type: string description: 'Default system of measure type (Metric,Engloish) Max length: 50' street: type: string description: 'Address : Street Max length: 50' street2: type: string description: 'Address : Second street line Max length: 50' street_number: type: string description: 'Address : Street number Max length: 50' zip: type: string description: 'Address : zip Max length: 50' city: type: string description: 'Address : city Max length: 50' email: type: string description: 'Email Max length: 250' phone: type: string description: 'Phone number Max length: 50' fax: type: string description: 'Fax number Max length: 50' url: type: string description: 'Url of the organization website Max length: 50' vat_reg_code: type: string description: 'VAT number Max length: 50' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' sales_territory: type: object required: - description properties: id: type: string format: guid description: 'Primary Key' code: type: string description: 'Field used for Embedded entity (store there your ERP PK) Max length: 50' description: type: string description: 'Description of the territory' sales_organization_id: type: string format: guid description: 'FK of sales_organization. Filled if specific of one SO, empty if can be used by all' sales_organization_code: type: string description: 'Embedded entity "sales_organization" using ERP PK when adding/updating company_type' sales_organization: $ref: '#/definitions/sales_organization' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' skill: type: object required: - name properties: id: type: string format: guid description: 'Primary Key' name: type: string description: 'Name of the skill Max length: 255' description: type: string description: 'Description of the skill Max length: 4000' code: type: string description: 'Field used for Embedded entity (store there your ERP PK) Max length: 255' sales_organization_id: type: string format: guid description: 'FK of sales_organization. Filled if specific of one SO, empty if can be used by all' sales_organization_code: type: string description: 'Embedded entity "sales_organization" using ERP PK when adding/updating skill' sales_organization: $ref: '#/definitions/sales_organization' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' task: type: object required: - subject properties: id: type: string format: guid description: 'Primary Key' task_type_id: type: string format: guid description: 'Foreign key of task type for this task Optionally required : task_type_id, task_type_code or task_type must be provided' task_type_code: type: string description: 'Embedded entity "task_type" using ERP PK when adding/updating task Optionally required : task_type_id, task_type_code or task_type must be provided' task_type: $ref: '#/definitions/task_type' task_status_id: type: string format: guid description: 'Foreign key of task status for this task.If nothing specified, the system will uses the default task_status available' task_status_reference_back_office: type: string description: 'Embedded entity "task_status" using ERP PK when adding/updating task' task_status: $ref: '#/definitions/task_status' task_priority_id: type: string format: guid description: 'Foreign key of task priority for this task Optionally required : task_priority_id, task_priority_code or task_priority must be provided' task_priority_code: type: string description: 'Embedded entity "task_priority" using ERP PK when adding/updating task Optionally required : task_priority_id, task_priority_code or task_priority must be provided' task_priority: $ref: '#/definitions/task_priority' company_id: type: string format: guid description: 'The company linked to this task Optionally required : company_id, company_code or company must be provided' company_code: type: string description: 'Embedded entity "company" using ERP PK when adding/updating task Optionally required : company_id, company_code or company must be provided' company: $ref: '#/definitions/company' to_db_table_id: type: string format: guid description: 'Foreign key to the table that is linked to this task (Example:project or jobs) using Guid' to_db_table_name: type: string description: 'Foreign key to the table that is linked to this task (Example:project or jobs) using table name' to_id_in_table: type: string format: guid description: 'Foreign key of the object that is linked to this task using Odyssee Guid Primary Key (Exemple:project.id or jobs.id)' subject: type: string description: 'Subject of the Task Max length: 150' remark: type: string description: 'Remark of the Task (long text area field)' internal_remark: type: string description: ' Max length: 4000' customer_reference: type: string description: 'Reference of this task for the customer Max length: 50' assigned_to_user_id: type: string format: guid description: 'Foreign key of the user on which the task has been assigned. If not filled, the system can fill it automatically based on the task_type. When a task is assigned to somebody, the field date_assigned will be filled' assigned_to_user_group_id: type: string format: guid description: 'Foreign key of the user_group on which the task will be assigned. If not filled, the system can fill it automatically based on the task_type' date_create: type: string format: date-time description: 'Creation date+time. Automaticaly filled when adding if no value specified' date_start: type: string format: date-time description: 'Starting date of the task (date_start in the future are not shown on the UI)' due_date: type: string format: date-time description: 'Deadline to close the task' date_closed: type: string format: date-time description: 'Date+Time when the task goes into archive (=completed)' archived: type: boolean description: 'Indicate that the task is now closed (has been updated to a task status "Completed").Automatically filled when adding/updating a task based on the task_type' date_assigned: type: string format: date-time description: 'Date+Time when the task has been assigned to a specific user' date_suggested_by_company: type: string format: date-time description: 'Date+Time suggested by the company to start working on this task' id2: type: integer format: int32 description: 'Internal ID (numeric). Will be used on the UI to identify easily the task' reference_back_office: type: string description: 'The Id/Ref of the back office for this task. Used by Embedded entity Max length: 50' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' contact_id: type: string format: guid description: 'Foreign key of contact for this task.' contact_code: type: string description: 'Embedded entity "contact_code" using ERP PK when adding/updating task' contact: $ref: '#/definitions/contact' requested_by_company_id: type: string format: guid description: 'Foreign key of company that requested this task.' requested_by_company_code: type: string description: 'Embedded entity "company_code" using ERP PK when adding/updating task' requested_by_company: $ref: '#/definitions/company' bill_to_party: type: string description: 'Bill to party of the Task.' task_activity: type: object required: - id - name properties: id: type: string format: guid reference_back_office: type: string name: type: string description: ' Max length: 64' description: type: string only_for_system: type: boolean modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' task_activity_log: type: object required: - id - due_date - date_closed properties: id: type: string format: guid description: 'Primary Key' task_id: type: string format: guid description: 'Task id Optionally required : task_id, task_reference_back_office or task must be provided' task_reference_back_office: type: string description: 'Embedded code "task" using ERP PK when adding/updating task_activity_log Optionally required : task_id, task_reference_back_office or task must be provided' task: $ref: '#/definitions/task' task_activity_id: type: string format: guid description: 'task_activity_id Optionally required : task_activity_id, task_activity_reference_back_office or task_activity must be provided' task_activity_reference_back_office: type: string description: 'Embedded code "task_activity" using ERP PK when adding/updating task_activity_log Optionally required : task_activity_id, task_activity_reference_back_office or task_activity must be provided' task_activity: $ref: '#/definitions/task_activity' user_id: type: string format: guid description: 'user_id Optionally required : user_id, user_code or user must be provided' user_code: type: string description: 'Embedded code "user" using ERP PK when adding/updating task_activity_log Optionally required : user_id, user_code or user must be provided' user: $ref: '#/definitions/user' contact_id: type: string format: guid description: 'contact_id Optionally required : contact_id, contact_reference_back_office or contact must be provided' contact_reference_back_office: type: string description: 'Embedded code "contact" using ERP PK when adding/updating task_activity_log Optionally required : contact_id, contact_reference_back_office or contact must be provided' contact: $ref: '#/definitions/contact' subject: type: string description: 'Saubject Max length: 64' description: type: string description: 'Description' due_date: type: string format: date-time description: 'Date+Time of the due date' is_closed: type: boolean description: 'is_closed' date_closed: type: string format: date-time description: 'Date+Time of the date_closed' reference_back_office: type: string description: 'reference_back_office of task_activity_log' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' task_files: type: object required: - id - task_id - file_name - user_id properties: id: type: string format: guid description: 'Primary key' task_id: type: string format: guid description: 'Task Id' file_name: type: string description: 'Name of the file Max length: 100' name: type: string description: ' Max length: 100' description: type: string description: 'Description of the file' tags: type: string description: 'Tags of the file' mime_type: type: string description: 'Mime-type of the file.Used when redirect user to the data, like application/pdf or image/jpeg Max length: 100' file_type: type: string description: 'Readonly: Constant in case of specific file. Can be JOB_APPROVAL, ORDERPDF, PURCHASE_ORDERPDF Max length: 200' image_height: type: integer format: int32 description: 'In case of picture, the original heigth' image_width: type: integer format: int32 description: 'In case of picture, the original width' file_size: type: integer format: int32 description: 'Size in bytes of the file_content' sales_organization_id: type: string format: guid description: 'In case of global files - you can specifiy if it is available for all organization or only one' sales_organization_code: type: string description: 'Embedded entity "sales_organization" using ERP PK when adding/updating db_file' sales_organization: $ref: '#/definitions/sales_organization' file_content: type: array items: type: string description: 'The file content, in Byte Array. Use this field when using POST/PUT' dateutc_added: type: string format: date-time description: 'Date UTC when file has been added' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' user_id: type: string format: guid show_on_web: type: boolean task_priority: type: object required: - name properties: id: type: string format: guid description: 'Primary Key' name: type: string description: 'Name of the task priority (High,Medium) Max length: 255' code: type: string description: 'Field used for Embedded entity (store there your ERP PK) Max length: 255' is_default: type: boolean description: 'Auto selected when creating a new task' sequence: type: integer format: int32 description: 'Sorting field (0 first), to order them' only_for_e_service: type: boolean description: 'Specify his this task priority is only usable on the e-service' sales_organization_id: type: string format: guid description: 'FK of sales_organization. Filled if specific of one SO, empty if can be used by all' sales_organization_code: type: string description: 'Embedded entity "sales_organization" using ERP PK when adding/updating skill' sales_organization: $ref: '#/definitions/sales_organization' task_status: type: object required: - name - description properties: id: type: string format: guid description: 'Primary Key' name: type: string description: 'Name of the task status (Created,Closed) Max length: 255' description: type: string description: 'Description of the task status Max length: 255' is_default: type: boolean description: 'Auto selected when creating a new task' is_closed: type: boolean description: 'Set this task_status as a CLOSED status (task will be archived)' only_for_e_service: type: boolean description: 'Specify his this task priority is only usable on the e-service' sales_organization_id: type: string format: guid description: 'FK of sales_organization. Filled if specific of one SO, empty if can be used by all' sales_organization_code: type: string description: 'Embedded entity "sales_organization" using ERP PK when adding/updating skill' sales_organization: $ref: '#/definitions/sales_organization' reference_back_office: type: string description: 'Field used for Embedded entity (store there your ERP PK) Max length: 255' task_type: type: object required: - name - description properties: id: type: string format: guid description: 'Primary Key' name: type: string description: 'Name of the task type Max length: 255' code: type: string description: 'Field used for Embedded entity (store there your ERP PK) Max length: 255' description: type: string description: 'Description of the task status Max length: 255' is_default: type: boolean description: 'Auto selected when creating a new task' sequence: type: integer format: int32 description: 'Sorting field (0 first), to order them' only_for_e_service: type: boolean description: 'Specify if this task type is only usable on the e-service' sales_organization_id: type: string format: guid description: 'FK of sales_organization. Filled if specific of one SO, empty if can be used by all' sales_organization_code: type: string description: 'Embedded entity "sales_organization" using ERP PK when adding/updating skill' sales_organization: $ref: '#/definitions/sales_organization' email_notification: type: boolean description: 'If enabled, email will be sent to the assigned user or user/group when the task is created or assigned' translation: type: object properties: field_name: type: string description: 'Name of field that need to translated' language_code: type: string description: 'Code of language' value_translated: type: string description: 'Translation value Max length: 4000' user: type: object required: - id - username - lastname - email properties: id: type: string format: guid description: 'Primary Key' db_language_id: type: string format: guid description: 'Foreign key of db_language' username: type: string description: 'Username of the user, normally his email address Max length: 255' firstname: type: string description: 'Firstname of the user Max length: 255' lastname: type: string description: 'Lastname of the user Max length: 255' code: type: string description: 'The Id/Ref of the back office. Used by Embedded entity Max length: 50' archived: type: boolean description: 'Archive the user if he is not valid anymore (user cannot be deleted)' disabled: type: boolean description: 'Disable temporaly the user (cannot log on)' emergency_contact: type: string description: 'HR : Person to contact in case of emergency (wife,husband) Max length: 64' bankaccount: type: string description: 'HR : Bank Account Max length: 50' social_security: type: string description: 'HR : Social Security Number Max length: 50' place_of_birth: type: string description: 'HR : place of birth Max length: 255' nationality: type: string description: 'HR : nationality of the user Max length: 255' functions: type: string description: 'HR : Functions of the user (Manager, Tech leader) Max length: 255' birthdate: type: string format: date-time description: 'HR : Birthdate of the user' skype: type: string description: 'Skype name Max length: 50' notes: type: string description: 'Internal notes/remarks' sales_organization_id: type: string format: guid description: 'Main organization of the user Optionally required : sales_organization_id, sales_organization_code or sales_organization must be provided' sales_organization: $ref: '#/definitions/sales_organization' sales_organization_code: type: string description: 'Embedded entity "sales_organization" using ERP PK when adding/updating user Optionally required : sales_organization_id, sales_organization_code or sales_organization must be provided' is_team_leader: type: boolean description: 'Specify if this user can be used as a team leader' team_leader_user_id: type: string format: guid description: 'Specify his team leader if this user is a team member' email: type: string description: 'Email of the user Max length: 255' phone: type: string description: 'Phone number of the user Max length: 50' fax: type: string description: 'Fax number of the user Max length: 50' mobile: type: string description: 'Mobile number of the user Max length: 50' private_email: type: string description: 'Private Email of the user Max length: 250' private_phone: type: string description: 'Private Phone number of the user Max length: 50' private_fax: type: string description: 'Private Fax number of the user Max length: 50' private_mobile: type: string description: 'Private Mobile number of the user Max length: 50' private_street: type: string description: 'Private Address:Street Max length: 50' private_street_number: type: string description: 'Private Address:Street Number Max length: 50' private_city: type: string description: 'Private Address:City Max length: 50' private_zip: type: string description: 'Private Address:Zip Max length: 50' private_db_country_id: type: string format: guid description: 'Private Address:Country' private_db_country_code: type: string description: 'Private Address:CountryCode entity using international code when adding/updating user' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' allow_hero_app: type: boolean description: 'Specify if this user has priviliages to hero app' allow_sales_app: type: boolean description: 'Specify if this user has priviliages to salse app' allow_service_app: type: boolean description: 'Specify if this user has priviliages to service app' user_group_id: type: string format: guid description: 'Specify the user group that user belongs to' user_group: type: object properties: id: type: string format: guid description: 'Primary Key' name: type: string description: 'Group name' archived: type: boolean description: 'Group is archived or not' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating.' user_planning_slot: type: object required: - id - user_id - user_planning_slot_type_id properties: id: type: string format: guid description: 'Primary Key' user_id: type: string format: guid description: 'Foreign key to user.' user_planning_slot_type_id: type: string format: guid description: 'Foreign key to user planning slot type id.' date_from: type: string format: date-time description: 'Date from,' date_to: type: string format: date-time description: 'Date to,' description: type: string description: 'Description of user planning slot.' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating.' user_planning_slot_type: type: object required: - id - name - sales_organization_id properties: id: type: string format: guid description: 'Primary Key' name: type: string description: 'Name of the user planning slot type. Max length: 50' background_color: type: string description: 'User can select amongst any color. Max length: 7' sales_organization_id: type: string format: guid description: 'Organization on which belongs the user planning slot type' is_support: type: boolean description: 'To specify if this slot inform the user he is "on call" during that period.' show_on_user_job_list: type: boolean description: 'to specify if need to be shown on wo list.' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating.' user_sales_organization_list: type: object properties: id: type: string format: guid description: 'Primary Key' user_id: type: string format: guid description: 'Foreign key to user Optionally required : user_id, user_code or user must be provided' user_code: type: string description: 'Embedded entity "user" using ERP PK when adding/updating user_sales_organization_list Optionally required : user_id, user_code or user must be provided' user: $ref: '#/definitions/user' sales_organization_id: type: string format: guid description: 'Foreign key to sales_organization Optionally required : sales_organization_id, sales_organization_code or sales_organization must be provided' sales_organization_code: type: string description: 'Embedded entity "sales_organization" using ERP PK when adding/updating user_sales_organization_list Optionally required : sales_organization_id, sales_organization_code or sales_organization must be provided' sales_organization: $ref: '#/definitions/sales_organization' reference_back_office: type: string description: 'Field used for Embedded entity (store there your ERP PK) Max length: 50' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' user_sales_territory_list: type: object properties: id: type: string format: guid description: 'Primary Key' user_id: type: string format: guid description: 'Foreign key to user Optionally required : user_id, user_code or user must be provided' user_code: type: string description: 'Embedded entity "user" using ERP PK when adding/updating user_sales_territory_list Optionally required : user_id, user_code or user must be provided' user: $ref: '#/definitions/user' sales_territory_id: type: string format: guid description: 'Foreign key to sales_territory Optionally required : sales_territory_id, sales_territory_code or sales_territory must be provided' sales_territory_code: type: string description: 'Embedded entity "sales_territory" using ERP PK when adding/updating user_sales_territory_list Optionally required : sales_territory_id, sales_territory_code or sales_territory must be provided' sales_territory: $ref: '#/definitions/sales_territory' reference_back_office: type: string description: 'Field used for Embedded entity (store there your ERP PK) Max length: 50' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' user_skill_list: type: object properties: id: type: string format: guid description: 'Primary Key' user_id: type: string format: guid description: 'Foreign key to user Optionally required : user_id, user_code or user must be provided' user_code: type: string description: 'Embedded entity "user" using ERP PK when adding/updating user_skill_list Optionally required : user_id, user_code or user must be provided' user: $ref: '#/definitions/user' skill_id: type: string format: guid description: 'Foreign key to skill Optionally required : skill_id, skill_code or skill must be provided' skill_code: type: string description: 'Embedded entity "skill" using ERP PK when adding/updating user_skill_list Optionally required : skill_id, skill_code or skill must be provided' skill: $ref: '#/definitions/skill' reference_back_office: type: string description: 'Field used for Embedded entity (store there your ERP PK) Max length: 50' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' user_timesheet: type: object required: - user_id - hour_type_id - date_from_rounded - date_to_rounded properties: id: type: string format: guid description: 'Primary Key' user_id: type: string format: guid description: 'Foreign key of User' hour_type_id: type: string format: guid description: 'Foreign key of the hour type' date_from_rounded: type: string format: date-time description: 'Date+Time timesheet FROM' date_to_rounded: type: string format: date-time description: 'Date+Time timesheet TO' remark: type: string description: 'Additional remark field' is_approved: type: boolean description: 'Inform if this user_timesheet belongs to a week approved (readonly)' db_table_id: type: string format: guid description: 'Foreign key to the table timesheet is linked. Can be a jobs,project,company or empty' db_table_name: type: string description: 'Value of the linked table (from db_table_id)' id_in_table: type: string format: guid description: 'Foreign key of the object linked. Can be a jobs.id, project.id , company.id or empty Optionally required : id_in_table must be provided' free_jobs_reference: type: string description: 'In case the user didn’t select a linked object, he can fill himself a reference' property_1_checked: type: boolean description: 'True/False status of property 1' property_2_checked: type: boolean description: 'True/False status of property 2' property_3_checked: type: boolean description: 'True/False status of property 3' property_4_checked: type: boolean description: 'True/False status of property 4' property_5_checked: type: boolean description: 'True/False status of property 5' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' user_unavailability: type: object required: - date_start - date_end - modified_dateutc - user_unavailability_type_id properties: id: type: string format: guid description: 'Primary Key' date_start: type: string format: date-time description: 'Date+Time of the beginning' date_end: type: string format: date-time description: 'Date+Time of the end' modified_dateutc: type: string format: date-time description: 'Date+Time of the modified' description: type: string description: 'Description of the unavailability Max length: 255' is_approved: type: boolean description: 'Indicate if this object has been approved using a User Week Approval' user_id: type: string format: guid description: 'User owner of this unavailability Optionally required : user_id, user_code or user must be provided' user_code: type: string description: 'Embedded entity "user" using ERP PK when adding/updating user_unavailability Optionally required : user_id, user_code or user must be provided' user: $ref: '#/definitions/user' user_unavailability_type_id: type: string format: guid description: 'Type of the unavailability, cf model user_unavailability_type Optionally required : user_unavailability_type_id, user_unavailability_type_code or user_unavailability_type must be provided' user_unavailability_type_code: type: string description: 'Embedded entity "user_unavailability_type" using ERP PK when adding/updating user_unavailability Optionally required : user_unavailability_type_id, user_unavailability_type_code or user_unavailability_type must be provided' user_unavailability_type: $ref: '#/definitions/user_unavailability_type' user_unavailability_type: type: object required: - name properties: id: type: string format: guid description: 'Primary Key' code: type: string description: 'Field used for Embedded entity (store there your ERP PK) Max length: 50' name: type: string description: 'Name of the unavailability type Max length: 20' description: type: string description: 'Long description Max length: 100' sales_organization_id: type: string format: guid description: 'FK of sales_organization. Filled if specific of one SO, empty if can be used by all' sales_organization_code: type: string description: 'Embedded entity "sales_organization" using ERP PK when adding/updating company_type' sales_organization: $ref: '#/definitions/sales_organization' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' user_week_approval: type: object required: - user_id - approved_date_start - approved_date_end - date_approval - is_approved - approved_by_user_id properties: id: type: string format: guid description: 'Primary Key' user_id: type: string format: guid description: 'Foreign key of User' approved_date_start: type: string format: date-time description: 'Starting date of the approved range' approved_date_end: type: string format: date-time description: 'Ending date of the approved range' date_approval: type: string format: date-time description: 'Date+Time when the approval occured' is_approved: type: boolean description: 'Indicate if the selection (range) is approved' approved_by_user_id: type: string format: guid description: 'Foreign key of user,who did the approval' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' work_instruction: type: object required: - id - job_type_id - equipment_family_id - name - description properties: id: type: string format: guid description: 'Primary Key' sales_organization_id: type: string format: guid description: 'FK of sales_organization. Filled if specific of one SO, empty if can be used by all' sales_organization_code: type: string description: 'Embedded entity "sales_organization" using ERP PK when adding/updating work_instruction' sales_organization: $ref: '#/definitions/sales_organization' job_type_id: type: string format: guid description: 'Applicable job_type' job_type_code: type: string description: 'Applicable job_type' equipment_family_id: type: string format: guid description: 'Applicable equipment family' equipment_family_code: type: string description: 'Applicable equipment family' skill_ids: type: array items: type: string description: 'List of only applicable skils' skill_codes: type: array items: type: string description: 'List of only applicable skils' name: type: string description: 'Name of the header of the work instruction. Max length: 50' description: type: string description: 'Explanation of these instructions for the technician. Max length: 255' estimated_work_time: type: integer format: int32 description: 'Time needed to complete these instructions. Number in minute.' additional_information: type: string description: 'Additional information Max length: 4000' reference_back_office: type: string description: 'The Id/Ref of the back office for this work instruction. Used by Embedded entity Max length: 255' is_required: type: boolean description: 'If true then all instructions required to be executed' is_archived: type: boolean description: 'Specify if the object is not usable anymore' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating.' work_instruction_action_type: type: object required: - id - name properties: id: type: string format: guid description: 'Primary Key' sales_organization_id: type: string format: guid description: 'sales organization id' name: type: string description: 'Action like Replace, Check, Adjust Max length: 50' reference_back_office: type: string description: 'The Id/Ref of the back office for this work instruction action type. Used by Embedded entity Max length: 255' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating' work_instruction_details: type: object required: - id properties: id: type: string format: guid description: 'Primary Key' work_instruction_id: type: string format: guid description: 'work instruction id Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided' work_instruction_reference_back_office: type: string description: 'Embedded code "work instruction" when adding/updating Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided' work_instruction: $ref: '#/definitions/work_instruction' description: type: string description: 'Summary on "what" the action should be done. Max length: 4000' sequence: type: integer format: int32 description: 'sequence order field for the work instruction' reference_back_office: type: string description: 'The Id/Ref of the back office for this work instruction details. Used by Embedded entity Max length: 255' work_instruction_details_group_sequence: type: integer format: int32 description: 'sequence order field for the group' work_instruction_details_group_name: type: string description: 'Name of the group Max length: 4000' is_archived: type: boolean type: type: string description: 'One of the possible types which are Regular, Form, Picture, UsedParts, BillableHours. Regular is the default' show_ok: type: boolean description: 'Indicate if the OK option should be available' show_nok: type: boolean description: 'Indicate if the Not OK option should be available' show_replaced: type: boolean description: 'Indicate if the Replaced option should be available' show_na: type: boolean description: 'Indicate if the N/A option should be available' db_file_id: type: string format: guid description: 'Used to specify a document/photos with instruction' instruction_document_count: type: integer format: int32 description: 'Specify how many documents/photos must be added if type is Picture' db_report_type_id: type: string format: guid description: 'When type is Form, you must specify which db_report_type must be filled' db_report_type_name: type: string description: 'When type is Form, you must specify which db_report_type must be filled' translations: type: list`1 format: list`1 description: 'List of translation of specific field name' modified_dateutc: type: string format: date-time description: 'Readonly system field managed by database, filled with GetUtcDate when adding,updating.'