Antes de realizar as operações básicas de projeto, pasta e atividade, é necessário gerar o token, de forma a poder informá-lo no cabeçalho (Header) das requisições.
\nO token deve ser alterado na variavel 'TOKEN' ou alterar na aba Authorization > Bearer Token e adicionar o token gerado.
\n","event":[{"listen":"prerequest","script":{"id":"4f71f417-aee5-4ccc-af78-71bbb19e277e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"aea7e3d5-cde3-4c9f-85aa-6f4f34895f0a","type":"text/javascript","exec":[""]}}],"_postman_id":"1ab8b00d-2b93-474f-bf1b-29feaa90acd2","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Deve listar todos os projetos conforme a comunidade informada e visualizar todos os campos solicitados.
\nO campo accountId é obrigatório.
Parâmetros de Listagem
\nParâmetros de Retorno
\n","urlObject":{"path":["graphql"],"host":["api.artia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"21244f3d-9095-4f39-ac85-2158e6077bf3"},{"name":"Visualizar Projeto","id":"1ad560ae-4b5a-4633-847e-7294234a0b96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE1ODcxNTg3MDJ9.PPny0wQJdozkkkSgGvkz3PlT9TvTayCZNJ9nvtgGN6U"}]},"isInherited":false},"method":"POST","header":[{"key":"OrganizationId","value":"1","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query{\n showProject(\n id: 0, # OBRIGATÓRIO - ID do projeto\n accountId: 0 # OPCIONAL - ID do grupo de trabalho\n ) {\n id,\n accountId,\n status,\n name,\n customStatus {\n id, \n statusName,\n status\n }\n projectNumber,\n customerName,\n folderTypeName,\n description,\n groupCategories,\n priority,\n justification,\n premise,\n restriction,\n lastInformations,\n skipNotification,\n estimatedStart,\n estimatedEnd,\n actualStart,\n actualEnd,\n estimatedEffort,\n actualEffort,\n actualCost,\n estimatedCost,\n actualRevenue,\n estimatedRevenue,\n actualIncome,\n estimatedIncome,\n activitiesEstimatedStart,\n activitiesActualStart,\n activitiesEstimatedEnd,\n activitiesActualEnd,\n activitiesEstimatedEffort,\n activitiesActualEffort,\n activitiesRemainingEffort,\n activitiesDesignedEffort,\n tendencyEnd,\n aggregateEffort,\n percentCompletedCalculatedAggregate,\n baseLastAggregateEffort,\n baseLastPercentCompletedCalculatedAggregate,\n percentAggregateDuration,\n calculatedEffort,\n percentCompletedCalculated,\n baseLastCalculatedEffort,\n baseLastPercentCompletedCalculated,\n totalEstimatedCost,\n totalActualCost,\n estimatedPartialCost,\n estimatedPartialCostRate,\n estimatedAggregatedCost,\n estimatedAggregatedCostRate,\n totalEstimatedRevenue,\n totalActualRevenue,\n estimatedPartialRevenue,\n estimatedPartialRevenueRate,\n financesEstimatedCost,\n financesActualCost,\n createdAt,\n updatedAt,\n responsibleName,\n #groupTags,\n completedPercent,\n activitiesCompletedPercent,\n activitiesLastUpdate,\n #deadlineDeviation,\n #effortDeviation,\n effortIndicator,\n deadlineIndicator,\n replannedCount,\n costIndicator,\n schedulePerformanceIndex,\n costPerformanceIndex,\n customField {\n hashField,\n value\n },\n costCenterId,\n realizedPartialCost,\n costVariancePercent,\n deadlineVariancePercent\n }\n}","variables":""}},"url":"api.artia.com/graphql","description":"Deve visualizar um projeto conforme a id e a comunidade informada e também deve informar os campos de saida que deseja visualizar.
\nO campo id é obrigatório.
Parâmetros de Listagem
\nParâmetros de Retorno
\n","urlObject":{"path":["graphql"],"host":["api.artia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1ad560ae-4b5a-4633-847e-7294234a0b96"},{"name":"Criar Projeto","id":"fe134aea-8f26-45af-a1c3-5ce0ec8a30c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE1ODcxNTg3MDJ9.PPny0wQJdozkkkSgGvkz3PlT9TvTayCZNJ9nvtgGN6U"}]},"isInherited":false},"method":"POST","header":[{"key":"OrganizationId","value":"1","type":"text"}],"body":{"mode":"graphql","graphql":{"query":" mutation{\n createProject(\n name: \"Projeto via API\", # OBRIGATÓRIO\n parentId: 0, # OBRIGATÓRIO - ID do pai (projeto, pasta ou grupo de trabalho)\n accountId: 0, # OPCIONAL - ID do grupo de trabalho\n createdForUser: true, # Criado por usuário\n skipNotification: 0, # Deixar de notificar as alterações\n categoryText: \"Categoria\",\n templateKeepParticipant: 0, # Manter os usuários associados no projeto ao criar modelo (0/1)\n folderTypeId: 0, # ID do tipo de projeto\n priority: 0, # Prioridade\n customerId: 0, # ID de cliente\n justification: \"\",\n premise: \"\",\n estimatedStart: \"2024-06-10\", # Inicio Estimado\n estimatedEnd: \"2024-06-10\", # Término Estimado\n actualStart: \"\", # Inicio Real\n actualEnd: \"\", # Término Real\n restriction: \"\",\n description: \"Descrição do Projeto\",\n projectNumber: \"0\", # Número do projeto\n lastInformations: \"\", # Ultimas informações\n estimatedEffort: 0.0, # Esforço estimado\n completedPercent: 0 # Percentual Completo\n actualCost:0.0, # # Gasto Real \n estimatedCost: 0.0, # Gasto Estimado\n actualRevenue: 0.0, # Receita Real\n estimatedRevenue: 0.0, # Receita Estimada\n createdBy: \"usuario01@artia.com\", # Email ou ID\n customField: [\n {\n hashField: \"5f295d99a3cf16a65e2cb2424fe460fc92491cea\",\n value: \"10.10\"\n },\n ] # Campo Customizado ,\n costCenterId: 0\n ) {\n id,\n accountId,\n name,\n status,\n customStatus {\n id, \n statusName,\n status\n }\n projectNumber,\n customerName,\n folderTypeName,\n description,\n groupCategories,\n priority,\n justification,\n premise,\n restriction,\n lastInformations,\n skipNotification,\n estimatedStart,\n estimatedEnd,\n actualStart,\n actualEnd,\n estimatedEffort,\n actualEffort,\n actualCost,\n estimatedCost,\n actualRevenue,\n estimatedRevenue,\n actualIncome,\n estimatedIncome,\n activitiesActualStart,\n activitiesEstimatedStart,\n activitiesEstimatedEnd,\n activitiesActualEnd,\n activitiesEstimatedEffort,\n activitiesActualEffort,\n activitiesRemainingEffort,\n activitiesDesignedEffort,\n tendencyEnd,\n aggregateEffort,\n percentCompletedCalculatedAggregate,\n baseLastAggregateEffort,\n baseLastPercentCompletedCalculatedAggregate,\n percentAggregateDuration,\n calculatedEffort,\n percentCompletedCalculated,\n baseLastCalculatedEffort,\n baseLastPercentCompletedCalculated,\n totalEstimatedCost,\n totalActualCost,\n estimatedPartialCost,\n estimatedPartialCostRate,\n estimatedAggregatedCost,\n estimatedAggregatedCostRate,\n totalEstimatedRevenue,\n totalActualRevenue,\n estimatedPartialRevenue,\n estimatedPartialRevenueRate,\n financesEstimatedCost,\n financesActualCost,\n createdAt,\n updatedAt,\n responsibleName,\n #groupTags,\n completedPercent,\n activitiesCompletedPercent,\n activitiesLastUpdate,\n #deadlineDeviation,\n #effortDeviation,\n effortIndicator,\n deadlineIndicator,\n replannedCount,\n costIndicator,\n schedulePerformanceIndex,\n costPerformanceIndex,\n customField{\n hashField,\n value\n },\n costCenterId,\n costCenterName\n }\n }","variables":""}},"url":"api.artia.com/graphql","description":"Deve criar um projeto conforme os campos informados e também deve informar os campos de saida que deseja visualizar.
\nOs campos name e parentId são obrigatórios ter informações.
Parâmetros de Criação
\nParâmetros de Retorno
\n","urlObject":{"path":["graphql"],"host":["api.artia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"fe134aea-8f26-45af-a1c3-5ce0ec8a30c9"},{"name":"Atualizar Projeto","id":"ba1a1160-5163-4ee0-877c-0c80df0bddfc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE1ODcxNTg3MDJ9.PPny0wQJdozkkkSgGvkz3PlT9TvTayCZNJ9nvtgGN6U"}]},"isInherited":false},"method":"POST","header":[{"key":"OrganizationId","value":"1","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation{\n updateProject(\n id: 0, # OBRIGATÓRIO - ID do projeto\n name: \"Nome\", # OBRIGATÓRIO\n accountId: 0, # OPCIONAL - ID do grupo de trabalho\n createdForUser: true, # Criado por usuário\n skipNotification: 0, # Deixar de notificar as alterações\n categoryText: \"Categoria\", # Categoria da Atividade\n folderTypeId: 0, # ID do tipo de projeto\n priority: 0, # Prioridade\n customerId: 0, # ID de cliente\n justification: \"\",\n premise: \"\",\n estimatedStart: \"2020-03-25\", # Inicio Estimado\n estimatedEnd: \"2020-03-25\", # Término Estimado\n actualStart: \"\", # Inicio Real\n actualEnd: \"\", # Término Real\n restriction: \"\",\n description: \"Descrição\",\n projectNumber: \"0\", # Número do projeto\n lastInformations: \"\",\n estimatedEffort: 0.0, # Esforço Estimado\n completedPercent: 0.0, # Percentual Completo\n actualCost: 0.0, # Custo Atual\n estimatedCost: 0.0, # Custo Estimado\n actualRevenue: 0.0, # Receita Atual\n estimatedRevenue: 0.0, # Receita Estimada \n actualIncome: 0.0, # Margem Real\n estimatedIncome: 0.0, # Margem Estimada\n updatedBy: \"usuario01@artia.com\", # Email ou ID\n\t\t\t\tcustomField: [\n {\n hashField: \"5f295d99a3cf16a65e2cb2424fe460fc92491cea\",\n value: \"10.10\"\n },\n ], # Campo Customizado \n costCenterId: 0 # ID do centro de custo\n ) {\n id,\n accountId,\n status,\n name,\n customStatus {\n id, \n statusName,\n status\n }\n projectNumber,\n customerName,\n folderTypeName,\n description,\n groupCategories,\n priority,\n justification,\n premise,\n restriction,\n lastInformations,\n skipNotification,\n estimatedStart,\n estimatedEnd,\n actualStart,\n actualEnd,\n estimatedEffort,\n actualEffort,\n actualCost,\n estimatedCost,\n actualRevenue,\n estimatedRevenue,\n actualIncome,\n estimatedIncome,\n activitiesEstimatedStart,\n activitiesActualStart,\n activitiesEstimatedEnd,\n activitiesActualEnd,\n activitiesEstimatedEffort,\n activitiesActualEffort,\n activitiesRemainingEffort,\n activitiesDesignedEffort,\n tendencyEnd,\n aggregateEffort,\n percentCompletedCalculatedAggregate,\n baseLastAggregateEffort,\n baseLastPercentCompletedCalculatedAggregate,\n percentAggregateDuration,\n calculatedEffort,\n percentCompletedCalculated,\n baseLastCalculatedEffort,\n baseLastPercentCompletedCalculated,\n totalEstimatedCost,\n totalActualCost,\n estimatedPartialCost,\n estimatedPartialCostRate,\n estimatedAggregatedCost,\n estimatedAggregatedCostRate,\n totalEstimatedRevenue,\n totalActualRevenue,\n estimatedPartialRevenue,\n estimatedPartialRevenueRate,\n financesEstimatedCost,\n financesActualCost,\n createdAt,\n updatedAt,\n responsibleName,\n #groupTags,\n completedPercent,\n activitiesCompletedPercent,\n activitiesLastUpdate,\n #deadlineDeviation,\n #effortDeviation,\n effortIndicator,\n deadlineIndicator,\n replannedCount,\n costIndicator,\n schedulePerformanceIndex,\n costPerformanceIndex,\n customField{\n hashField,\n value\n },\n costCenterId,\n costCenterName\n }\n}","variables":""}},"url":"api.artia.com/graphql/","description":"Deve atualizar um projeto conforme os campos informados e também deve informar os campos de saida que deseja visualizar.
\nParâmetros de Atualização
\nParâmetros de Retorno
\n","urlObject":{"path":["graphql",""],"host":["api.artia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ba1a1160-5163-4ee0-877c-0c80df0bddfc"},{"name":"Remover Projeto","id":"40e30776-e523-45a9-b695-4ca742071b56","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE1ODcxNTg3MDJ9.PPny0wQJdozkkkSgGvkz3PlT9TvTayCZNJ9nvtgGN6U"}]},"isInherited":false},"method":"POST","header":[{"key":"OrganizationId","value":"1","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation{\n destroyProject(\n id: 184, # OBRIGATÓRIO - ID do projeto\n accountId: 1 # OPCIONAL - ID do grupo de trabalho\n ) {\n id,\n accountId,\n status,\n name,\n customStatus {\n id, \n statusName,\n status\n }\n projectNumber,\n customerName,\n folderTypeName,\n description,\n groupCategories,\n priority,\n justification,\n premise,\n restriction,\n lastInformations,\n skipNotification,\n estimatedStart,\n estimatedEnd,\n actualStart,\n actualEnd,\n estimatedEffort,\n actualEffort,\n actualCost,\n estimatedCost,\n actualRevenue,\n estimatedRevenue,\n actualIncome,\n estimatedIncome,\n activitiesEstimatedStart,\n activitiesActualStart,\n activitiesEstimatedEnd,\n activitiesActualEnd,\n activitiesEstimatedEffort,\n activitiesActualEffort,\n activitiesRemainingEffort,\n activitiesDesignedEffort,\n tendencyEnd,\n aggregateEffort,\n percentCompletedCalculatedAggregate,\n baseLastAggregateEffort,\n baseLastPercentCompletedCalculatedAggregate,\n percentAggregateDuration,\n calculatedEffort,\n percentCompletedCalculated,\n baseLastCalculatedEffort,\n baseLastPercentCompletedCalculated,\n totalEstimatedCost,\n totalActualCost,\n estimatedPartialCost,\n estimatedPartialCostRate,\n estimatedAggregatedCost,\n estimatedAggregatedCostRate,\n totalEstimatedRevenue,\n totalActualRevenue,\n estimatedPartialRevenue,\n estimatedPartialRevenueRate,\n financesEstimatedCost,\n financesActualCost,\n createdAt,\n updatedAt,\n responsibleName,\n #groupTags,\n completedPercent,\n activitiesCompletedPercent,\n activitiesLastUpdate,\n #deadlineDeviation,\n #effortDeviation,\n effortIndicator,\n deadlineIndicator,\n replannedCount,\n costIndicator,\n schedulePerformanceIndex,\n costPerformanceIndex,\n customField{\n hashField,\n value\n }\n }\n}","variables":""}},"url":"api.artia.com/graphql","description":"Deve remover um projeto conforme a id e comunidade informada e também deve informar os campos de saida que deseja visualizar.
\n","urlObject":{"path":["graphql"],"host":["api.artia.com"],"query":[{"disabled":true,"key":null,"value":""}],"variable":[]}},"response":[],"_postman_id":"40e30776-e523-45a9-b695-4ca742071b56"},{"name":"Remover Vários Projeto","id":"c9aa1d53-ae67-4b3f-ba60-539700872972","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE1ODcxNTg3MDJ9.PPny0wQJdozkkkSgGvkz3PlT9TvTayCZNJ9nvtgGN6U"}]},"isInherited":false},"method":"POST","header":[{"key":"OrganizationId","value":"1","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation{\n destroyAllProject(\n ids: [ # OBRIGATÓRIO - IDs dos projetos\n 129,\n 130\n ],\n accountId: 1 # OPCIONAL - ID do grupo de trabalho\n ) {\n id,\n accountId,\n status,\n name,\n customStatus {\n id, \n statusName,\n status\n }\n projectNumber,\n customerName,\n folderTypeName,\n description,\n groupCategories,\n priority,\n justification,\n premise,\n restriction,\n lastInformations,\n skipNotification,\n estimatedStart,\n estimatedEnd,\n actualStart,\n actualEnd,\n estimatedEffort,\n actualEffort,\n actualCost,\n estimatedCost,\n actualRevenue,\n estimatedRevenue,\n actualIncome,\n estimatedIncome,\n activitiesEstimatedStart,\n activitiesActualStart,\n activitiesEstimatedEnd,\n activitiesActualEnd,\n activitiesEstimatedEffort,\n activitiesActualEffort,\n activitiesRemainingEffort,\n activitiesDesignedEffort,\n tendencyEnd,\n aggregateEffort,\n percentCompletedCalculatedAggregate,\n baseLastAggregateEffort,\n baseLastPercentCompletedCalculatedAggregate,\n percentAggregateDuration,\n calculatedEffort,\n percentCompletedCalculated,\n baseLastCalculatedEffort,\n baseLastPercentCompletedCalculated,\n totalEstimatedCost,\n totalActualCost,\n estimatedPartialCost,\n estimatedPartialCostRate,\n estimatedAggregatedCost,\n estimatedAggregatedCostRate,\n totalEstimatedRevenue,\n totalActualRevenue,\n estimatedPartialRevenue,\n estimatedPartialRevenueRate,\n financesEstimatedCost,\n financesActualCost,\n createdAt,\n updatedAt,\n responsibleName,\n #groupTags,\n completedPercent,\n activitiesCompletedPercent,\n activitiesLastUpdate,\n #deadlineDeviation,\n #effortDeviation,\n effortIndicator,\n deadlineIndicator,\n replannedCount,\n costIndicator,\n schedulePerformanceIndex,\n costPerformanceIndex,\n customField{\n hashField,\n value\n }\n }\n}","variables":""}},"url":"api.artia.com/graphql","description":"Deve remover vários projeto conforme as ids e comunidade informada e também deve informar os campos de saida que deseja visualizar.
\n","urlObject":{"path":["graphql"],"host":["api.artia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c9aa1d53-ae67-4b3f-ba60-539700872972"},{"name":"Alterar Situação","id":"d81eec19-165b-4f02-9316-b369fca1e5ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE1ODcxNTg3MDJ9.PPny0wQJdozkkkSgGvkz3PlT9TvTayCZNJ9nvtgGN6U"}]},"isInherited":false},"method":"POST","header":[{"key":"OrganizationId","value":"1","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation{\n changeCustomStatus(\n id: 0, # OBRIGATÓRIO - ID do projeto\n accountId: 0, # OPCIONAL - ID do grupo de trabalho\n customStatusId: 0, # ID da situação customizada\n status: false # Status da situação (true/false)\n ) {\n id,\n accountId,\n status,\n name,\n customStatus {\n id, \n statusName,\n status\n }\n projectNumber,\n customerName,\n folderTypeName,\n description,\n groupCategories,\n priority,\n justification,\n premise,\n restriction,\n lastInformations,\n skipNotification,\n estimatedStart,\n estimatedEnd,\n actualStart,\n actualEnd,\n estimatedEffort,\n actualEffort,\n actualCost,\n estimatedCost,\n actualRevenue,\n estimatedRevenue,\n actualIncome,\n estimatedIncome,\n activitiesEstimatedStart,\n activitiesActualStart,\n activitiesEstimatedEnd,\n activitiesActualEnd,\n activitiesEstimatedEffort,\n activitiesActualEffort,\n activitiesRemainingEffort,\n activitiesDesignedEffort,\n tendencyEnd,\n aggregateEffort,\n percentCompletedCalculatedAggregate,\n baseLastAggregateEffort,\n baseLastPercentCompletedCalculatedAggregate,\n percentAggregateDuration,\n calculatedEffort,\n percentCompletedCalculated,\n baseLastCalculatedEffort,\n baseLastPercentCompletedCalculated,\n totalEstimatedCost,\n totalActualCost,\n estimatedPartialCost,\n estimatedPartialCostRate,\n estimatedAggregatedCost,\n estimatedAggregatedCostRate,\n totalEstimatedRevenue,\n totalActualRevenue,\n estimatedPartialRevenue,\n estimatedPartialRevenueRate,\n financesEstimatedCost,\n financesActualCost,\n createdAt,\n updatedAt,\n responsibleName,\n #groupTags,\n completedPercent,\n activitiesCompletedPercent,\n activitiesLastUpdate,\n #deadlineDeviation,\n #effortDeviation,\n effortIndicator,\n deadlineIndicator,\n replannedCount,\n costIndicator,\n schedulePerformanceIndex,\n costPerformanceIndex,\n customField{\n hashField,\n value\n }\n }\n}","variables":""}},"url":"api.artia.com/graphql","description":"Deve alterar a situação do projeto, permitindo selecionar os campos desejados.
\nPara alterar a situação do projeto, é necessário informar a situação customizada, bem como o status dela: false, caso a situação seja para projetos pendentes, ou true, caso a situação seja para projetos encerrados.
\n","urlObject":{"path":["graphql"],"host":["api.artia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d81eec19-165b-4f02-9316-b369fca1e5ef"},{"name":"Alterar Status","id":"89d3e5ed-22cb-482d-be58-03ff4ef2c393","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE1ODcxNTg3MDJ9.PPny0wQJdozkkkSgGvkz3PlT9TvTayCZNJ9nvtgGN6U"}]},"isInherited":false},"method":"POST","header":[{"key":"OrganizationId","type":"text","value":"1"}],"body":{"mode":"graphql","graphql":{"query":"mutation{\n changeCustomStatus(\n id: 0, # OBRIGATÓRIO - ID do projeto\n accountId: 0, # OPCIONAL - ID do grupo de trabalho\n ) {\n id,\n accountId,\n status,\n name,\n customStatus {\n id, \n statusName,\n status\n }\n projectNumber,\n customerName,\n folderTypeName,\n description,\n groupCategories,\n priority,\n justification,\n premise,\n restriction,\n lastInformations,\n skipNotification,\n estimatedStart,\n estimatedEnd,\n actualStart,\n actualEnd,\n estimatedEffort,\n actualEffort,\n actualCost,\n estimatedCost,\n actualRevenue,\n estimatedRevenue,\n actualIncome,\n estimatedIncome,\n activitiesEstimatedStart,\n activitiesActualStart,\n activitiesEstimatedEnd,\n activitiesActualEnd,\n activitiesEstimatedEffort,\n activitiesActualEffort,\n activitiesRemainingEffort,\n activitiesDesignedEffort,\n tendencyEnd,\n aggregateEffort,\n percentCompletedCalculatedAggregate,\n baseLastAggregateEffort,\n baseLastPercentCompletedCalculatedAggregate,\n percentAggregateDuration,\n calculatedEffort,\n percentCompletedCalculated,\n baseLastCalculatedEffort,\n baseLastPercentCompletedCalculated,\n totalEstimatedCost,\n totalActualCost,\n estimatedPartialCost,\n estimatedPartialCostRate,\n estimatedAggregatedCost,\n estimatedAggregatedCostRate,\n totalEstimatedRevenue,\n totalActualRevenue,\n estimatedPartialRevenue,\n estimatedPartialRevenueRate,\n financesEstimatedCost,\n financesActualCost,\n createdAt,\n updatedAt,\n responsibleName,\n #groupTags,\n completedPercent,\n activitiesCompletedPercent,\n activitiesLastUpdate,\n #deadlineDeviation,\n #effortDeviation,\n effortIndicator,\n deadlineIndicator,\n replannedCount,\n costIndicator,\n schedulePerformanceIndex,\n costPerformanceIndex,\n customField{\n hashField,\n value\n }\n }\n}","variables":""}},"url":"api.artia.com/graphql","description":"Deve alterar o status do projeto informado o id dele, e retorna o objeto do projeto, permitindo selecionar os campos desejados.
\nDestaca-se que para trocar apenas o status do projeto, a organização não deve possuir situações cadastradas para projetos.
\n","urlObject":{"path":["graphql"],"host":["api.artia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"89d3e5ed-22cb-482d-be58-03ff4ef2c393"}],"id":"c97636a3-2e7b-4ce0-8ef7-b8058a02304c","description":"Realiza as operações básicas de projeto como listar, criar, atualizar, deletar e alterar situação ou status.
\nEm todas as operações é possivel selecionar os campos que deseja visualizar.
\nOs campos permitidos são listados abaixo:
\n- \n
id,
\n \naccountId,
\n \nstatus,
\n \nname,
\n \ncustomStatus
\n- \n
id
\n \nstatusName
\n \nstatus
\n \n
\nprojectNumber,
\n \ncustomerName,
\n \nfolderTypeName,
\n \ndescription,
\n \ngroupCategories,
\n \npriority,
\n \njustification,
\n \npremise,
\n \nrestriction,
\n \nlastInformations,
\n \nskipNotification,
\n \nestimatedStart,
\n \nestimatedEnd,
\n \nactualStart,
\n \nactualEnd,
\n \nestimatedEffort,
\n \nactualEffort,
\n \nactualCost,
\n \nestimatedCost,
\n \nactualRevenue,
\n \nestimatedRevenue,
\n \nactualIncome,
\n \nestimatedIncome,
\n \nactivitiesEstimatedStart,
\n \nactivitiesActualStart,
\n \nactivitiesEstimatedEnd,
\n \nactivitiesActualEnd,
\n \nactivitiesEstimatedEffort,
\n \nactivitiesActualEffort,
\n \nactivitiesRemainingEffort,
\n \nactivitiesDesignedEffort,
\n \ntendencyEnd,
\n \naggregateEffort,
\n \npercentCompletedCalculatedAggregate,
\n \nbaseLastAggregateEffort,
\n \nbaseLastPercentCompletedCalculatedAggregate,
\n \npercentAggregateDuration,
\n \ncalculatedEffort,
\n \npercentCompletedCalculated,
\n \nbaseLastCalculatedEffort,
\n \nbaseLastPercentCompletedCalculated,
\n \ntotalEstimatedCost,
\n \ntotalActualCost,
\n \nestimatedPartialCost,
\n \nestimatedPartialCostRate,
\n \nestimatedAggregatedCost,
\n \nestimatedAggregatedCostRate,
\n \ntotalEstimatedRevenue,
\n \ntotalActualRevenue,
\n \nestimatedPartialRevenue,
\n \nestimatedPartialRevenueRate,
\n \nfinancesEstimatedCost,
\n \nfinancesActualCost,
\n \ncreatedAt,
\n \nupdatedAt,
\n \nresponsibleName,
\n \ncompletedPercent,
\n \nactivitiesCompletedPercent,
\n \nactivitiesLastUpdate,
\n \neffortIndicator,
\n \ndeadlineIndicator,
\n \nreplannedCount,
\n \ncostIndicator,
\n \nschedulePerformanceIndex,
\n \ncostPerformanceIndex,
\n \ncostVariancePercent,
\n \ndeadlineVariancePercent,
\n \ncustomField
\n- \n
hashField
\n \nvalue
\n \n
\nchilds
\n- \n
id
\n \nname
\n \ndescription
\n \ndepth
\n \ntype
\n \nparentId
\n \n
\n
O Campo childs possui paginação baseada em cursor e recebe os seguintes argumentos:
\n- \n
argumentos:
\n- \n
first( Recebe um numero inteiro / Parte do inicio )
\n \nlast( Recebe um numero inteiro / Parte do fim )
\n \nbefore( Recebe uma cursor(String) e faz a paginação antes do cursor )
\n \nafter( Recebe uma cursor(String) e faz a paginação após o cursor )
\n \n
\n
Tambem é possivel trazer informações sobre o cursor e sobre a página.
\nUm cursor é uma string que indica um ponto específico na listagem, é codificado em base64
\n- \n
pageInfo:
\n- \n
hasNextPage( Retorna se existe uma proxima página )
\n \nhasPreviousPage( Retorna se existe uma página anterior )
\n \nstartCursor( O primeiro cursor da página atual )
\n \nendCursor( O ultimo cursor da página atual )
\n \n
\n
Observação: Limitado a 50 resultados por página
\nExemplo da consulta com todas as opções disponiveis:
\nchilds(first: 10) { \n edges { \n node { \n id,\n name,\n type,\n description,\n depth,\n parentId\n }\n cursor\n },\n pageInfo { \n startCursor,\n endCursor,\n hasNextPage,\n hasPreviousPage\n }\n}\n\nDeve criar uma pasta conforme os campos informados e também deve informar os campos de saida que deseja visualizar.
\nOs campos name e parentId são obrigatórios ter informações.
Parâmetros de Criação
\nParâmetros de Retorno
\n","urlObject":{"path":["graphql"],"host":["api.artia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c2ecfb5f-a2d0-4a55-9a12-bc307122a14b"},{"name":"Atualizar Pasta","id":"201cd273-fbe5-4ab2-b06f-26cf70ef5cd5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE1ODcxNTg3MDJ9.PPny0wQJdozkkkSgGvkz3PlT9TvTayCZNJ9nvtgGN6U"}]},"isInherited":false},"method":"POST","header":[{"key":"OrganizationId","value":"1","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation{\n updateFolder(\n id: 1 # OBRIGATÓRIO\n name: \"Novo Titulo da Pasta\",\n estimatedStart: \"2026-01-01\", # Inicio Estimado\n estimatedEnd: \"2026-01-01\", # Término Estimado\n actualStart: \"2026-01-01\", # Inicio Real\n actualEnd: \"2026-01-01\", # Término Real\n folderTypeId: 1 # ID do folder type de pasta\n estimatedEffort: 50, # Esforço Estimado\n completedPercent: 50.0 # Percentual Completo\n estimatedRevenue: 1500 # Receita Estimada\n actualRevenue: 1800 # Receita Real\n estimatedCost: -750 # Gasto Estimado -> valor negativo por ser gasto\n actualCost: -900 # Gasto Real -> valor negativo por ser gasto\n customField: [\n {\n hashField: \"5f295d99a3cf16a65e2cb2424fe460fc92491cea\",\n value: \"1\"\n }\n ]\n ) {\n id,\n name,\n status,\n accountId,\n estimatedStart,\n estimatedEnd,\n actualStart,\n actualEnd,\n folderTypeName,\n estimatedEffort, \n completedPercent, \n estimatedRevenue, \n actualRevenue, \n estimatedCost, \n actualCost, \n estimatedIncome, \n actualIncome, \n totalEstimatedCost, \n totalActualCost, \n estimatedPartialCost, \n estimatedPartialCostRate, \n estimatedAggregatedCost, \n estimatedAggregatedCostRate, \n totalEstimatedRevenue, \n totalActualRevenue, \n estimatedPartialRevenue, \n estimatedPartialRevenueRate, \n financesEstimatedCost, \n financesActualCost, \n parent {\n id,\n name,\n accountId,\n estimatedStart,\n estimatedEnd,\n actualStart,\n actualEnd,\n folderTypeName,\n estimatedEffort, \n completedPercent, \n estimatedRevenue, \n actualRevenue, \n estimatedCost, \n actualCost, \n estimatedIncome, \n actualIncome, \n totalEstimatedCost, \n totalActualCost, \n estimatedPartialCost, \n estimatedPartialCostRate, \n estimatedAggregatedCost, \n estimatedAggregatedCostRate, \n totalEstimatedRevenue, \n totalActualRevenue, \n estimatedPartialRevenue, \n estimatedPartialRevenueRate, \n financesEstimatedCost, \n financesActualCost, \n }\n customField {\n\t\t\thashField,\n\t\t\tvalue\n\t\t}\n }\n}\n","variables":""}},"url":"api.artia.com/graphql","description":"Deve atualizar uma pasta conforme os campos informados e também deve informar os campos de saida que deseja visualizar.
\nApenas o campo id é obrigatório.
Parâmetros de Atualização
\nParâmetros de Retorno
\n","urlObject":{"path":["graphql"],"host":["api.artia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"201cd273-fbe5-4ab2-b06f-26cf70ef5cd5"},{"name":"Alterar Situação Pasta","id":"e40ef6f6-8775-4f75-8a6f-1a5c66083fbe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE1ODcxNTg3MDJ9.PPny0wQJdozkkkSgGvkz3PlT9TvTayCZNJ9nvtgGN6U"}]},"isInherited":false},"method":"POST","header":[{"key":"OrganizationId","value":"1","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation{\n changeFolderStatus(\n id: 1 # OBRIGATÓRIO\n status: true # OBRIGATÓRIO\n ) {\n id,\n name,\n status,\n accountId,\n estimatedStart,\n estimatedEnd,\n actualStart,\n actualEnd,\n folderTypeName,\n estimatedEffort, \n completedPercent, \n estimatedRevenue, \n actualRevenue, \n estimatedCost, \n actualCost, \n estimatedIncome, \n actualIncome, \n totalEstimatedCost, \n totalActualCost, \n estimatedPartialCost, \n estimatedPartialCostRate, \n estimatedAggregatedCost, \n estimatedAggregatedCostRate, \n totalEstimatedRevenue, \n totalActualRevenue, \n estimatedPartialRevenue, \n estimatedPartialRevenueRate, \n financesEstimatedCost, \n financesActualCost, \n parent {\n id,\n name,\n accountId,\n estimatedStart,\n estimatedEnd,\n actualStart,\n actualEnd,\n folderTypeName,\n estimatedEffort, \n completedPercent, \n estimatedRevenue, \n actualRevenue, \n estimatedCost, \n actualCost, \n estimatedIncome, \n actualIncome, \n totalEstimatedCost, \n totalActualCost, \n estimatedPartialCost, \n estimatedPartialCostRate, \n estimatedAggregatedCost, \n estimatedAggregatedCostRate, \n totalEstimatedRevenue, \n totalActualRevenue, \n estimatedPartialRevenue, \n estimatedPartialRevenueRate, \n financesEstimatedCost, \n financesActualCost, \n }\n customField {\n\t\t\thashField,\n\t\t\tvalue\n\t\t}\n }\n}\n","variables":""}},"url":"api.artia.com/graphql","description":"Deve alterar o stataus de uma pasta conforme o id informado e também deve informar os campos de saida que deseja visualizar.
\nOs campos id e status são obrigatórios.
As situações disponíveis são:
\n- \n
false => Pendente
\n \ntrue => Encerrado
\n \n
Parâmetros de Retorno
\n","urlObject":{"path":["graphql"],"host":["api.artia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e40ef6f6-8775-4f75-8a6f-1a5c66083fbe"},{"name":"Visualizar Pasta","id":"cd0dbeb7-1888-4b08-99a6-ea163ed187bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE1ODcxNTg3MDJ9.PPny0wQJdozkkkSgGvkz3PlT9TvTayCZNJ9nvtgGN6U"}]},"isInherited":false},"method":"POST","header":[{"key":"OrganizationId","value":"1","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query{\n showFolder(\n id: 1 # OBRIGATÓRIO\n ) {\n id,\n name,\n status,\n accountId,\n estimatedStart,\n estimatedEnd,\n actualStart,\n actualEnd,\n folderTypeName,\n estimatedEffort, \n completedPercent, \n estimatedRevenue, \n actualRevenue, \n estimatedCost, \n actualCost, \n estimatedIncome, \n actualIncome, \n totalEstimatedCost, \n totalActualCost, \n estimatedPartialCost, \n estimatedPartialCostRate, \n estimatedAggregatedCost, \n estimatedAggregatedCostRate, \n totalEstimatedRevenue, \n totalActualRevenue, \n estimatedPartialRevenue, \n estimatedPartialRevenueRate, \n financesEstimatedCost, \n financesActualCost, \n parent {\n id,\n name,\n accountId,\n estimatedStart,\n estimatedEnd,\n actualStart,\n actualEnd,\n folderTypeName,\n estimatedEffort, \n completedPercent, \n estimatedRevenue, \n actualRevenue, \n estimatedCost, \n actualCost, \n estimatedIncome, \n actualIncome, \n totalEstimatedCost, \n totalActualCost, \n estimatedPartialCost, \n estimatedPartialCostRate, \n estimatedAggregatedCost, \n estimatedAggregatedCostRate, \n totalEstimatedRevenue, \n totalActualRevenue, \n estimatedPartialRevenue, \n estimatedPartialRevenueRate, \n financesEstimatedCost, \n financesActualCost, \n }\n customField {\n\t\t\thashField,\n\t\t\tvalue\n\t\t}\n }\n}\n","variables":""}},"url":"api.artia.com/graphql","description":"Deve visualizar uma pasta conforme o id informado e também deve informar os campos de saida que deseja visualizar.
\nO campo id é obrigatório.
Parâmetros de Visualização
\nParâmetros de Retorno
\n","urlObject":{"path":["graphql"],"host":["api.artia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"cd0dbeb7-1888-4b08-99a6-ea163ed187bf"},{"name":"Listar Pastas","id":"16f3f2ef-b637-4093-8bb8-5ae5c3da5b55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE1ODcxNTg3MDJ9.PPny0wQJdozkkkSgGvkz3PlT9TvTayCZNJ9nvtgGN6U"}]},"isInherited":false},"method":"POST","header":[{"key":"OrganizationId","value":"1","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query{\n listingFolders(\n accountId: 1, # OBRIGATÓRIO\n page: 1 # OPCIONAL - página buscada (retorna 25 registros por vez)\n ) {\n id,\n name,\n status,\n accountId,\n estimatedStart,\n estimatedEnd,\n actualStart,\n actualEnd,\n folderTypeName,\n estimatedEffort, \n completedPercent, \n estimatedRevenue, \n actualRevenue, \n estimatedCost, \n actualCost, \n estimatedIncome, \n actualIncome, \n totalEstimatedCost, \n totalActualCost, \n estimatedPartialCost, \n estimatedPartialCostRate, \n estimatedAggregatedCost, \n estimatedAggregatedCostRate, \n totalEstimatedRevenue, \n totalActualRevenue, \n estimatedPartialRevenue, \n estimatedPartialRevenueRate, \n financesEstimatedCost, \n financesActualCost, \n parent {\n id,\n name,\n accountId,\n estimatedStart,\n estimatedEnd,\n actualStart,\n actualEnd,\n folderTypeName,\n estimatedEffort, \n completedPercent, \n estimatedRevenue, \n actualRevenue, \n estimatedCost, \n actualCost, \n estimatedIncome, \n actualIncome, \n totalEstimatedCost, \n totalActualCost, \n estimatedPartialCost, \n estimatedPartialCostRate, \n estimatedAggregatedCost, \n estimatedAggregatedCostRate, \n totalEstimatedRevenue, \n totalActualRevenue, \n estimatedPartialRevenue, \n estimatedPartialRevenueRate, \n financesEstimatedCost, \n financesActualCost, \n }\n customField {\n\t\t\thashField,\n\t\t\tvalue\n\t\t}\n }\n}\n","variables":""}},"url":"api.artia.com/graphql","description":"Deve listar todas as pastas conforme a comunidade informada e visualizar todos os campos solicitados.
\nO campo accountId é obrigatório.
Parâmetros de Visualização
\nParâmetros de Retorno
\n","urlObject":{"path":["graphql"],"host":["api.artia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"16f3f2ef-b637-4093-8bb8-5ae5c3da5b55"},{"name":"Remover Pasta","id":"026b261e-143e-4de8-bdfc-3fe23a36b05d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE1ODcxNTg3MDJ9.PPny0wQJdozkkkSgGvkz3PlT9TvTayCZNJ9nvtgGN6U"}]},"isInherited":false},"method":"POST","header":[{"key":"OrganizationId","value":"1","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation{\n destroyFolder(\n id: 1 # OBRIGATÓRIO\n ) {\n id,\n name,\n status,\n accountId,\n estimatedStart,\n estimatedEnd,\n actualStart,\n actualEnd,\n folderTypeName,\n estimatedEffort, \n completedPercent, \n estimatedRevenue, \n actualRevenue, \n estimatedCost, \n actualCost, \n estimatedIncome, \n actualIncome, \n totalEstimatedCost, \n totalActualCost, \n estimatedPartialCost, \n estimatedPartialCostRate, \n estimatedAggregatedCost, \n estimatedAggregatedCostRate, \n totalEstimatedRevenue, \n totalActualRevenue, \n estimatedPartialRevenue, \n estimatedPartialRevenueRate, \n financesEstimatedCost, \n financesActualCost, \n parent {\n id,\n name,\n accountId,\n estimatedStart,\n estimatedEnd,\n actualStart,\n actualEnd,\n folderTypeName,\n estimatedEffort, \n completedPercent, \n estimatedRevenue, \n actualRevenue, \n estimatedCost, \n actualCost, \n estimatedIncome, \n actualIncome, \n totalEstimatedCost, \n totalActualCost, \n estimatedPartialCost, \n estimatedPartialCostRate, \n estimatedAggregatedCost, \n estimatedAggregatedCostRate, \n totalEstimatedRevenue, \n totalActualRevenue, \n estimatedPartialRevenue, \n estimatedPartialRevenueRate, \n financesEstimatedCost, \n financesActualCost, \n }\n customField {\n\t\t\thashField,\n\t\t\tvalue\n\t\t}\n }\n}\n","variables":""}},"url":"api.artia.com/graphql","description":"Deve remover uma pasta conforme o id informado e também deve informar os campos de saida que deseja visualizar.
\nParâmetros de Retorno
\n","urlObject":{"path":["graphql"],"host":["api.artia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"026b261e-143e-4de8-bdfc-3fe23a36b05d"},{"name":"Remover várias Pastas","id":"97c02889-76f1-4207-a756-2d0be551201a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE1ODcxNTg3MDJ9.PPny0wQJdozkkkSgGvkz3PlT9TvTayCZNJ9nvtgGN6U"}]},"isInherited":false},"method":"POST","header":[{"key":"OrganizationId","value":"1","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation{\n destroyFolders(\n ids: [1, 2, 3] # OBRIGATÓRIO\n ) {\n id,\n name,\n status,\n accountId,\n estimatedStart,\n estimatedEnd,\n actualStart,\n actualEnd,\n folderTypeName,\n estimatedEffort, \n completedPercent, \n estimatedRevenue, \n actualRevenue, \n estimatedCost, \n actualCost, \n estimatedIncome, \n actualIncome, \n totalEstimatedCost, \n totalActualCost, \n estimatedPartialCost, \n estimatedPartialCostRate, \n estimatedAggregatedCost, \n estimatedAggregatedCostRate, \n totalEstimatedRevenue, \n totalActualRevenue, \n estimatedPartialRevenue, \n estimatedPartialRevenueRate, \n financesEstimatedCost, \n financesActualCost, \n parent {\n id,\n name,\n accountId,\n estimatedStart,\n estimatedEnd,\n actualStart,\n actualEnd,\n folderTypeName,\n estimatedEffort, \n completedPercent, \n estimatedRevenue, \n actualRevenue, \n estimatedCost, \n actualCost, \n estimatedIncome, \n actualIncome, \n totalEstimatedCost, \n totalActualCost, \n estimatedPartialCost, \n estimatedPartialCostRate, \n estimatedAggregatedCost, \n estimatedAggregatedCostRate, \n totalEstimatedRevenue, \n totalActualRevenue, \n estimatedPartialRevenue, \n estimatedPartialRevenueRate, \n financesEstimatedCost, \n financesActualCost, \n }\n customField {\n\t\t\thashField,\n\t\t\tvalue\n\t\t}\n }\n}\n","variables":""}},"url":"api.artia.com/graphql","description":"Deve remover várias pastas conforme os ids informados e também deve informar os campos de saida que deseja visualizar.
\nParâmetros de Retorno
\n","urlObject":{"path":["graphql"],"host":["api.artia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"97c02889-76f1-4207-a756-2d0be551201a"}],"id":"0b5ae9ab-7dfd-4b4e-a780-8c47b0574876","description":"Realiza as operações básicas de pasta como visualizar, listar, criar, atualizar, deletar uma ou várias pastas e alterar status.
\nEm todas as operações é possivel selecionar os campos que deseja visualizar.
\n- \n
id,
\n \nname,
\n \nstatus,
\n \naccountId,
\n \nestimatedStart,
\n \nestimatedEnd,
\n \nactualStart,
\n \nactualEnd,
\n \nfolderTypeName,
\n \nestimatedEffort,
\n \ncompletedPercent,
\n \nestimatedRevenue,
\n \nactualRevenue,
\n \nestimatedCost,
\n \nactualCost,
\n \nestimatedIncome,
\n \nactualIncome,
\n \ntotalEstimatedCost,
\n \ntotalActualCost,
\n \nestimatedPartialCost,
\n \nestimatedPartialCostRate,
\n \nestimatedAggregatedCost,
\n \nestimatedAggregatedCostRate,
\n \ntotalEstimatedRevenue,
\n \ntotalActualRevenue,
\n \nestimatedPartialRevenue,
\n \nestimatedPartialRevenueRate,
\n \nfinancesEstimatedCost,
\n \nfinancesActualCost,
\n \nparent (mostra o objeto acima dele - pasta, projeto ou grupo de trabalho)
\n- \n
id,
\n \nname,
\n \naccountId,
\n \nestimatedStart,
\n \nestimatedEnd,
\n \nactualStart,
\n \nactualEnd,
\n \nfolderTypeName,
\n \nestimatedEffort,
\n \ncompletedPercent,
\n \nestimatedRevenue,
\n \nactualRevenue,
\n \nestimatedCost,
\n \nactualCost,
\n \nestimatedIncome,
\n \nactualIncome,
\n \ntotalEstimatedCost,
\n \ntotalActualCost,
\n \nestimatedPartialCost,
\n \nestimatedPartialCostRate,
\n \nestimatedAggregatedCost,
\n \nestimatedAggregatedCostRate,
\n \ntotalEstimatedRevenue,
\n \ntotalActualRevenue,
\n \nestimatedPartialRevenue,
\n \nestimatedPartialRevenueRate,
\n \nfinancesEstimatedCost,
\n \nfinancesActualCost,
\n \n
\ncustomField
\n- \n
hashField,
\n \nvalue
\n \n
\n
Deve listar todas as atividades de uma pasta ou projeto, permitindo informar os campos de saída que deseja visualizar.
\n","urlObject":{"path":["graphql"],"host":["api.artia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ab2b39b6-148b-416e-843c-6810e93d6ea2"},{"name":"Visualizar Atividade","id":"de3fbb11-5f9c-4081-8748-9e17275e30fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE1ODcxNTg3MDJ9.PPny0wQJdozkkkSgGvkz3PlT9TvTayCZNJ9nvtgGN6U"}]},"isInherited":false},"method":"POST","header":[{"key":"OrganizationId","type":"text","value":"1"}],"body":{"mode":"graphql","graphql":{"query":"query{\n showActivity(\n id: 0, # OBRIGATÓRIO - ID da atividade \n accountId: 0, # OPCIONAL - ID do grupo de trabalho\n folderId: 0 # NÃO OBRIGATÓRIO - ID da pasta ou do projeto pai\n ) {\n id,\n uid,\n communityId,\n customStatus {\n id, \n statusName,\n status\n },\n status,\n folderTypeName,\n title,\n description,\n groupCategories,\n priority,\n estimatedStart,\n timeEstimatedStart,\n estimatedEnd,\n timeEstimatedEnd,\n durationEstimatedCalculated,\n actualStart,\n timeActualStart,\n actualEnd,\n timeActualEnd,\n durationCalculated\n estimatedEffort,\n actualEffort,\n remainingEffort,\n completedPercent,\n lastCalculation,\n workDaysEstimated,\n remainingDays,\n daysToCalculation,\n replanned,\n replannedCount,\n position,\n financePredicted, \n financeAccomplished,\n isCriticalPath,\n customColumns, \n tendencyEnd,\n tfsKey, \n verifyConflicts,\n typeColor, \n schedulePerformanceIndex,\n distributeAllocationAutomatically,\n createdAt,\n updatedAt,\n deletedAt,\n createdById,\n createdForUser,\n responsible {\n id,\n name,\n email\n },\n customField {\n hashField,\n value\n },\n parent {\n id,\n name,\n accountId,\n },\n comments {\n id,\n content,\n author{\n id,\n name,\n email\n },\n createdAt \n },\n recurrence {\n formOfCreation,\n createDaysBefore,\n recurrenceFrequencyType,\n recurrenceFrequency,\n daysOfWeek,\n startDate,\n endDate,\n times,\n startDateOnWeekend,\n endDateOnWeekend\n }\n } \n}\n","variables":""}},"url":"api.artia.com/graphql","description":"Deve visualizar uma atividade ao informar o seu id, permitindo selecionar os campos de saída que deseja visualizar.
É obrigatório informar o id da atividade.
Deve criar uma atividade conforme os campos informados, permitindo informar os campos de saída que deseja visualizar.
\nOs campos title e parentId são obrigatórios.
O campo responsibleId não é obrigatório. Caso não seja informado, o responsável pela atividade é o usuário que está criando ela.
Parâmetros de Criação
\nParâmetros de Retorno
\n","urlObject":{"path":["graphql"],"host":["api.artia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"18472133-d043-46d3-b65e-9c2c02e99ff3"},{"name":"Atualizar Atividade","id":"0178805b-8ff6-495e-82a0-a278cd188f49","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE1ODcxNTg3MDJ9.PPny0wQJdozkkkSgGvkz3PlT9TvTayCZNJ9nvtgGN6U"}]},"isInherited":false},"method":"POST","header":[{"key":"OrganizationId","value":"1","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation{\n updateActivity(\n id: 0, # obrigatório - ID da atividade\n title: \" Atividade\", # obrigatório\n folderId: 0, # ID da pasta ou do projeto \n description: \"Descrição\",\n accountId: 0, # opcional - ID do grupo de trabalho\n folderTypeId: 0, # ID do tipo da pasta\n responsibleId: 1, # ID do usuário responsável pela atividade\n estimatedStart: \"2020-09-26\", # Início Estimado\n estimatedEnd: \"2020-09-26\", # Término Estimado\n actualStart: \"2020-09-26\", # Início Real\n actualEnd: \"\", # Término Real\n estimatedEffort: 40, # Esforço Estimado\n categoryText: \"Categoria\",\n priority: 200, # Prioridade\n timeEstimatedStart: \"08:00\", # Hora de Início Estimado\n timeEstimatedEnd: \"18:00\", # Hora de Término Estimado\n timeActualStart: \"08:30\", # Hora de Início Real\n timeActualEnd: \"\", # Hora de Término Real\n completedPercent: 15, # Percentual Completo\n updatedBy: \"usuario01@artia.com\" # Email ou\n recurrence: [{\n recurrenceFrequencyType: \"\",\n recurrenceFrequency: 0,\n daysOfWeek: [1,2,3,4,5],\n startDate: \"2024-05-28\",\n endDate: \"2024-05-28\",\n times: 2,\n endDateOnWeekend; \"\",\n startDateOnWeekend: \"\",\n formOfCreation: \"\",\n createDaysBefore: 1,\n }], # Configuração da recorrência ID\n customField: [\n {\n hashField: \"5f295d99a3cf16a65e2cb2424fe460fc92491cea\",\n value: \"10.10\"\n },\n ] # Campo Customizado \n ) {\n id,\n uid,\n communityId,\n customStatus {\n id, \n statusName,\n status\n },\n status,\n title,\n description,\n groupCategories,\n priority,\n folderTypeName,\n estimatedStart,\n timeEstimatedStart,\n estimatedEnd,\n timeEstimatedEnd,\n durationEstimatedCalculated,\n actualStart,\n timeActualStart,\n actualEnd,\n timeActualEnd,\n durationCalculated\n estimatedEffort,\n actualEffort,\n remainingEffort,\n completedPercent,\n lastCalculation,\n workDaysEstimated,\n remainingDays,\n daysToCalculation,\n replanned,\n replannedCount,\n position,\n financePredicted, \n financeAccomplished,\n isCriticalPath,\n customColumns, \n tendencyEnd,\n tfsKey, \n verifyConflicts,\n typeColor, \n schedulePerformanceIndex,\n distributeAllocationAutomatically,\n createdAt,\n updatedAt,\n deletedAt,\n createdById,\n createdForUser,\n responsible {\n id,\n name,\n email\n },\n customField {\n hashField,\n value\n },\n parent {\n id,\n name,\n }\n }\n}","variables":""}},"url":"api.artia.com/graphql","description":"Deve atualizar uma atividade, permitindo informar os campos de saída que deseja visualizar.
\nOs campos id e title são obrigatórios. Os demais campos são opcionais, podendo informar apenas o nome do campo que se deseja alterar, bem como o seu novo valor.
Parâmetros de Atualização
\nParâmetros de Retorno
\n","urlObject":{"path":["graphql"],"host":["api.artia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0178805b-8ff6-495e-82a0-a278cd188f49"},{"name":"Remover Atividade(s)","id":"5f4367c8-751b-4c3f-91f0-a455213b90d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE1ODcxNTg3MDJ9.PPny0wQJdozkkkSgGvkz3PlT9TvTayCZNJ9nvtgGN6U"}]},"isInherited":false},"method":"POST","header":[{"key":"OrganizationId","type":"text","value":"1"}],"body":{"mode":"graphql","graphql":{"query":"mutation{\n destroyActivities(\n ids: [1], # OBRIGATÓRIO - ID da(s) atividades\n accountId: # OPCIONAL - ID do grupo de trabalho\n ) {\n message\n }\n}","variables":""}},"url":"api.artia.com/graphql","description":"Deve remover uma ou várias atividade(s), conforme o id e a comunidade informada.
\nO campo ids é obrigatório. O campo de retorno é o message, que informa qual(is) atividade(s) foi(ão) deletada(s).
Para remover mais de uma atividade, deve-se informar os seus respectivos ids no array, separando-os por vírgula: ids: [1, 2]
Deve alterar a situação da atividade, permitindo selecionar os campos de saída que deseja visualizar.
\nOs campos id, folderId, customStatusId e status são obrigatórios.
Para alterar a situação da atividade, é necessário informar a situação customizada, bem como o status dela: false, caso a situação seja para atividades pendentes, ou true, caso a situação seja para atividades encerradas.
\n","urlObject":{"path":["graphql"],"host":["api.artia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f0f36a6f-8768-45d3-8fec-db603e81623e"},{"name":"Alterar Status","id":"8c7054ff-0bef-4f2a-93e9-091244573f34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE1ODcxNTg3MDJ9.PPny0wQJdozkkkSgGvkz3PlT9TvTayCZNJ9nvtgGN6U"}]},"isInherited":false},"method":"POST","header":[{"key":"OrganizationId","type":"text","value":"1"}],"body":{"mode":"graphql","graphql":{"query":"mutation{\n changeCustomStatusActivity(\n id: 1, # OBRIGATÓRIO - ID da atividade \n accountId: 1, # OPCIONAL - ID do grupo de trabalho\n folderId: 1, # OBRIGATÓRIO - ID da pasta ou projeto pai\n ) {\n id,\n title,\n customStatus {\n id,\n statusName,\n status\n },\n }\n}","variables":""}},"url":"api.artia.com/graphql","description":"Deve alterar o status (encerrar/reabrir) da atividade, permitindo selecionar os campos de saída que deseja visualizar.
\nOs campos id e folderId são obrigatórios.
\nSe a atividade estiver aberta, ela será encerrada. Já se ela estiver encerrada, ela será reaberta.
\nDestaca-se que para trocar apenas o status da atividade, a organização não deve possuir situações cadastradas para atividades.
\n","urlObject":{"path":["graphql"],"host":["api.artia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8c7054ff-0bef-4f2a-93e9-091244573f34"}],"id":"41e212b8-404a-4bf0-92db-fb90b064e47e","description":"Realiza as operações básicas de atividade como listar, criar, atualizar, deletar e alterar situação ou status.
\nEm todas as operações é possivel selecionar os campos que deseja visualizar.
\nOs campos permitidos são listados abaixo:
\n- \n
id,
\n \nuid,
\n \ncommunityId,
\n \nstatus,
\n \nfolderTypeName,
\n \ntitle,
\n \ndescription,
\n \ngroupCategories,
\n \npriority,
\n \nestimatedStart,
\n \ntimeEstimatedStart,
\n \nestimatedEnd,
\n \ntimeEstimatedEnd,
\n \ndurationEstimatedCalculated,
\n \nactualStart,
\n \ntimeActualStart,
\n \nactualEnd,
\n \ntimeActualEnd,
\n \ndurationCalculated
\n \nestimatedEffort,
\n \nactualEffort,
\n \nremainingEffort,
\n \ncompletedPercent,
\n \nlastCalculation,
\n \nworkDaysEstimated,
\n \nremainingDays,
\n \ndaysToCalculation,
\n \nreplanned,
\n \nreplannedCount,
\n \nposition,
\n \nfinancePredicted,
\n \nfinanceAccomplished,
\n \nisCriticalPath,
\n \ncustomColumns,
\n \ntendencyEnd,
\n \ntfsKey,
\n \nverifyConflicts,
\n \ntypeColor,
\n \nschedulePerformanceIndex,
\n \ndistributeAllocationAutomatically,
\n \ncreatedAt,
\n \nupdatedAt,
\n \ndeletedAt,
\n \ncreatedById,
\n \ncreatedForUser,
\n \ncustomStatus
\n- \n
id,
\n \nstatusName,
\n \nstatus
\n \n
\ncustomField
\n- \n
hashField,
\n \nvalue
\n \n
\nresponsible (retorna o objeto usuário que é responsavel pela atividade)
\n- \n
id,
\n \nname,
\n \nemail,
\n \n
\ncomments (retorna os comentários da atividade)
\n- \n
id,
\n \ncontent,
\n \nauthor,
\n \ncreatedAt
\n \n
\nparent (retorna o objeto pai - projeto ou pasta)
\n- \n
id,
\n \nname,
\n \naccountId,
\n \nestimatedStart,
\n \nestimatedEnd,
\n \nactualStart,
\n \nactualEnd,
\n \nfolderTypeName,
\n \nestimatedEffort,
\n \ncompletedPercent,
\n \nestimatedRevenue,
\n \nactualRevenue,
\n \nestimatedCost,
\n \nactualCost,
\n \nestimatedIncome,
\n \nactualIncome,
\n \ntotalEstimatedCost,
\n \ntotalActualCost,
\n \nestimatedPartialCost,
\n \nestimatedPartialCostRate,
\n \nestimatedAggregatedCost,
\n \nestimatedAggregatedCostRate,
\n \ntotalEstimatedRevenue,
\n \ntotalActualRevenue,
\n \nestimatedPartialRevenue,
\n \nestimatedPartialRevenueRate,
\n \nfinancesEstimatedCost,
\n \nfinancesActualCost
\n \n
\npoints
\n \nactualSprintName
\n \nteamSprintName
\n \nprojectPrioritization
\n \n
Deve criar um comentário conforme os campos informados, permitindo informar os campos de saída que deseja visualizar.
\nOs parâmetros aceitos são:
\n- \n
id: id da atividade onde será criado o comentário. É um campo obrigatório.
\n \naccountId: Id do grupo de trabalho da atividade. É um campo obrigatório.
\n \nobject: aceita o valor \"activity\". É um campo obrigatório.
\n \ncontent: contéudo do comentário. É um campo obrigatório.
\n \ncreatedBy: campo opcional do tipo texto, recebe como valor id ou email do usuário, exemplo: \"1\" ou \"teste@teste.com\", o usuário declarado nesse campo será o autor do comentário, e usuário logado pela api será o registrador, tendo seu retorno em registeredBy { id, name, email }. A omissão desse campo no corpo da requisição resultará no usuário logado como autor do comentário, tendo seu retorno em author: { id, name, email }
\n \nusers: campo opcinal de array do tipo texto, recebe como valor id ou email, exemplo: user: [\"1\", \"teste@teste.com\"]. Os usuários declarado nesse campo receberão notificação por email quando o comentário for criado e seu retorno será em users: { id, name, email }. A omissão desse campo resultará na criação de comentários sem a notificação por email.
\n \n
Deve listar todos os comentários de uma ou mais atividades, permitindo informar os campos de saída que deseja visualizar.
\nA API possui um limite de 50 comentários por requisição, que são ordenados pela data de criação, do mais recente para o mais antigo.
\nOs parâmetros aceitos são:
\n- \n
accountId: Id do grupo de trabalho que se deseja visualizar os comentários. É um campo obrigatório.
\n \nids: lista com um ou mais ids de objetos. É campo opcional. Se não informado, retorna todos os comentários do grupo de trabalho.
\n \ntype: aceita o valor \"Activity\". É um campo obrigatório.
\n \nviewed: aceita os valores true ou false. É um campo opcional e por padrão será falso.
\n- \n
- Se falso, mostra apenas os comentários não visualizados. \n
- Se true, mostra apenas os comentários visualizados. \n
\n
Realiza as operações de criar e listar comentários de atividades.
\nEm todas as operações é possivel selecionar os campos que deseja visualizar.
\nOs campos permitidos são listados abaixo:
\n- \n
- id, \n
- content, \n
- createdAt, \n
- author \n
Id da sua organização
\n","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query{\n showTimeEntry(\n accountId: 156, #obrigatório\n id: 2550, #obrigatório\n ) {\n id,\n folderId,\n accountId,\n activityId,\n dateAt,\n duration,\n startTime,\n endTime,\n observation,\n timeEntryStatusId,\n status,\n comments,\n approver,\n approvalDate,\n timeEntryCostCenterId,\n resourceCostCenterId,\n kindOfHours\n }\n}","variables":""}},"url":"api.artia.com/graphql","description":"Deve visualizar um apontamento ao informar o seu id, além do id do apontamento, é obrigatório informar o campo accountId.
Parâmetros de Retorno
\nObs.: O campo billable poder retornar os tipos:
\n- \n
0 (Não faturável)
\n \n1 (Faturável)
\n \nnull (Não informado)
\n \n
Obs.: O campo payable poder retornar os tipos:
\n- \n
0 (Não pagável)
\n \n1 (Pagável)
\n \nnull (Não informado)
\n \n
O campo status pode retornar os tipos:
\n- \n
1 (Aguardando Aprovação)
\n \n3 (Aprovado)
\n \n4 (Reprovado)
\n \n
O campo kindOfHours pode retornar os tipos:
\n- \n
\"normal\" (Hora normal)
\n \n\"extra\" (Hora extra)
\n \n
Informações do usuário da requisição (registeredBy)
\n","urlObject":{"path":["graphql"],"host":["api.artia.com"],"query":[],"variable":[]}},"response":[{"id":"15da4290-d7df-45f6-986c-f2323ad5397e","name":"Visualizar Apontamento","originalRequest":{"method":"POST","header":[{"key":"OrganizationId","value":"1","description":"Id da sua organização","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query{\n showTimeEntry(\n accountId: 156, #obrigatório\n id: 2550, #obrigatório\n ) {\n id,\n folderId,\n accountId,\n activityId,\n dateAt,\n duration,\n startTime,\n endTime,\n observation,\n timeEntryStatusId,\n }\n}","variables":""}},"url":"api.artia.com/graphql"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Cache-Control","value":"no-store, must-revalidate, private, max-age=0"},{"key":"X-Request-Id","value":"db071bf3-8c92-4602-832d-2f30dcf4992e"},{"key":"X-Runtime","value":"0.163330"},{"key":"X-MiniProfiler-Original-Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-MiniProfiler-Ids","value":"[\"m03wdatho01h2d9mweos\",\"2s2lff16zhwh10m28da2\",\"56odb72yaoqw8q4x7jw2\",\"6a7hkozckr4vz82v2yf6\",\"cb7takq2lgaa2e9sckbt\",\"6vaxo6kggxje7jjsrpt6\",\"z1m8hm2hvtoc6p90n2eo\"]"},{"key":"Set-Cookie","value":"__profilin=p%3Dt; path=/"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"showTimeEntry\": {\n \"id\": \"2550\",\n \"folderId\": 158,\n \"accountId\": 156,\n \"activityId\": 170,\n \"dateAt\": \"2021-06-24\",\n \"duration\": 1,\n \"startTime\": \" 5:00\",\n \"endTime\": \"06:00\",\n \"observation\": \"\",\n \"timeEntryStatusId\": 1\n }\n }\n}"}],"_postman_id":"9a8da702-6668-440c-94b0-3ef70cab8ca7"},{"name":"Listar Apontamentos","id":"0d0f074d-3ffe-4bbd-9d00-fb641560b706","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE1ODcxNTg3MDJ9.PPny0wQJdozkkkSgGvkz3PlT9TvTayCZNJ9nvtgGN6U"}]},"isInherited":false},"method":"POST","header":[{"key":"OrganizationId","value":"1","description":"Id da sua organização
\n","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query {\n listingTimeEntries(\n accountId: 1573596, # obrigatório - ID do grupo de trabalho\n folderId: 2898988, # ID da pasta/projeto\n activityId: 29153781 # ID da atividade\n ) {\n id,\n accountId,\n folderId,\n activityId,\n dateAt,\n startTime,\n endTime,\n duration,\n observation,\n timeEntryStatusId,\n status,\n comments,\n approver,\n approvalDate,\n timeEntryCostCenterId,\n resourceCostCenterId,\n kindOfHours\n }\n}","variables":""}},"url":"api.artia.com/graphql","description":"account_id: campo obrigatório
\n- \n
comunidade desconhecida, quando id não existir ou não for pertencente a essa organização.
\n \nargumento não aceita valores do tipo texto, exemplo: \"1\";
\n \nargumento não aceita valores decimais com virgula, exemplo: 1,5
\n \nargumento não aceita array, exemplo: [1]
\n
OBS: valores decimais com pontos são convertidos pela api para númerico natural, exemplo: 1.5 => 1 \n
folder_id:
\n- \n
pasta/projeto não encontrado: quando passado id de pasta ou projeto não existente;
\n \npasta/projeto não pertence a outra organização: quando a pasta e projeto foi criado em outra organização;
\n \npasta/projeto não pertence a outro grupo de trabalho: quando pasta ou projeto foi criado em outro grupo de trabalho;
\n \nargumento não aceita valores do tipo texto, exemplo: \"1\";
\n \nargumento não aceita valores decimais com virgula, exemplo: 1,5
\n \nargumento não aceita array, exemplo: [1]
\n \nrestrito não associado a nenhuma atividade, retorna mensagem de alerta dizendo que o mesmo não tem permissão, mesmo se houver apontamento em alguma atividade ao qual não esta associado;
\n \nrestrito associado a alguma atividade, mas sem apontamentos, retorna um array vazio;
\n
OBS: valores decimais com pontos são convertidos pela api para númerico natural, exemplo: 1.5 => 1 \n
activity_id
\n- \n
atividade não encontrado: quando passado o id não existente;
\n \natividade não pertence a organização: quando passado o id de uma atividade criada em outra organização;
\n \natividadenão pertence a outro grupo de trabalho: quando passado o id de uma atividade criada em outro grupo de trabalho;
\n \natividade não pertence a pasta informada: quando passado o id de uma atividade criada em outra pasta ou projeto;
\n \nargumento não aceita valores do tipo texto, exemplo: \"1\";
\n \nargumento não aceita valores decimais com virgula, exemplo: 1,5
\n \nargumento não aceita array, exemplo: [1]
\n \nrestrito não associado a atividade, retorna mensagem de alerta dizendo que o mesmo não tem permissão, mesmo se houver apontamento na atividade ao qual não esta associado;
\n \nrestrito associado a atividade, mas sem apontamentos, retorna um array vazio;
\n
OBS: valores decimais com pontos são convertidos pela api para númerico natural, exemplo: 1.5 => 1
OBS: ao buscar apontamentos no scopo de atividades, não é necessario declarar folder_id, caso o faça, a atividade deve pertencer ao id da pasta ou projeto declarado. \n
Parâmetros de Retorno
\nInteiro
\nObs.: O campo billable poder retornar os tipos:
\n- \n
0 (Não faturável)
\n \n1 (Faturável)
\n \nnull (Não informado)
\n \n
Obs.: O campo payable poder retornar os tipos:
\n- \n
0 (Não pagável)
\n \n1 (Pagável)
\n \nnull (Não informado)
\n \n
O campo status pode retornar os tipos:
\n- \n
1 (Aguardando Aprovação)
\n \n3 (Aprovado)
\n \n4 (Rejeitado)
\n \n
O campo kindOfHours pode retornar os tipos:
\n- \n
\"normal\" (Hora normal)
\n \n\"extra\" (Hora extra)
\n \n
Informações do usuário da requisição (registeredBy)
\n","urlObject":{"path":["graphql"],"host":["api.artia.com"],"query":[],"variable":[]}},"response":[{"id":"5fa32893-0c58-462a-be22-e69b52df5bd6","name":"Listar Apontamentos","originalRequest":{"method":"POST","header":[{"key":"OrganizationId","value":"1","description":"Id da sua organização","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query {\n listingTimeEntries(\n accountId: 1573596, # obrigatório - ID do grupo de trabalho\n folderId: 2898988, # ID da pasta/projeto\n activityId: 29153781 # ID da atividade\n ) {\n id,\n accountId,\n folderId,\n activityId,\n dateAt,\n startTime,\n endTime,\n duration,\n observation,\n timeEntryStatusId,\n status,\n comments,\n approver,\n approvalDate,\n timeEntryCostCenterId,\n resourceCostCenterId\n }\n}","variables":""}},"url":"api.artia.com/graphql"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 10 Dec 2024 19:20:16 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Permissions-Policy","value":"camera=(), gyroscope=(), microphone=(), usb=(), payment=(self), geolocation=(), fullscreen=(self)"},{"key":"Cache-Control","value":"public, no-cache"},{"key":"Surrogate-Control","value":"max-age=300"},{"key":"ETag","value":"W/\"7da04f407d8bee99a53ca21349013138\""},{"key":"Content-Security-Policy","value":"frame-ancestors 'self' https://app2.artia.com; default-src 'self' https: wss:; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src 'self' https: 'unsafe-inline' 'unsafe-eval'; style-src 'self' https: 'unsafe-inline'"},{"key":"X-Request-Id","value":"2f15c519a3fa2ef25b3e900acfd2b17d"},{"key":"X-Runtime","value":"0.760848"},{"key":"vary","value":"Accept, Origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=fEqRZippg7BNBs97frkTjgZpIDidZ4tbQCKd8cMylV1FUT9pRThwmIxvcjLH7qf1yomReiiPnbhBn93PmgvGb5cvu6Q7V3Plr6hRaybi2qR1kkCqETu7%2BtKczeQ8lac%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8eff9759da6c0a05-IAD"},{"key":"Content-Encoding","value":"br"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=1759&min_rtt=1574&rtt_var=620&sent=9&recv=8&lost=0&retrans=0&sent_bytes=2547&recv_bytes=2780&delivery_rate=2674547&cwnd=222&unsent_bytes=0&cid=e1d15f0ea17cd05c&ts=14406&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"listingTimeEntries\": [\n {\n \"id\": \"23122910\",\n \"accountId\": 1573596,\n \"folderId\": 2898988,\n \"activityId\": 29153781,\n \"dateAt\": \"2024-12-09\",\n \"startTime\": null,\n \"endTime\": \"\",\n \"duration\": 0.1,\n \"observation\": \"Ajustes na documentação\",\n \"timeEntryStatusId\": 95,\n \"status\": null,\n \"comments\": null,\n \"approver\": null,\n \"approvalDate\": null,\n \"timeEntryCostCenterId\": null,\n \"resourceCostCenterId\": null\n }\n ]\n }\n}"}],"_postman_id":"0d0f074d-3ffe-4bbd-9d00-fb641560b706"},{"name":"Remover Apontamento","id":"28c7a5d0-1c2e-4bcd-91e2-680ad205f569","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE1ODcxNTg3MDJ9.PPny0wQJdozkkkSgGvkz3PlT9TvTayCZNJ9nvtgGN6U"}]},"isInherited":false},"method":"POST","header":[{"key":"OrganizationId","value":"1","description":"Id da sua organização
\n","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation{\n destroyTimeEntry(\n accountId: 156, #obrigatório\n id: 2550, #obrigatório\n ) {\n id,\n folderId,\n accountId,\n activityId,\n dateAt,\n duration,\n startTime,\n endTime,\n observation,\n timeEntryStatusId,\n kindOfHours\n }\n}","variables":""}},"url":"api.artia.com/graphql","description":"Deve remover um apontamento ao informar o seu id, além do id do apontamento, é obrigatório informar o campo accountId.
Ao remover um apontamento com sucesso, o retorno será os dados do apontamento removido.
\n","urlObject":{"path":["graphql"],"host":["api.artia.com"],"query":[],"variable":[]}},"response":[{"id":"0dec6257-9c75-42d2-bed2-4593d4865f8c","name":"Remover Apontamento","originalRequest":{"method":"POST","header":[{"key":"OrganizationId","value":"1","description":"Id da sua organização","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation{\n destroyTimeEntry(\n accountId: 156, #obrigatório\n id: 2550, #obrigatório\n ) {\n id,\n folderId,\n accountId,\n activityId,\n dateAt,\n duration,\n startTime,\n endTime,\n observation,\n timeEntryStatusId,\n }\n}","variables":""}},"url":"api.artia.com/graphql"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Cache-Control","value":"no-store, must-revalidate, private, max-age=0"},{"key":"X-Request-Id","value":"db071bf3-8c92-4602-832d-2f30dcf4992e"},{"key":"X-Runtime","value":"0.163330"},{"key":"X-MiniProfiler-Original-Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-MiniProfiler-Ids","value":"[\"m03wdatho01h2d9mweos\",\"2s2lff16zhwh10m28da2\",\"56odb72yaoqw8q4x7jw2\",\"6a7hkozckr4vz82v2yf6\",\"cb7takq2lgaa2e9sckbt\",\"6vaxo6kggxje7jjsrpt6\",\"z1m8hm2hvtoc6p90n2eo\"]"},{"key":"Set-Cookie","value":"__profilin=p%3Dt; path=/"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"destroyTimeEntry\": {\n \"id\": \"2550\",\n \"folderId\": 158,\n \"accountId\": 156,\n \"activityId\": 170,\n \"dateAt\": \"2021-06-24\",\n \"duration\": 1,\n \"startTime\": \" 5:00\",\n \"endTime\": \"06:00\",\n \"observation\": \"\",\n \"timeEntryStatusId\": 1\n }\n }\n}"}],"_postman_id":"28c7a5d0-1c2e-4bcd-91e2-680ad205f569"},{"name":"Editar Apontamento","id":"a639891c-33c5-40d4-bed3-8ac39f519e0e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE1ODcxNTg3MDJ9.PPny0wQJdozkkkSgGvkz3PlT9TvTayCZNJ9nvtgGN6U"}]},"isInherited":false},"method":"POST","header":[{"key":"OrganizationId","value":"1","description":"Id da sua organização
\n","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation {\n updateTimeEntry(\n accountId: 0 # obrigatório\n id: 0, # obrigatório\n updateBy: \"usuario01@artia.com\",# se declarado, recebe email ou id\n observation: \"Observação\", \n dateAt: \"2021-07-07\", # não pode ser declarado junto com duration\n duration: 1, # não pode ser declarado junto com endTime\n timeEntryStatusId: 33,\n kindOfHours: \"normal\", # recebe os valores \"normal\" ou \"extra\"\n ) {\n id,\n accountId,\n folderId,\n activityId,\n dateAt,\n startTime,\n endTime,\n duration,\n observation,\n timeEntryStatusId,\n registeredBy {\n id,\n name,\n email\n },\n customField {\n hashField,\n value\n },\n kindOfHours \n }\n}","variables":""}},"url":"api.artia.com/graphql","description":"1.Valida as regras de apontamentos da organização:
\n- \n
Apontados somente em dias de trabalho, retorna: \"Dia da semana não permitido\";
\n \nApontar apenas dentro do período, retorna: \"Horário não permitido\";
\n \nLimitar horas apontadas por dia, retorna: \"Limite de Apontamento por Disponibilidade Excedido\";
\n \nBloquear apontamentos até data declarada, retona: \"Este apontamento está bloqueado.\";
\n \nBloquear apontamentos para atividades encerradas, retorna: \"Você não pode editar o apontamento pois a Atividade está encerrada.\";
\n \nCampo obrigatório, observação, retorna: \"{:observation=>[\"não pode ficar vazio(a)\"]}\"
\n \nData inicio e fim obrigatorio, retorna: \"{:hours=>[\"não pode ficar vazio(a)\"]}\"
\n
; \n
- \n
Valida campos customizaveis.
\n \nArgumento update_by:
\n \n
- \n
só aceita valor do tipo string (texto);
\n \nsó aceita númerico natural ou email, exemplo: \"1\" ou \"teste@teste.com\";
\n \ncampo se declarado no corpo da requisição, não pode ser nulo ou em branco;
\n \nretorna erro se email ou id não for encontrado;
\n \n
- \n
- argumento id \n
- \n
recebe o id do apontamento;
\n \nsó aceita valor númerico natural, 1, 2, 3;
\n \nao passar o valor real, a api irá aredondar esse valor, exemplo: 1.5 => 1;
\n \nretorna apontamento não encontrado se o mesmo não existir;
\n \nretorna apontamento não pertencente ao grupo de trabalho informado, caso o mesmo pertença a outro grupo de trabalho;
\n \nretorna apontamento não pertencente a organização informado, caso o mesmo pertença a outra organização;
\n \nretorna apontamento não pertence ao usuário, caso o apontamento não seja do usuário requisitante ou terceiro (update_by);
\n
OBS: usuário restrito pode alterar apontamento da atividade ao qual não esta mais associado. \n
- \n
- time_entry_status_id \n
- \n
recebe o id de situação personalizada de atividade;
\n \nsó aceita valor númerico natural, 1, 2, 3;
\n \nao passar o valor real, a api irá aredondar esse valor, exemplo: 1.5 => 1;
\n \nretorna erro ao passar valor null;
\n \nretorna situação inativa se a situação for inativa;
\n \nretorna situação não encontrada se o id não existir ou se for o id da situação de outro tipo, como a de projeto.
\n \n
- \n
- start_time, end_time e duration \n
- \n
end_time e duration não podem estar juntos na mesma requisição, ou um ou outro;
\n \nparametro start_time não pode ser maior que parametro end_time;
\n \nse só parametro end_time for declarado, o mesmo nao pode ser menor que start_time já declarado no apontamento.
\n \n
- \n
- kind_of_hours \n
- \n
- só pode receber os valores em texto \"normal\" (Hora normal) ou \"extra\" (Hora extra), qualquer texto diferente de \"normal\" ou \"extra\" será inválido. \n
Id da sua organização
\n","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation {\n createTimeEntry(\n accountId: 0, # obrigatório\n activityId: 0, # obrigatório\n observation: \"Observação\", \n dateAt: \"2021-07-01\", # obrigatório\n startTime: \"08:00\", # obrigatório\n duration: 1, \n timeEntryStatusId: 4, # obrigatório\n createdBy: \"usuario01@artia.com\", # se declarado, recebe email ou id\n kindOfHours: \"normal\", # recebe os valores \"normal\" ou \"extra\"\n customField: [\n {\n hashField: \"\",\n value: \"10.0\"\n }\n ] # Campo customizado\n ) {\n id,\n accountId,\n folderId,\n activityId,\n dateAt,\n startTime,\n endTime,\n duration,\n observation,\n timeEntryStatusId,\n registeredBy {\n id,\n name,\n email\n },\n customField {\n hashField,\n value\n },\n kindOfHours \n }\n}","variables":""}},"url":"api.artia.com/graphql","description":"Deve criar um apontamento conforme os campos informados, permitindo informar os campos de saída que deseja visualizar.
\nOs campos accountId, activityId, dateAt, startTime e timeEntryStatusId são obrigatórios.
O campo createdBy não é obrigatório. Caso não seja informado, o apontamento é criado no nome do usuário da requisição.
O campo kindOfHours é o Tipo da hora e só pode receber os valores em texto \"normal\" (Hora normal) ou \"extra\" (Hora extra), qualquer texto diferente de \"normal\" ou \"extra\" será inválido
Parâmetros de Criação
\nConfiguração de Campos Customizados (customField)
\nParâmetros de Retorno
\nInformações do usuário da requisição (registeredBy)
\n","urlObject":{"path":["graphql"],"host":["api.artia.com"],"query":[],"variable":[]}},"response":[{"id":"11006b99-f15b-4513-bf9f-614329bc9384","name":"Criar Apontamento","originalRequest":{"method":"POST","header":[{"key":"OrganizationId","value":"1","description":"Id da sua organização","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation {\n createTimeEntry(\n accountId: {{account_id}} # obrigatório\n activityId: 372, # obrigatório\n createdBy: \"72\", # se declarado, recebe email ou id\n observation: \"teste\", \n dateAt: \"2021-07-01\", # obrigatório\n startTime: \"08:00\", # obrigatório\n duration: 1, \n timeEntryStatusId: 33, # obrigatório\n customField: [\n {\n hashField: \"163d419134452f47f2db323cb5659e6fbb06f1ec\",\n value: \"teste campo customizado 2\"\n }\n ]\n ) {\n id,\n accountId,\n folderId,\n activityId,\n dateAt,\n startTime,\n endTime,\n duration,\n observation,\n timeEntryStatusId,\n registeredBy {\n id,\n name,\n email\n },\n customField {\n hashField,\n value\n } \n }\n}","variables":""}},"url":"api.artia.com/graphql"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Cache-Control","value":"no-store, must-revalidate, private, max-age=0"},{"key":"X-Request-Id","value":"db071bf3-8c92-4602-832d-2f30dcf4992e"},{"key":"X-Runtime","value":"0.163330"},{"key":"X-MiniProfiler-Original-Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-MiniProfiler-Ids","value":"[\"m03wdatho01h2d9mweos\",\"2s2lff16zhwh10m28da2\",\"56odb72yaoqw8q4x7jw2\",\"6a7hkozckr4vz82v2yf6\",\"cb7takq2lgaa2e9sckbt\",\"6vaxo6kggxje7jjsrpt6\",\"z1m8hm2hvtoc6p90n2eo\"]"},{"key":"Set-Cookie","value":"__profilin=p%3Dt; path=/"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"\"data\": {\n \"createTimeEntry\": {\n \"accountId\": 45,\n \"activityId\": 372,\n \"userId\": \"72\"\n \"dateAt\": \"2021-07-01\",\n \"startTime\": \"08:00\",\n \"endTime\": \"09:00\",\n \"duration\": 1.0,\n \"observation\": \"teste\",\n \"timeEntryStatusId\": 33,\n \"registeredBy\": {\n \"id\": \"7\",\n \"name\": \"Andre Euax\",\n \"email\": \"andre@gmail.com\"\n },\n \"customField\": [\n {\n \"hashField\": \"163d419134452f47f2db323cb5659e6fbb06f1ec\",\n \"value\": \"teste campo customizado 2\"\n }\n ]\n }\n }\n}"}],"_postman_id":"ab03c374-c420-4835-ab90-c0bda363ab6f"}],"id":"46aab625-8254-4bfb-9b4d-6f34556b4c40","_postman_id":"46aab625-8254-4bfb-9b4d-6f34556b4c40","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Deve criar um lançamento financeiro conforme os campos informados, permitindo informar os campos de saída que deseja visualizar.
\nOs campos title, folderId, accountId,
kind , date, totalValue, classification são obrigatórios.
O campo responsibleId não é obrigatório. Caso não seja informado, o responsável pela atividade é o usuário que está criando ela.
Caso seja informado os campos totalValue, unitValue, e amount, seguira o mesmo comportamento da importação csv de lançamentos, o sistema irá ajustar o valor unitário automaticamente para um lançamento correto. Por exemplo:
Se eu lançar 10 unidades com 100 de valor unitário, e um valor total de 100, ele ajustará o valor unitário para 10
\nNo campo unit podem ser informados os valores \"Unidade\" ou \"Recurso/Hora\" ou \"Recurso/Hora Extra\", qualquer valor diferente será inválido.
No campo classification podem ser informados os valores revenue ou spend, onde revenue é receita e spend é gasto, qualquer valor diferente será inválido.
No campo billable podem ser informados os valores 0 ou 1 onde 0 é \"Não\" e 1 é \"Sim\", qualquer valor diferente será inválido. Caso o lançamento criado for do tipo \"Previsto\", o billable será sempre 0 (Não), ou seja, se na criação de um lançamento o Tipo (kind) estiver como \"Previsto\" e o Faturável (billable) informado for diferente de 0 (Não), o valor será automaticamente alterado para 0 (Não)
No campo payable podem ser informados os valores 0 ou 1 onde 0 é \"Não\" e 1 é \"Sim\", qualquer valor diferente será inválido.
Parâmetros de Criação
\nParâmetros de Retorno
\nObs. O campo kind pode retornar os tipos:
\n- \n
predicted(Previsto)
\n \naccomplished(Realizado)
\n \n
O campo classification pode retornar os tipos:
- \n
revenue (Receita)
\n \nspend (Gasto)
\n \n
O campo billable pode retornar os tipos:
- \n
0 (Não)
\n \n1 (Sim)
\n \n
O campo payable pode retornar os tipos:
- \n
0 (Não)
\n \n1 (Sim)
\n \n
Deve visualizar um lançamento financeiro conforme os campos informados, permitindo informar os campos de saída que deseja visualizar.
\nApenas o campo accountId é obrigatório.
Parâmetros de Visualização
\nParâmetros de Retorno
\nObs. O campo kind poder retornar os tipos:
\n- \n
predicted(Previsto)
\n \naccomplished(Realizado)
\n \n
O campo classification pode retornar os tipos
- \n
revenue (Receita)
\n \nspend (Gasto)
\n \n
O campo billable pode retornar os tipos:
- \n
0 (Não)
\n \n1 (Sim)
\n \n
O campo payable pode retornar os tipos:
- \n
0 (Não)
\n \n1 (Sim)
\n \n
Deve remover uma ou vários lançamento(s), conforme o id e a comunidade informada.
\nOs campos ids e accountId são obrigatórios
Para remover mais de um lançamento, deve-se informar os seus respectivos ids no array, separando-os por vírgula: ids: [1, 2]
Parâmetros de Remoção
\nParâmetros de Retorno
\nObs. O campo kind pode retornar os tipos:
\n- \n
predicted(Previsto)
\n \naccomplished(Realizado)
\n \n
O campo classification pode retornar os tipos:
- \n
revenue (Receita)
\n \nspend (Gasto)
\n \n
O campo billable pode retornar os tipos:
- \n
0 (Não)
\n \n1 (Sim)
\n \n
O campo payable pode retornar os tipos:
- \n
0 (Não)
\n \n1 (Sim)
\n \n
Deve editar um lançamento financeiro conforme os campos informados, permitindo informar os campos de saída que deseja visualizar.
\nCaso seja informado os campos totalValue, unitValue, e amount, seguira o mesmo comportamento da importação csv de lançamentos, o sistema irá ajustar o valor unitário automaticamente para um lançamento correto. Por exemplo:
Se eu lançar 10 unidades com 100 de valor unitário, e um valor total de 100, ele ajustará o valor unitário para 10
\nOs campos id, title, folderId, accountId,
são obrigatórios.
\nNo campo unit podem ser informados os valores \"Unidade\" ou \"Recurso/Hora\" ou \"Recurso/Hora Extra\", qualquer valor diferente será inválido.
No campo classification podem ser informados os valores revenue ou spend, onde revenue é receita e spend é gasto, qualquer valor diferente será inválido.
No campo billable podem ser informados os valores 0 ou 1 , onde 0 é \"Não\" e 1 é \"Sim\", qualquer valor diferente será inválido.
OBS: Ainda no campo billable , não será permitido a edição caso o lançamento financeiro tenha sido criado pelo cálculo e o \"billable\" (Faturável) esteja informado como \"Não\". Também não será permitido a edição caso o lançamento editado for do tipo \"Previsto\", o billable informado for diferente de 0 (Não), pois em um lançamento que o Tipo (kind) estiver como \"Previsto\" o billable deve ser sempre 0 (Não) e não pode ser alterado.
No campo payable podem ser informados os valores 0 ou 1 , onde 0 é \"Não\" e 1 é \"Sim\", qualquer valor diferente será inválido.
Parâmetros de Atualização
\nParâmetros de Retorno
\nObs. O campo kind pode retornar os tipos:
\n- \n
predicted(Previsto)
\n \naccomplished(Realizado)
\n \n
O campo classification pode retornar os tipos:
- \n
revenue (Receita)
\n \nspend (Gasto)
\n \n
O campo billable pode retornar os tipos:
- \n
0 (Não)
\n \n1 (Sim)
\n \n
O campo payable pode retornar os tipos:
- \n
0 (Não)
\n \n1 (Sim)
\n \n
account_id: campo obrigatório
\n- \n
comunidade desconhecida, quando id não existir ou não for pertencente a essa organização.
\n \nargumento não aceita valores do tipo texto, exemplo: \"1\";
\n \nargumento não aceita valores decimais com virgula, exemplo: 1,5
\n \nargumento não aceita array, exemplo: [1] OBS: valores decimais com pontos são convertidos pela api para númerico natural, exemplo: 1.5 => 1
\n \n
folder_id: campo obrigatório
\n- \n
comunidade desconhecida, quando id não existir ou não for pertencente a essa organização.
\n \nargumento não aceita valores do tipo texto, exemplo: \"1\";
\n \nargumento não aceita valores decimais com virgula, exemplo: 1,5
\n \nargumento não aceita array, exemplo: [1] OBS: valores decimais com pontos são convertidos pela api para númerico natural, exemplo: 1.5 => 1
\n \n
id: campo opcional
\n- \n
id da finança que deseja recuperar.
\n \ncomunidade desconhecida, quando id não existir ou não for pertencente a essa organização.
\n \nargumento não aceita valores do tipo texto, exemplo: \"1\";
\n \nargumento não aceita valores decimais com virgula, exemplo: 1,5
\n \nargumento não aceita array, exemplo: [1] OBS: valores decimais com pontos são convertidos pela api para númerico natural, exemplo: 1.5 => 1
\n \n
activity_id: campo opcional
\n- \n
comunidade desconhecida, quando id não existir ou não for pertencente a essa organização.
\n \nargumento não aceita valores do tipo texto, exemplo: \"1\";
\n \nargumento não aceita valores decimais com virgula, exemplo: 1,5
\n \nargumento não aceita array, exemplo: [1] OBS: valores decimais com pontos são convertidos pela api para númerico natural, exemplo: 1.5 => 1
\n \n
Parâmetros de Retorno
\nObs. O campo kind pode retornar os tipos:
\n- \n
predicted(Previsto)
\n \naccomplished(Realizado)
\n \n
O campo classification pode retornar os tipos:
- \n
revenue (Receita)
\n \nspend (Gasto)
\n \n
O campo billable pode retornar os tipos:
- \n
0 (Não)
\n \n1 (Sim)
\n \n
O campo payable pode retornar os tipos:
- \n
0 (Não)
\n \n1 (Sim)
\n \n
Realiza as operações de CRUD dos lançamentos financeiros
\nEm todas as operações é possivel selecionar os campos que deseja visualizar.
\nOs campos permitidos são listados abaixo:
\n- \n
id,
\n \ntitle,
\n \ndescription,
\n \nfolderId,
\n \ndate,
\n \nunit,
\n \nunitValue,
\n \ntotalValue,
\n \nkind,
\n \namount,
\n \ngeneralLedgerAccount,
\n \ncostCenter,
\n \nfinancialRating,
\n \ncategoryText,
\n \nresponsible (retorna o objeto usuário que é responsavel pela atividade)
\n- \n
id,
\n \nname,
\n \nemail
\n \n
\npayable
\n \n
Deve listar os centros de custo conforme os campos informados, permitindo informar os campos de saída que deseja visualizar.
\nApenas o campo accountId é obrigatório.
Parâmetros de Listagem
\nParâmetros de Retorno
\n","urlObject":{"path":["graphql"],"host":["api.artia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9f8de317-7e88-4d9a-a0f0-88f11d86edb1"},{"name":"Visualizar Centro de Custos","id":"f159e457-75ad-4291-8871-3ffe09199e67","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE1ODcxNTg3MDJ9.PPny0wQJdozkkkSgGvkz3PlT9TvTayCZNJ9nvtgGN6U"}]},"isInherited":false},"method":"POST","header":[{"key":"OrganizationId","value":"1","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query{\n showCostCenter(\n id: 0, # OBRIGATÓRIO - ID do centro de custo \n accountId: 0, # OBRIGATÓRIO - ID do grupo de trabalho\n ) {\n id,\n organizationId,\n code,\n name\n } \n}","variables":""}},"description":"Deve visualizar um centro de custo conforme os campos informados, permitindo informar os campos de saída que deseja visualizar.
\nOs campos de id e accountId são obrigatórios.
Parâmetros de Visualização
\nParâmetros de Retorno
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"f159e457-75ad-4291-8871-3ffe09199e67"},{"name":"Criar Centro de Custos","id":"cce10da1-5deb-4a25-9887-ad8494e4fd99","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE1ODcxNTg3MDJ9.PPny0wQJdozkkkSgGvkz3PlT9TvTayCZNJ9nvtgGN6U"}]},"isInherited":false},"method":"POST","header":[{"key":"OrganizationId","value":"1","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation{\n createCostCenter(\n accountId: 0, # OBRIGATÓRIO - ID do grupo de trabalho\n name: \"Centro de Custo\", # OBRIGATÓRIO - nome do centro de custo\n code: \"CC\" # OBRIGATÓRIO - código do centro de custo\n ) {\n id,\n organizationId,\n code,\n name\n } \n}\n","variables":""}},"url":"api.artia.com/graphql","description":"Deve criar um centro de custo conforme os campos informados.
\nOs campos accountId, name e code são obrigatórios.
Parâmetros de Criação
\nParâmetros de Retorno
\n","urlObject":{"path":["graphql"],"host":["api.artia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"cce10da1-5deb-4a25-9887-ad8494e4fd99"},{"name":"Atualizar Centro de Custos","id":"9c7cfe8b-e4a8-4cf5-a041-b5e0ecd8419e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE1ODcxNTg3MDJ9.PPny0wQJdozkkkSgGvkz3PlT9TvTayCZNJ9nvtgGN6U"}]},"isInherited":false},"method":"POST","header":[{"key":"OrganizationId","value":"1","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation{\n updateCostCenter(\n accountId: 0, # OBRIGATÓRIO - ID do grupo de trabalho\n id: 0, # OBRIGATÓRIO - ID do centro de custo\n name: \"Centro de Custo Atualizado\", # OBRIGATÓRIO - Nome do centro de custo\n code: \"CCA\" # OBRIGATÓRIO - Código do centro de custo\n ) {\n id,\n organizationId,\n code,\n name\n } \n}\n","variables":""}},"url":"api.artia.com/graphql","description":"Deve atualizar um centro de custo conforme os campos informados.
\nOs campos accountId, id, name e code são obrigatórios.
Parâmetros de Atualização
\nParâmetros de Retorno
\n","urlObject":{"path":["graphql"],"host":["api.artia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9c7cfe8b-e4a8-4cf5-a041-b5e0ecd8419e"},{"name":"Remover Centro de Custo","id":"1d5b03a1-b78e-4364-84be-2afbc52762ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE1ODcxNTg3MDJ9.PPny0wQJdozkkkSgGvkz3PlT9TvTayCZNJ9nvtgGN6U"}]},"isInherited":false},"method":"POST","header":[{"key":"OrganizationId","value":"1","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation{\n destroyCostCenter(\n accountId: 0, # OBRIGATÓRIO - ID do grupo de trabalho\n id: 0 # OBRIGATÓRIO - ID do centro de custo\n ) {\n id,\n organizationId,\n code,\n name\n } \n}\n","variables":""}},"url":"api.artia.com/graphql","description":"Deve remover um centro de custo conforme o id e o grupo de trabalho informados.
\nOs campos id e accountId são obrigatórios
Parâmetros de Remoção
\nParâmetros de Retorno
\n","urlObject":{"path":["graphql"],"host":["api.artia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1d5b03a1-b78e-4364-84be-2afbc52762ad"}],"id":"fb43cc49-b0ed-4bd2-8a71-2c8e392e8533","_postman_id":"fb43cc49-b0ed-4bd2-8a71-2c8e392e8533","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Deve alterar a situação da ordem de serviço, permitindo informar os campos de saída que deseja visualizar.
\nOs campos id e status são os únicos aceitos, portanto ambos são obrigatórios.
As situações disponíveis são listadas abaixo, onde o número representa o código de cada situação:
\n- \n
Pendente
\n \nAguardando aprovação
\n \nAprovada
\n \nReprovada
\n \nFaturada
\n \nPaga
\n \nCancelada
\n \n
Deve criar uma ordem de serviço conforme os campos informados, permitindo informar os campos de saída que deseja visualizar.
\nOs campos name, folderId e status são obrigatórios.
O campo responsibleUserId não é obrigatório. Caso não seja informado, o responsável pela ordem de serviço é o usuário que está criando ela.
Parâmetros de Criação
\nParâmetros de Retorno
\n","urlObject":{"path":["graphql"],"host":["api.artia.com"],"query":[],"variable":[]}},"response":[{"id":"3308ad43-fbd6-4130-9547-853695899d33","name":"Criar Ordem de Serviço","originalRequest":{"method":"POST","header":[{"key":"OrganizationId","value":"1","description":"Id da sua organização","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation{\n\tcreateServiceOrder(\n\t\tname: \"Ordem de Serviço\", # OBRIGATÓRIO - Nome da OS\n\t\tfolderId: 1, # OBRIGATÓRIO - ID da pasta ou do projeto\n\t\tresponsibleUserId: 1, # OBRIGATÓRIO - ID do usuário responsável pela OS\n\t\tstatus: 1, # OBRIGATÓRIO - Situação da OS (1 - 7)\n\t\tnumber: 1, # Número da OS\n\t\tcustomerId: 1, # ID do cliente\n\t\tdescription: \"Descrição\",\n\t\tobservation: \"Observação\"\n\t) {\n\t\tid,\n\t\tname,\n\t\tfolderId,\n\t\torganizationId,\n\t\tresponsibleUserId,\n\t\tstatus,\n\t\tnumber,\n\t\tcustomerId,\n\t\tdescription,\n\t\tobservation,\n createdAt,\n updatedAt\n\t}\n}","variables":""}},"url":"api.artia.com/graphql"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Cache-Control","value":"no-store, must-revalidate, private, max-age=0"},{"key":"X-Request-Id","value":"db071bf3-8c92-4602-832d-2f30dcf4992e"},{"key":"X-Runtime","value":"0.163330"},{"key":"X-MiniProfiler-Original-Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-MiniProfiler-Ids","value":"[\"m03wdatho01h2d9mweos\",\"2s2lff16zhwh10m28da2\",\"56odb72yaoqw8q4x7jw2\",\"6a7hkozckr4vz82v2yf6\",\"cb7takq2lgaa2e9sckbt\",\"6vaxo6kggxje7jjsrpt6\",\"z1m8hm2hvtoc6p90n2eo\"]"},{"key":"Set-Cookie","value":"__profilin=p%3Dt; path=/"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n\t\"data\": {\n\t\t\"createServiceOrder\": {\n\t\t\t\"id\": \"1\",\n\t\t\t\"name\": \"Ordem de serviço\",\n\t\t\t\"folderId\": 1,\n\t\t\t\"organizationId\": 1,\n\t\t\t\"responsibleUserId\": 1,\n\t\t\t\"status\": \"pending\",\n\t\t\t\"number\": 1,\n\t\t\t\"customerId\": null,\n\t\t\t\"description\": null,\n\t\t\t\"observation\": null\n\t\t}\n\t}\n}"}],"_postman_id":"5e535a77-8015-43c4-b3b5-c6b9b928a126"},{"name":"Editar Ordem de Serviço","id":"8924e21f-c01e-46a1-962f-e9dd9f21c90d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE1ODcxNTg3MDJ9.PPny0wQJdozkkkSgGvkz3PlT9TvTayCZNJ9nvtgGN6U"}]},"isInherited":false},"method":"POST","header":[{"key":"OrganizationId","value":"1","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation{\n\tupdateServiceOrder(\n\t\tid: 1, # OBRIGATÓRIO - ID da OS\n\t\tname: \"Ordem de Serviço\", # Nome da OS\n\t\tresponsibleUserId: 1, # ID do usuário responsável pela OS\n\t\tstatus: 1, # Situação da OS\n\t\tnumber: 1, # Número da OS\n\t\tcustomerId: 1, # ID do cliente\n\t\tdescription: \"Descrição\",\n\t\tobservation: \"Observação\"\n\t) {\n\t\tid,\n\t\tname,\n\t\tfolderId,\n\t\torganizationId,\n\t\tresponsibleUserId,\n\t\tstatus,\n\t\tnumber,\n\t\tcustomerId,\n\t\tdescription,\n\t\tobservation,\n createdAt,\n updatedAt\n\t}\n}","variables":""}},"url":"api.artia.com/graphql","description":"Deve editar uma ordem de serviço conforme os campos informados, permitindo informar os campos de saída que deseja visualizar.
\nApenas o campo id é obrigatório.
Caso nenhum outro dado seja informado, a API retornará uma mensagem solicitando o envio de pelo menos um campo para alteração.
\nParâmetros de Edição
\nParâmetros de Retorno
\n","urlObject":{"path":["graphql"],"host":["api.artia.com"],"query":[],"variable":[]}},"response":[{"id":"01dbe9a2-3638-49b2-ada2-1d331b24f6b6","name":"Editar Ordem de Serviço","originalRequest":{"method":"POST","header":[{"key":"OrganizationId","value":"1","description":"Id da sua organização","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation{\n\tupdateServiceOrder(\n\t\tid: 1, # OBRIGATÓRIO - ID da OS\n\t\tname: \"Ordem de Serviço\", # Nome da OS\n\t\tresponsibleUserId: 1, # ID do usuário responsável pela OS\n\t\tstatus: 1, # Situação da OS\n\t\tnumber: 1, # Número da OS\n\t\tcustomerId: 1, # ID do cliente\n\t\tdescription: \"Descrição\",\n\t\tobservation: \"Observação\"\n\t) {\n\t\tid,\n\t\tname,\n\t\tfolderId,\n\t\torganizationId,\n\t\tresponsibleUserId,\n\t\tstatus,\n\t\tnumber,\n\t\tcustomerId,\n\t\tdescription,\n\t\tobservation,\n createdAt,\n updatedAt\n\t}\n}","variables":""}},"url":"api.artia.com/graphql"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Cache-Control","value":"no-store, must-revalidate, private, max-age=0"},{"key":"X-Request-Id","value":"db071bf3-8c92-4602-832d-2f30dcf4992e"},{"key":"X-Runtime","value":"0.163330"},{"key":"X-MiniProfiler-Original-Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-MiniProfiler-Ids","value":"[\"m03wdatho01h2d9mweos\",\"2s2lff16zhwh10m28da2\",\"56odb72yaoqw8q4x7jw2\",\"6a7hkozckr4vz82v2yf6\",\"cb7takq2lgaa2e9sckbt\",\"6vaxo6kggxje7jjsrpt6\",\"z1m8hm2hvtoc6p90n2eo\"]"},{"key":"Set-Cookie","value":"__profilin=p%3Dt; path=/"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n\t\"data\": {\n\t\t\"updateServiceOrder\": {\n\t\t\t\"id\": \"1\",\n\t\t\t\"name\": \"Ordem de serviço\",\n\t\t\t\"folderId\": 1,\n\t\t\t\"organizationId\": 1,\n\t\t\t\"responsibleUserId\": 1,\n\t\t\t\"status\": \"pending\",\n\t\t\t\"number\": 1,\n\t\t\t\"customerId\": 1,\n\t\t\t\"description\": \"Descrição\",\n\t\t\t\"observation\": \"Observação\"\n\t\t}\n\t}\n}"}],"_postman_id":"8924e21f-c01e-46a1-962f-e9dd9f21c90d"},{"name":"Remover Ordem de Serviço","id":"9cf4f0f9-5040-4785-a582-296abb59b010","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE1ODcxNTg3MDJ9.PPny0wQJdozkkkSgGvkz3PlT9TvTayCZNJ9nvtgGN6U"}]},"isInherited":false},"method":"POST","header":[{"key":"OrganizationId","value":"1","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation {\n\tdestroyServiceOrder(\n\t\tid: 1 # OBRIGATÓRIO - ID da OS\n\t) {\n\t\tid,\n\t\tname,\n\t\tfolderId,\n\t\torganizationId,\n\t\tresponsibleUserId,\n\t\tstatus,\n\t\tnumber,\n\t\tcustomerId,\n\t\tdescription,\n\t\tobservation,\n createdAt,\n updatedAt\n\t}\n}","variables":""}},"url":"api.artia.com/graphql","description":"Remove a ordem de serviço correspondente ao id informado.
O id é o único campo aceito nesta operação e seu envio é obrigatório.
Após a ordem de serviço ser excluída, o retorno será dos campos de saída informados.
\n","urlObject":{"path":["graphql"],"host":["api.artia.com"],"query":[],"variable":[]}},"response":[{"id":"10fdf67f-3618-4f7f-8b7b-e4ea1251aaba","name":"Remover Ordem de Serviço","originalRequest":{"method":"POST","header":[{"key":"OrganizationId","value":"1","description":"Id da sua organização","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation {\n\tdestroyServiceOrder(\n\t\tid: 1 # OBRIGATÓRIO - ID da OS\n\t) {\n\t\tid,\n\t\tname,\n\t\tfolderId,\n\t\torganizationId,\n\t\tresponsibleUserId,\n\t\tstatus,\n\t\tnumber,\n\t\tcustomerId,\n\t\tdescription,\n\t\tobservation,\n createdAt,\n updatedAt\n\t}\n}","variables":""}},"url":"api.artia.com/graphql"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Cache-Control","value":"no-store, must-revalidate, private, max-age=0"},{"key":"X-Request-Id","value":"db071bf3-8c92-4602-832d-2f30dcf4992e"},{"key":"X-Runtime","value":"0.163330"},{"key":"X-MiniProfiler-Original-Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-MiniProfiler-Ids","value":"[\"m03wdatho01h2d9mweos\",\"2s2lff16zhwh10m28da2\",\"56odb72yaoqw8q4x7jw2\",\"6a7hkozckr4vz82v2yf6\",\"cb7takq2lgaa2e9sckbt\",\"6vaxo6kggxje7jjsrpt6\",\"z1m8hm2hvtoc6p90n2eo\"]"},{"key":"Set-Cookie","value":"__profilin=p%3Dt; path=/"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n\t\"data\": {\n\t\t\"destroyServiceOrder\": {\n\t\t\t\"id\": \"1\",\n\t\t\t\"name\": \"Ordem de serviço\",\n\t\t\t\"folderId\": 1,\n\t\t\t\"organizationId\": 1,\n\t\t\t\"responsibleUserId\": 1,\n\t\t\t\"status\": \"pending\",\n\t\t\t\"number\": 1,\n\t\t\t\"customerId\": null,\n\t\t\t\"description\": \"Descrição\",\n\t\t\t\"observation\": \"Observação\"\n\t\t}\n\t}\n}"}],"_postman_id":"9cf4f0f9-5040-4785-a582-296abb59b010"},{"name":"Visualizar Ordem de Serviço","id":"5d1069c1-8e67-4e57-9542-2eb29e0ed6f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE1ODcxNTg3MDJ9.PPny0wQJdozkkkSgGvkz3PlT9TvTayCZNJ9nvtgGN6U"}]},"isInherited":false},"method":"POST","header":[{"key":"OrganizationId","value":"1","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query{\n\tshowServiceOrder(\n\t\tid: 1, # OBRIGATÓRIO - ID da OS\n\t) {\n\t\tid,\n\t\tname,\n\t\tfolderId,\n\t\torganizationId,\n\t\tresponsibleUserId,\n\t\tstatus,\n\t\tnumber,\n\t\tcustomerId,\n\t\tdescription,\n\t\tobservation,\n\t\tcreatedAt,\n\t\tupdatedAt\n\t}\n}","variables":""}},"url":"api.artia.com/graphql","description":"Deve visualizar a ordem de serviço do id enviado, permitindo informar os campos de saída que deseja visualizar.
\nO id é o único campo aceito nesta operação e seu envio é obrigatório.
Deve listar todas as ordens de serviço de um grupo de trabalho, permitindo informar os campos de saída que deseja visualizar.
\nOs campos page e accountId são obrigatórios.
A resposta é paginada, retornando 25 registros por página. O parâmetro page define a página específica a ser consultada.
Para utilização desta API, é necessário definir alguns valores que devem ser passados no cabeçalho (Header) das requisições (exceto na geração de token).
\nExemplo CURL:
\n--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE1ODcxMzM3OTZ9.j31CBxxVA8bIhaluY8RAKI22kCsUKd-KqO0GYpb9zws' \\\n--header 'OrganizationId: 1' \\ # Opcional - não é necessário informar quando utilizar a autenticação de API do tipo cliente\n--header 'UserId: 1' \\ # Opcional, porém deve ser passado em todas as requisições quando utilizado a autenticação de token via cliente\n\nAo conectar você irá visualizar artia_organization_IDdaSuaOrg_time_entries_v2
Relacionamentos
\nRelacione a coluna parent_project na view de apontamentos artia_organization_IDdaSuaOrg_time_entries_v2 com a coluna project_name da view de projetos artia_organization_IDdaSuaOrg_projects_v2
Ao conectar você irá visualizar artia_organization_IDdaSuaOrg_activities_v2
Relacionamentos
\nRelacione a coluna title na view de atividades artia_organization_IDdaSuaOrg_activitie_v2 com a coluna activity_title da view de apontamentos artia_organization_IDdaSuaOrg_time_entries_v2
Dicionário de dados
\n","_postman_id":"c4461127-b36f-43ae-a2c8-0ef5cae9cb48"},{"name":"Atividades Vinculadas","item":[],"id":"48b99642-8c72-4a75-9dff-bd1b725d4aab","description":"Ao conectar você irá visualizar artia_organization_IDdaSuaOrg_activity_dependencies_v2
Ao conectar você irá visualizar artia_organization_IDdaSuaOrg_activity_relateds_v2
Ao conectar você irá visualizar artia_organization_IDdaSuaOrg_categories_v2
Ao conectar você irá visualizar artia_organization_IDdaSuaOrg_comments_v2
Ao conectar você irá visualizar artia_organization_IDdaSuaOrg_teams_users_v2
Ao conectar você irá visualizar artia_organization_IDdaSuaOrg_milestones_v2
Ao conectar você irá visualizar artia_organization_IDdaSuaOrg_resources_v2
Ao conectar você irá visualizar artia_organization_IDdaSuaOrg_tags_v2
Ao conectar você irá visualizar artia_organization_IDdaSuaOrg_organization_users_v2
Ao conectar você irá visualizar artia_organization_IDdaSuaOrg_community_users_v2
Ao conectar você irá visualizar artia_organization_IDdaSuaOrg_holiday_v2
Ao conectar você irá visualizar artia_organization_IDdaSuaOrg_user_absences_v2
Ao conectar você irá visualizar artia_organization_IDdaSuaOrg_user_coast_v2
Ao conectar você irá visualizar artia_organization_IDdaSuaOrg_risk_v2
Ao conectar você irá visualizar artia_organization_IDdaSuaOrg_folders_v2
\n","_postman_id":"9ef30e3d-9620-4d13-927e-ae7c115b62a2"},{"name":"Projetos","item":[],"id":"43d815f8-9c08-44a2-aa7d-1457b906386f","description":"Ao conectar você irá visualizar artia_organization_IDdaSuaOrg_projects_v2
\n","_postman_id":"43d815f8-9c08-44a2-aa7d-1457b906386f"},{"name":"Lançamentos Financeiros","item":[],"id":"6098e0bb-a156-415f-b6ec-35cb38a9c278","description":"Ao conectar você irá visualizar artia_organization_IDdaSuaOrg_finances_v2
Ao conectar você irá visualizar artia_organization_IDdaSuaOrg_user_alocation_v2
Ao conectar você irá visualizar artia_organization_IDdaSuaOrg_activity_custom_status_history_v2
Dicionário de dados
\n","_postman_id":"2571c043-a371-477f-8437-f9c1826ef805"},{"name":"Competências","item":[],"id":"09553aae-fb04-4d04-bd38-8dec94196046","description":"Ao conectar você irá visualizar artia_organization_IDdaSuaOrg_users_skills_v2
\n","_postman_id":"09553aae-fb04-4d04-bd38-8dec94196046"},{"name":"Relacionamento de Tabelas (JOIN)","item":[],"id":"d055cf94-7600-4a94-9830-64a25d131134","description":"Relacione a coluna project_name na view de
projetos artia_organization_IDdaSuaOrg_projects_v2 com
a coluna parent_project da view de atividades artia_organization_IDdaSuaOrg_activities_v2
Relacione a coluna title na view de
atividades artia_organization_IDdaSuaOrg_activitie_v2 com
a coluna activity_title da view de apontamentos artia_organization_IDdaSuaOrg_time_entries_v2
Relacione a coluna parent_project na view de apontamentos artia_organization_IDdaSuaOrg_time_entries_v2 com a coluna project_name da view de
projetos artia_organization_IDdaSuaOrg_projects_v2 EndFragment
Print de Exemplo:
\nAqui você encontrará detalhes sobre relacionamento e dados expostos por cada uma das views disponibilizadas no Artia.
\nComo realizar relacionamento
\nOs eventos deste recurso ocorrem quando existe uma ação em um apontamento.
\nÉ importante ressaltar que ações em alguns recursos de apontamentos não irão disparar os eventos, como por exemplo: Exclusão do projeto ou pasta (ao qual o apontamento está vinculado).
\nCriar apontamentos
\n{
\"organization_id\": \"inteiro\",
\"time_entry\": Dados de apontamento,
\"changed_attributes\": null,
\"triggered_by\": Dados de usuário
}
\n
Editar apontamentos
\n{
\"organization_id\": \"inteiro\",
\"time_entry\": Dados de apontamento,
\"changed_attributes\": \"objeto\",
\"triggered_by\": Dados de usuário
}
\n
Apagar apontamentos
\n{
\"organization_id\": \"inteiro\",
\"time_entry\": Dados de apontamento,
\"changed_attributes\": null,
\"triggered_by\": Dados de usuário
}
\n
Estruturas de Dados
\nDados de apontamento
\n{\n \"id\": \"inteiro\",\n \"date_at\": \"data\",\n \"duration\": \"inteiro\",\n \"start_time\": \"data/hora ou nulo\",\n \"observation\": \"texto ou nulo\",\n \"kind_of_hours\": \"texto\",\n \"activity_id\": \"inteiro\",\n \"assignment_id\": \"inteiro\",\n \"finance_id\": \"inteiro ou nulo\",\n \"myday_player_id\": \"inteiro ou nulo\",\n \"time_entry_status_id\": \"inteiro ou nulo\",\n \"time_entry_type_id\": \"inteiro ou nulo\",\n \"time_entry_cost_center_id\": \"inteiro ou nulo\",\n \"resource_cost_center_id\": \"inteiro ou nulo\",\n \"service_order_id\": \"inteiro ou nulo\",\n \"registered_by_id\": \"inteiro\",\n \"custom_field\": \"json ou nulo\",\n \"billable\": \"booleano ou nulo\",\n \"payable\": \"booleano ou nulo\",\n \"calculation_date\": \"data/hora ou nulo\",\n \"calculation_rule\": \"texto ou nulo\",\n \"custom_columns\": \"objeto\",\n \"created_at\": \"data/hora\",\n \"updated_at\": \"data/hora\",\n \"deleted_at\": \"data/hora ou nulo\",\n}\n\nOs eventos deste recurso ocorrem quando existe uma ação em uma atividade.
\nÉ importante ressaltar que ações em alguns recursos de atividades não irão disparar os eventos, como por exemplo: Time/Sprint, Comentários, Lembrete, Tags, Arquivos, Atividades vinculadas, Marcos, Links, Cálculo, Exclusão do projeto ou pasta (ao qual a atividade está vinculada) e Participantes.
\nCriar atividades
\n{
\"organization_id\": \"inteiro\",
\"activity\": Dados de atividade,
\"changed_attributes\": null,
\"triggered_by\": Dados de usuário
}
\n
Editar atividades
\n{
\"organization_id\": \"inteiro\",
\"activity\": Dados de atividade,
\"changed_attributes\": \"objeto\",
\"triggered_by\": Dados de usuário
}
\n
Apagar atividades
\n{
\"organization_id\": \"inteiro\",
\"activity\": Dados de atividade,
\"changed_attributes\": null,
\"triggered_by\": Dados de usuário
}
\n
Estruturas de Dados
\nDados de atividade
\n{\n \"id\": \"inteiro\",\n \"status\": \"booleano\",\n \"title\": \"texto\",\n \"description\": \"texto\",\n \"estimated_start\": \"data ou nulo\",\n \"estimated_end\": \"data ou nulo\",\n \"estimated_effort\": \"decimal ou nulo\",\n \"time_estimated_start\": \"hora ou nulo\",\n \"time_estimated_end\": \"hora ou nulo\",\n \"actual_start\": \"data ou nulo\",\n \"actual_end\": \"data ou nulo\",\n \"actual_effort\": \"decimal ou nulo\",\n \"time_actual_start\": \"hora ou nulo\",\n \"time_actual_end\": \"hora ou nulo\",\n \"folder_id\": \"inteiro\",\n \"created_by_id\": \"inteiro\",\n \"created_at\": \"data/hora\",\n \"updated_at\": \"data/hora\",\n \"created_for_user\": \"booleano\",\n \"uid\": \"inteiro\",\n \"community_id\": \"inteiro\",\n \"duration_calculated\": \"inteiro\",\n \"deleted_at\": \"data ou nulo\",\n \"completed_percent\": \"decimal\",\n \"verify_conflicts\": \"booleano\",\n \"last_calculation\": \"data ou nulo\",\n \"remaining_effort\": \"decimal ou nulo\",\n \"work_days_estimated\": \"inteiro ou nulo\",\n \"remaining_days\": \"inteiro ou nulo\",\n \"days_to_calculation\": \"inteiro ou nulo\",\n \"replanned\": \"inteiro ou nulo\",\n \"replanned_count\": \"inteiro ou nulo\",\n \"base_last_start\": \"data/hora ou nulo\",\n \"base_last_end\": \"data/hora ou nulo\",\n \"base_last_effort\": \"float ou nulo\",\n \"base_last_completed_percent\": \"float ou nulo\",\n \"activity_recurrence_id\": \"inteiro ou nulo\",\n \"group_categories\": \"texto\",\n \"is_critical_path\": \"inteiro ou nulo\",\n \"position\": \"decimal ou nulo\",\n \"finance_predicted\": \"decimal ou nulo\",\n \"finance_accomplished\": \"decimal ou nulo\",\n \"custom_columns\": \"objeto\",\n \"tendency_end\": \"data ou nulo\",\n \"duration_estimated_calculated\": \"inteiro ou nulo\",\n \"priority\": \"inteiro ou nulo\",\n \"tfs_key\": \"texto ou nulo\",\n \"folder_type_id\": \"inteiro ou nulo\",\n \"type_color\": \"texto ou nulo\",\n \"schedule_performance_index\": \"decimal\",\n \"distribute_allocation_automatically\": \"booleano\",\n \"registered_by_id\": \"inteiro\",\n \"update_completed_percent\": \"booleano\",\n \"points\": \"decimal\",\n \"custom_status_id\": \"inteiro ou nulo\",\n \"custom_status_name\": \"texto ou nulo\"\n}\n\nOs eventos deste recurso ocorrem quando existe uma ação em um lançamento financeiro.
\nÉ importante ressaltar que ações em alguns recursos de lançamentos financeiros não irão disparar os eventos, como por exemplo: Comentários, Exclusão do projeto ou pasta (ao qual o lançamento financeiro está vinculado) e Participantes.
\nCriar lançamentos financeiros
\n{
\"organization_id\": \"inteiro\",
\"finance\": Dados de lançamento financeiro,
\"changed_attributes\": null,
\"triggered_by\": Dados de usuário
}
\n
Editar lançamentos financeiros
\n{
\"organization_id\": \"inteiro\",
\"finance\": Dados de lançamento financeiro,
\"changed_attributes\": \"objeto\",
\"triggered_by\": Dados de usuário
}
\n
Apagar lançamentos financeiros
\n{
\"organization_id\": \"inteiro\",
\"finance\": Dados de lançamento financeiro,
\"changed_attributes\": null,
\"triggered_by\": Dados de usuário
}
\n
Estruturas de Dados
\nDados de lançamentos financeiros
\n{\n \"id\": \"inteiro\",\n \"title\": \"texto\",\n \"description\": \"texto\",\n \"unit\": \"texto ou nulo\",\n \"amount\": \"decimal ou nulo\",\n \"unit_value\": \"decimal ou nulo\",\n \"total_value\": \"decimal ou nulo\",\n \"kind\": \"texto\",\n \"date\": \"data ou nulo\",\n \"general_ledger_account\": \"texto ou nulo\",\n \"cost_center\": \"texto ou nulo\",\n \"financial_rating\": \"texto ou nulo\",\n \"created_by_id\": \"inteiro\",\n \"updated_by_id\": \"inteiro\",\n \"created_for_user\": \"booleano\",\n \"folder_id\": \"inteiro\",\n \"created_at\": \"data/hora\",\n \"updated_at\": \"data/hora\",\n \"activity_id\": \"inteiro\",\n \"user_id\": \"inteiro\",\n \"resource_cost_date\": \"data ou nulo\",\n \"expense_report_id\": \"inteiro ou nulo\",\n \"launch_cost_center_id\": \"inteiro ou nulo\",\n \"resource_cost_center_id\": \"inteiro ou nulo\",\n \"classification\": \"texto\",\n \"billable\": \"booleano\",\n \"time_entry_id\": \"inteiro ou nulo\",\n \"payable\": \"booleano\",\n \"service_order_id\": \"inteiro ou nulo\"\n}\n\nOs eventos deste recurso ocorrem quando existe uma ação em uma ordem de serviço.
\nÉ importante ressaltar que ações em alguns recursos de ordens de serviço não irão disparar os eventos, como por exemplo: Exclusão do projeto ou pasta (ao qual a ordem de serviço está vinculado).
\nCriar ordens de serviço
\n{
\"organization_id\": \"inteiro\",
\"service_order\": Dados de ordem de serviço,
\"changed_attributes\": null,
\"triggered_by\": Dados de usuário
}
\n
Editar ordens de serviço
\n{
\"organization_id\": \"inteiro\",
\"service_order\": Dados de ordem de serviço,
\"changed_attributes\": \"objeto\",
\"triggered_by\": Dados de usuário
}
\n
Apagar ordens de serviço
\n{
\"organization_id\": \"inteiro\",
\"service_order\": Dados de ordem de serviço,
\"changed_attributes\": null,
\"triggered_by\": Dados de usuário
}
\n
Estruturas de Dados
\nDados de ordens de serviço
\n{\n \"id\": \"inteiro\",\n \"name\": \"texto\",\n \"folder_id\": \"inteiro\",\n \"organization_id\": \"inteiro\",\n \"status\": \"texto\",\n \"responsible_user_id\": \"inteiro ou nulo\",\n \"number\": \"número ou nulo\",\n \"customer_id\": \"inteiro ou nulo\",\n \"description\": \"texto ou nulo\",\n \"observation\": \"texto ou nulo\",\n \"created_at\": \"data/hora\",\n \"updated_at\": \"data/hora\",\n}\n\nOs eventos deste recurso ocorrem quando existe uma ação em um projeto.
\nÉ importante ressaltar que ações em alguns recursos de projetos não irão disparar os eventos, como por exemplo: Comentários, Tags, Arquivos, Links e Participantes.
\nCriar projetos
\n{
\"organization_id\": \"inteiro\",
\"project\": Dados de projeto,
\"changed_attributes\": null,
\"triggered_by\": Dados de usuário
}
\n
Editar projetos
\n{
\"organization_id\": \"inteiro\",
\"project\": Dados de projeto,
\"changed_attributes\": \"objeto\",
\"triggered_by\": Dados de usuário
}
\n
Apagar projetos
\n{
\"organization_id\": \"inteiro\",
\"project\": Dados de projeto,
\"changed_attributes\": null,
\"triggered_by\": Dados de usuário
}
\n
Estruturas de Dados
\nDados de projeto
\n{\n \"id\": \"inteiro\",\n \"description\": \"texto\",\n \"justification\": \"texto\",\n \"premise\": \"texto\",\n \"restriction\": \"texto\",\n \"justification\": \"texto\",\n \"estimated_start\": \"data ou nulo\",\n \"estimated_end\": \"data ou nulo\",\n \"project_id\": \"inteiro\",\n \"created_at\": \"data/hora\",\n \"updated_at\": \"data/hora\",\n \"actual_start\": \"data ou nulo\",\n \"actual_end\": \"data ou nulo\",\n \"deleted_at\": \"data ou nulo\",\n \"project_number\": \"inteiro\",\n \"last_informations\": \"texto\",\n \"estimated_effort\": \"decimal ou nulo\",\n \"completed_percent\": \"decimal ou nulo\",\n \"activities_completed_percent\": \"decimal ou nulo\",\n \"activities_remaining_effort\": \"decimal ou nulo\",\n \"activities_actual_effort\": \"decimal ou nulo\",\n \"activities_estimated_effort\": \"decimal ou nulo\",\n \"activities_designed_effort\": \"decimal ou nulo\",\n \"activities_estimated_start\": \"data ou nulo\",\n \"activities_actual_start\": \"data ou nulo\",\n \"activities_estimated_end\": \"data ou nulo\",\n \"activities_actual_end\": \"data ou nulo\",\n \"activities_last_update\": \"data/hora\",\n \"estimated_cost\": \"decimal ou nulo\",\n \"actual_cost\": \"decimal ou nulo\",\n \"finances_estimated_cost\": \"decimal ou nulo\",\n \"finances_actual_cost\": \"decimal ou nulo\",\n \"calculated_effort\": \"decimal ou nulo\",\n \"base_last_calculated_effort\": \"decimal ou nulo\",\n \"activities_base_last_effort\": \"decimal ou nulo\",\n \"activities_base_last_completed_percent\": \"decimal ou nulo\",\n \"aggregate_effort\": \"decimal ou nulo\",\n \"base_last_aggregate_effort\": \"decimal ou nulo\",\n \"estimated_revenue\": \"decimal ou nulo\",\n \"estimated_income\": \"decimal ou nulo\",\n \"actual_revenue\": \"decimal ou nulo\",\n \"actual_income\": \"decimal ou nulo\",\n \"total_estimated_cost\": \"decimal ou nulo\",\n \"total_actual_cost\": \"decimal ou nulo\",\n \"estimated_partial_cost\": \"decimal ou nulo\",\n \"estimated_partial_cost_rate\": \"decimal ou nulo\",\n \"estimated_aggregated_cost\": \"decimal ou nulo\",\n \"estimated_aggregated_cost_rate\": \"decimal ou nulo\",\n \"total_estimated_revenue\": \"decimal ou nulo\",\n \"total_actual_revenue\": \"decimal ou nulo\",\n \"estimated_partial_revenue\": \"decimal ou nulo\",\n \"estimated_partial_revenue_rate\": \"decimal ou nulo\",\n \"activities_aggregate_duration\": \"decimal ou nulo\",\n \"activities_total_duration\": \"decimal ou nulo\",\n \"percent_aggregate_duration\": \"decimal ou nulo\",\n \"activities_percent_completed_calculated\": \"decimal ou nulo\",\n \"schedule_performance_index\": \"decimal ou nulo\",\n \"cost_performance_index\": \"decimal ou nulo\",\n \"activities_duration_estimated\": \"decimal ou nulo\",\n \"activities_duration_executed\": \"decimal ou nulo\",\n \"activities_estimated_effort_with_date\": \"decimal ou nulo\",\n \"activities_base_last_effort_with_date\": \"decimal ou nulo\",\n \"parent_id\": \"inteiro\",\n \"account_id\": \"inteiro\",\n \"type\": \"texto\",\n \"name\": \"texto\",\n \"depth\": \"inteiro\",\n \"full_path\": \"texto\",\n \"status\": \"booleano\",\n \"space_allowed\": \"decimal ou nulo\",\n \"space_utilized\": \"decimal ou nulo\",\n \"created_for_user\": \"booleano\",\n \"organization_id\": \"inteiro\",\n \"reference_date\": \"data ou nulo\",\n \"ready_to_copy\": \"booleano\",\n \"template_id\": \"inteiro ou nulo\",\n \"template_participant\": \"inteiro ou nulo\",\n \"invite_token\": \"texto\",\n \"invite_user_id\": \"inteiro ou nulo\",\n \"destroyed_by_user_id\": \"inteiro ou nulo\",\n \"replanned_count\": \"inteiro\",\n \"base_last_name\": \"texto\",\n \"base_last_date\": \"data ou nulo\",\n \"base_last_description\": \"texto\",\n \"base_last_start\": \"hora ou nulo\",\n \"base_last_end\": \"hora ou nulo\",\n \"base_last_effort\": \"decimal ou nulo\",\n \"base_last_completed_percent\": \"decimal ou nulo\",\n \"last_project_id\": \"inteiro ou nulo\",\n \"template_keep_participant\": \"booleano\",\n \"deleted_parent\": \"booleano\",\n \"group_categories\": \"texto\",\n \"can_use_additional_permissions\": \"booleano\",\n \"skip_notification\": \"booleano\",\n \"skip_notification_at\": \"data ou nulo\",\n \"goals\": \"texto\",\n \"integration_key\": \"texto\",\n \"custom_columns\": \"objeto\",\n \"type_color\": \"texto\",\n \"folder_type_id\": \"inteiro ou nulo\",\n \"priority\": \"inteiro\",\n \"tendency_end\": \"data ou nulo\",\n \"breadcrumb_text\": \"texto\",\n \"path_ids\": \"objeto\",\n \"customer_id\": \"inteiro ou nulo\",\n \"base_last_schedule_performance_index\": \"decimal ou nulo\",\n \"base_last_activities_completed_percent\": \"decimal ou nulo\",\n \"base_last_percent_completed_calculated_aggregate\": \"decimal ou nulo\",\n \"base_last_activities_duration_estimated\": \"decimal ou nulo\",\n \"base_last_activities_duration_executed\": \"decimal ou nulo\",\n \"agreement_management_id\": \"inteiro ou nulo\",\n \"registered_by_id\": \"inteiro ou nulo\",\n \"block_add_member\": \"booleano\",\n \"cost_center_id\": \"inteiro ou nulo\",\n \"template_is_running\": \"booleano\",\n \"realized_partial_cost\": \"decimal ou nulo\",\n \"cost_variance_percent\": \"decimal ou nulo\",\n \"deadline_variance_percent\": \"decimal ou nulo\",\n \"webhook_status\": \"texto\",\n \"custom_status_id\": \"inteiro ou nulo\",\n \"custom_status_name\": \"texto ou nulo\"\n}\n\n🔐 Cabeçalho de entrega
\nX-Artia-Event : Evento responsável pelo disparo do hook
X-Artia-Hook-Id : Identificador único do webhook
X-Artia-Hmac-Sha256: Este cabeçalho é enviado se o webhook estiver configurado com um secret. Trata-se do resumo hexadecimal HMAC do corpo da solicitação, gerado usando a função hash SHA-256 e o segredo como chave HMAC.
X-Artia-Triggered-At : Data e hora que o evento foi disparado.
Dados de usuário
\n{\n \"id\": \"inteiro\",\n \"name\": \"texto\",\n \"email\": \"texto\"\n}\n\n🪝 Sobre webhooks
\nVocê pode criar webhooks que se inscrevem nos eventos listados nesta página. Para limitar o número de solicitações HTTP ao seu servidor, você deve se inscrever apenas nos eventos específicos que planeja tratar. Para obter mais informações, consulte Como criar webhooks no Artia.
\nCada evento de webhook nesta página inclui uma descrição das propriedades do webhook para esse evento.
\nℹ️ Como acontece a comunicação
\nQuando um webhook é disparado, o sistema envia uma mensagem automática para o endereço configurado.
\nEssa mensagem chega como:
\nUma requisição do tipo POST (ou seja, uma mensagem enviada diretamente para o endereço informado)
\nCom os dados no formato JSON, que é um formato simples e muito utilizado para transmitir informações de forma organizada
\nEm resumo, sempre que algo acontece, o sistema envia uma mensagem automática em JSON para o endereço configurado, contendo todas as informações do evento.
\n","_postman_id":"50fbc912-d840-4e8b-aff4-764ed3116875"}],"event":[{"listen":"prerequest","script":{"id":"d5e98b86-9248-4979-b786-f382a7322901","type":"text/javascript","requests":{},"exec":[""]}},{"listen":"test","script":{"id":"befb0a55-ed0f-4c8d-9f5a-d39c73698ef2","type":"text/javascript","requests":{},"exec":[""]}}],"variable":[{"key":"HOSTNAME","value":"api.artia.com"},{"key":"ORGANIZATION_ID","value":"1"},{"key":"USERMAIL","value":"teste@artia.com"},{"key":"PASSWORD","value":"123456789"},{"key":"TOKEN","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE1ODcxNTg3MDJ9.PPny0wQJdozkkkSgGvkz3PlT9TvTayCZNJ9nvtgGN6U"}]}