Proyectos

Obtener un proyecto

Devuelve el detalle de un proyecto por su identificador.

Herramienta
filmo_projects_get
Acceso: Lectura

Resultado

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_projects_get",
    "arguments": {
      "projectId": "proj_8f2a1c"
    }
  }
}

generado desde el esquema

Argumentos

projectIdstringObligatorio

Identificador del proyecto.

Límites: longitud mín. 1

Resultado

En un éxito el resultado lleva structuredContent con data y meta. Estos son los atributos de data.

Ver los atributos de data
idstring

Identificador único del proyecto.

projectNumberstring | null

Número de proyecto legible; null si no está numerado.

namestring

Nombre del proyecto.

colorstring | null

Color asociado al proyecto (para la interfaz); null si no tiene.

externalReferencestring | null

Referencia externa del proyecto (por ejemplo, del sistema del cliente); null si no consta.

projectTypeIdstring | null

Identificador del tipo de proyecto; null si el proyecto no tiene tipo.

projectTypeobject | null

Referencia compacta al tipo de proyecto; null si no hay.

Mostrar atributos hijos
projectType.idstring

Identificador único del tipo de proyecto.

projectType.namestring

Nombre del tipo de proyecto.

projectType.colorstring | null

Color asociado al tipo de proyecto (para la interfaz); null si no tiene.

contactobject | null

Referencia compacta al contacto del proyecto; null si no hay.

Mostrar atributos hijos
contact.idstring

Identificador único del contacto.

contact.namestring

Nombre del contacto.

locationobject

Ubicación del proyecto; sus campos internos son null cuando no se han registrado.

Mostrar atributos hijos
location.namestring | null

Nombre del lugar o ubicación; null si no está registrado.

location.addressstring | null

Dirección de la ubicación; null si no consta.

location.citystring | null

Ciudad de la ubicación; null si no consta.

location.postalCodestring | null

Código postal de la ubicación; null si no se ha registrado.

location.provincestring | null

Provincia o región de la ubicación; null si no se ha registrado.

location.countrystring | null

País de la ubicación; null si no consta.

location.latnumber | null

Latitud de la ubicación; null si no está registrada.

location.lngnumber | null

Longitud de la ubicación; null si no está registrada.

startDatestring<date-time>

Fecha de inicio del proyecto en ISO 8601 con desplazamiento.

endDatestring<date-time>

Fecha de fin del proyecto en ISO 8601 con desplazamiento.

statusstring

Estado del proyecto: draft, budgeted, confirmed, in_progress, invoiced, completed, cancelled o archived. archived es un estado HEREDADO que aparece en datos antiguos; el estado archivado actual se expresa mediante el booleano archived de este mismo DTO.

Opciones disponibles: draft, budgeted, confirmed, in_progress, invoiced, completed, cancelled, archived

archivedboolean

Si el proyecto está archivado.

orderIdsstring[]

Identificadores de los pedidos del proyecto. El detalle de los pedidos se obtiene en GET /api/v1/orders?projectId=.

totalOrdersinteger

Número total de pedidos del proyecto (igual a orderIds.length).

tagsobject[]

Etiquetas adjuntas al proyecto, con su identificador y nombre.

Mostrar atributos hijos
tags.idstring

Identificador único de la etiqueta.

tags.namestring

Nombre de la etiqueta.

customFieldsobject<string, any>

Valores de los campos personalizados por identificador de campo personalizado; las definiciones están en /api/v1/custom-fields.

sourcestring | null

Origen desde el que se creó el proyecto; null si no consta.

createdAtstring<date-time>

Fecha de creación en ISO 8601 con desplazamiento.

updatedAtstring<date-time>

Fecha de la última actualización en ISO 8601 con desplazamiento.

Un error es un resultado con isError: true y el problema en content[0].text; no hay structuredContent. Consulta Errores.

La misma operación por REST

Esta herramienta ejecuta GET /api/v1/projects/{projectId}.

  • Proyectos

    Obtener un proyecto

    Devuelve el detalle de un proyecto por su identificador.

  • Guías

    Escrituras seguras

    Un asistente que puede escribir también puede escribir lo equivocado. Decide qué herramientas necesitan a una persona, reintenta sin duplicar y sabe qué pone en marcha una escritura.

  • Guías

    Errores

    Un error de herramienta es un resultado con isError: true y el problema en el primer bloque de texto. Ramifica por su code.