1. Home
  2. Knowledge Base
  3. API
  4. Obtener JSON creación solicitud

Obtener JSON creación solicitud

Devuelve un JSON con la estructura, para el proceso con código processCode, del objeto a enviar en el método de Crear solicitud.

TIPO: GET

URL: https://HOST_MODELA/public/external/getexternalrequestjson/{codeProcess}

Debemos enviar un parámetro en la URL:

  • processCode: Código del proceso del que queremos obtener los datos. Se obtendrá la información de la versión publicada del proceso, en caso de no existir ninguna el método devolverá un error

Para su uso necesitamos un token del tipo Creación petición.

Ejemplo de una llamada, donde {REPLACE_INSTANCE_GENERATED_TOKEN} debe ser el valor del token:

curl --location 'https://demo.getmodela.com/public/external/getexternalrequestjson/FAC' \
--header 'token: {REPLACE_INSTANCE_GENERATED_TOKEN}' 

Ejemplo de JSON de respuesta:

{
	"ProcessCode":"FAC",
	"ObjectIdOwner":"",
	"CompanyCode":"",
	"Subject":"",
	"Summary":"",
	"AdditionalComments":"",
	"CustomStatusTarget":"",
	"FormField":[
		{
			"IdInternal":"FIELD_TEXT_1",
			"FormFieldValue":[
				{
					"Row":"0",
					"Value":"Campo con valor de texto"
				}
			]
		},
		{
			"IdInternal":"FIELD_DATE_1",
			"FormFieldValue":[
				{
					"Row":"0",
					"Value":"2024-08-25"
				}
			]
		},
		{
			"IdInternal":"FIELD_NUMBER_1",
			"FormFieldValue":[
				{
					"Row":"0",
					"Value":"123.45"
				}
			]
		}
	]
}

Las propiedades de este JSON son:

  • ProcessCode: Código del proceso para el que queremos crear la solicitud.
  • ObjectIdOwner: Object ID del usuario que creará la solicitud. Debe ser de un usuario obtenido en la petición Obtener los usuarios de BDD
  • CompanyCode: Código de la Sociedad para la que queremos crear la solicitud. Debe ser un código del listado obtenido en la petición Obtener las sociedades
  • Subject: Asunto de la solicitud
  • Summary: Resumen de la solicitud
  • AdditionalComments: Comentarios adicionales de la solicitud. Este campo es opcional
  • CustomStatusTarget: Código del estado destino al que queremos enviar la solicitud cuando se crea. Debe ser un valor de los obtenidos en la petición Obtener los estados a los que enviar la solicitud cuando la generemos. Cuando no enviamos este parámetro, la solicitud se crea en estado Borrador.
  • FormField: Listado de campos existentes en el formulario del proceso. Para cada campo tenemos la siguiente información:
    • IdInternal: Id Interno del campo en el formulario
    • FormFieldValue: Listado de valores para el campo. Si el campo pertenece a una tabla este listado sólo contendrá un registro, en caso de pertenecer a una tabla debe contener tantos registros como filas queramos en la tabla. Esta propiedad se compone de:
      • Row: Numero de fila en la tabla, el primer registro de la tabla debe ser el 0. En caso de no ser una tabla el valor siempre será 0.
      • Value: Valor que damos al campo, en este JSON esta propiedad es siempre texto, pero hay que tener en cuenta lo siguiente según el tipo de campo:
        • Número: Si lleva decimales el separador es el .
        • Fecha: El formato debe ser YYYY-MM-DD
        • Texto: Texto normal
        • Combo y Radio button: Debemos poner el código del valor que queremos seleccionar. Este valor se obtiene de la llamada al método de Obtener las opciones de selección de un campo del formulario (check box, radio button, combo)
        • Check box: Igual que Combo y Radio Button, pero si queremos marcar más de una opción los códigos deben ir separados por ,
        • Lista de usuarios: Debemos indicar el ObjectId (o varios separados por ,) de los usuarios que obtenemos en la llamada al método Obtener los usuarios de Azure
        • Listados personalizados: Debemos indicar el código (si es una selección jerárquica cada código debe estar separado por /) de los valores de la lista personalizada que deseemos. Estos valores lo podemos obtener llamando al método Obtener los listados personalizados

Los posibles errores que nos devuelve este método pueden ser:

PROCESS_NOT_FOUND: No existe ningún proceso para el código recibido.

NOT_VERSION_PUBLISH: No existe versión pública para el código proceso que hemos enviado.

Was this article helpful?

Related Articles

¿Necesitas ayuda?

Contacta con nosotros.
Contacta con soporte