Tracciati CSV

Risorse REST per il caricamento e la consultazione dei tracciati CSV

La risorsa POST /file non viene visualizzata correttamente in questa documentazione.

La risorsa, come definito nell'OpenAPI, si aspetta una richiesta multipart/form-data ed il part file con content-type text/csv

Upload a new csv trace.

post

Allows to upload a csv trace for a GovIO service.

Authorizations
Query parameters
service_instanceinteger · int64Required

Govio Service Instance Id.

Example: 1
Body
filestring · binaryOptional
Responses
200
Successful operation.
application/hal+json
post
POST /files HTTP/1.1
Host: localhost:10001
GovHub-Consumer-Principal: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}
{
  "id": 1,
  "filename": "file1.csv",
  "user": {
    "id": 1,
    "full_name": "Antonio Giscardi"
  },
  "service_instance_id": 1,
  "status": "created",
  "creation_date": "2025-07-06T22:29:19.452Z",
  "processing_date": "2025-07-06T22:29:19.452Z",
  "error_messages": 9999,
  "acquired_messages": 9999,
  "_links": {
    "self": {
      "href": "https://govhub.it/govio/files/1"
    },
    "content": {
      "href": "https://govhub.it/govio/files/1/content"
    },
    "service-instace": {
      "href": "https://govhub.it/govio/service-instances/1"
    }
  },
  "_embedded": {
    "service-instance": {
      "service_id": 1,
      "organization_id": 1,
      "template_id": 1,
      "enabled": true,
      "io_service_id": "text",
      "id": 1,
      "_links": {
        "self": {
          "href": "https://govhub.it/govio/service-instances/1"
        },
        "service": {
          "href": "https://govhub.it/govio/services/1"
        },
        "organization": {
          "href": "https://govhub.it/govio/organizations/1"
        },
        "template": {
          "href": "https://govhub.it/govio/templates/1"
        }
      },
      "_embedded": {
        "service": {
          "id": 1,
          "service_name": "SUAP-Integrazione",
          "description": "Service for customer management.",
          "_links": {
            "self": {
              "href": "https://govhub.it/govregistry/services/1"
            },
            "logo": {
              "href": "https://govhub.it/govregistry/services/1/logo"
            },
            "logo_miniature": {
              "href": "https://govhub.it/govregistry/services/logo_miniature"
            }
          }
        },
        "organization": {
          "id": 1,
          "legal_name": "Giletti S.R.L.",
          "tax_code": "01234567890",
          "_links": {
            "self": {
              "href": "https://govhub.it/govregistry/organizations/1"
            },
            "logo": {
              "href": "https://govhub.it/govregistry/organizations/1/logo"
            },
            "logo_miniature": {
              "href": "https://govhub.it/govregistry/organizations/logo_miniature"
            }
          }
        },
        "template": {
          "name": "Spedizione Messaggio CIE",
          "description": "Segnala la scadenza della proprià C.I.E.",
          "subject": "Scadenza CIE n. ${cie.uppercase}",
          "message_body": "Salve, con la presente la informiamo che in data ${due_date} scadrà la Carta di Identità elettronica numero ${cie.uppercase}.",
          "has_payment": true,
          "has_due_date": true,
          "id": 1,
          "_links": {
            "self": {
              "href": "https://govhub.it/govio/templates/1"
            },
            "placeholders": {
              "href": "https://govhub.it/govio/templates/1/placeholders"
            }
          }
        }
      }
    }
  }
}

Retrieve the uploaded csv traces

get

Retrieve the csv traces

Authorizations
Query parameters
limitinteger · int32 · min: 1 · max: 100Optional

Max number of provided items.

offsetinteger · int64 · max: 9223372036854776000Optional

offset (zero-based) of indexed results.

Default: 0
qstring · max: 255Optional

generic query.

Example: user_1Pattern: ^[^\u0000]*$
user_idinteger · int64 · max: 9223372036854776000Optional

User identifier.

Example: 1
service_idinteger · int64 · max: 9223372036854776000Optional

Service identifier.

Example: 1
organization_idinteger · int64 · max: 9223372036854776000Optional

Organization identifier.

Example: 1
creation_date_fromstring · date-timeOptional
creation_date_tostring · date-timeOptional
sort_directionstring · enumRequired

Direction Sorting field.

Default: descPossible values:
statusstring · enumOptional

Status filter.

Possible values:
sortstring · enumRequired

Sorting field.

Default: idPossible values:
Responses
200
Successful operation.
application/hal+json
Responseall of
and
get
GET /files HTTP/1.1
Host: localhost:10001
GovHub-Consumer-Principal: YOUR_API_KEY
Accept: */*

{
  "page": {
    "offset": 20,
    "limit": 25,
    "total": 32
  },
  "items": [
    {
      "id": 1,
      "filename": "file1.csv",
      "user": {
        "id": 1,
        "full_name": "Antonio Giscardi"
      },
      "service_instance_id": 1,
      "status": "created",
      "creation_date": "2025-07-06T22:29:19.452Z",
      "processing_date": "2025-07-06T22:29:19.452Z",
      "error_messages": 9999,
      "acquired_messages": 9999,
      "_links": {
        "self": {
          "href": "https://govhub.it/govio/files/1"
        },
        "content": {
          "href": "https://govhub.it/govio/files/1/content"
        },
        "service-instace": {
          "href": "https://govhub.it/govio/service-instances/1"
        }
      },
      "_embedded": {
        "service-instance": {
          "service_id": 1,
          "organization_id": 1,
          "template_id": 1,
          "enabled": true,
          "io_service_id": "text",
          "id": 1,
          "_links": {
            "self": {
              "href": "https://govhub.it/govio/service-instances/1"
            },
            "service": {
              "href": "https://govhub.it/govio/services/1"
            },
            "organization": {
              "href": "https://govhub.it/govio/organizations/1"
            },
            "template": {
              "href": "https://govhub.it/govio/templates/1"
            }
          },
          "_embedded": {
            "service": {
              "id": 1,
              "service_name": "SUAP-Integrazione",
              "description": "Service for customer management.",
              "_links": {
                "self": {
                  "href": "https://govhub.it/govregistry/services/1"
                },
                "logo": {
                  "href": "https://govhub.it/govregistry/services/1/logo"
                },
                "logo_miniature": {
                  "href": "https://govhub.it/govregistry/services/logo_miniature"
                }
              }
            },
            "organization": {
              "id": 1,
              "legal_name": "Giletti S.R.L.",
              "tax_code": "01234567890",
              "_links": {
                "self": {
                  "href": "https://govhub.it/govregistry/organizations/1"
                },
                "logo": {
                  "href": "https://govhub.it/govregistry/organizations/1/logo"
                },
                "logo_miniature": {
                  "href": "https://govhub.it/govregistry/organizations/logo_miniature"
                }
              }
            },
            "template": {
              "name": "Spedizione Messaggio CIE",
              "description": "Segnala la scadenza della proprià C.I.E.",
              "subject": "Scadenza CIE n. ${cie.uppercase}",
              "message_body": "Salve, con la presente la informiamo che in data ${due_date} scadrà la Carta di Identità elettronica numero ${cie.uppercase}.",
              "has_payment": true,
              "has_due_date": true,
              "id": 1,
              "_links": {
                "self": {
                  "href": "https://govhub.it/govio/templates/1"
                },
                "placeholders": {
                  "href": "https://govhub.it/govio/templates/1/placeholders"
                }
              }
            }
          }
        }
      }
    }
  ]
}

Retrieve the uploaded csv trace.

get

Retrieve the csv trace.

Authorizations
Path parameters
idinteger · int64Required

Govio File Id.

Example: 1
Responses
200
Successful operation.
application/hal+json
get
GET /files/{id} HTTP/1.1
Host: localhost:10001
GovHub-Consumer-Principal: YOUR_API_KEY
Accept: */*

{
  "id": 1,
  "filename": "file1.csv",
  "user": {
    "id": 1,
    "full_name": "Antonio Giscardi"
  },
  "service_instance_id": 1,
  "status": "created",
  "creation_date": "2025-07-06T22:29:19.452Z",
  "processing_date": "2025-07-06T22:29:19.452Z",
  "error_messages": 9999,
  "acquired_messages": 9999,
  "_links": {
    "self": {
      "href": "https://govhub.it/govio/files/1"
    },
    "content": {
      "href": "https://govhub.it/govio/files/1/content"
    },
    "service-instace": {
      "href": "https://govhub.it/govio/service-instances/1"
    }
  },
  "_embedded": {
    "service-instance": {
      "service_id": 1,
      "organization_id": 1,
      "template_id": 1,
      "enabled": true,
      "io_service_id": "text",
      "id": 1,
      "_links": {
        "self": {
          "href": "https://govhub.it/govio/service-instances/1"
        },
        "service": {
          "href": "https://govhub.it/govio/services/1"
        },
        "organization": {
          "href": "https://govhub.it/govio/organizations/1"
        },
        "template": {
          "href": "https://govhub.it/govio/templates/1"
        }
      },
      "_embedded": {
        "service": {
          "id": 1,
          "service_name": "SUAP-Integrazione",
          "description": "Service for customer management.",
          "_links": {
            "self": {
              "href": "https://govhub.it/govregistry/services/1"
            },
            "logo": {
              "href": "https://govhub.it/govregistry/services/1/logo"
            },
            "logo_miniature": {
              "href": "https://govhub.it/govregistry/services/logo_miniature"
            }
          }
        },
        "organization": {
          "id": 1,
          "legal_name": "Giletti S.R.L.",
          "tax_code": "01234567890",
          "_links": {
            "self": {
              "href": "https://govhub.it/govregistry/organizations/1"
            },
            "logo": {
              "href": "https://govhub.it/govregistry/organizations/1/logo"
            },
            "logo_miniature": {
              "href": "https://govhub.it/govregistry/organizations/logo_miniature"
            }
          }
        },
        "template": {
          "name": "Spedizione Messaggio CIE",
          "description": "Segnala la scadenza della proprià C.I.E.",
          "subject": "Scadenza CIE n. ${cie.uppercase}",
          "message_body": "Salve, con la presente la informiamo che in data ${due_date} scadrà la Carta di Identità elettronica numero ${cie.uppercase}.",
          "has_payment": true,
          "has_due_date": true,
          "id": 1,
          "_links": {
            "self": {
              "href": "https://govhub.it/govio/templates/1"
            },
            "placeholders": {
              "href": "https://govhub.it/govio/templates/1/placeholders"
            }
          }
        }
      }
    }
  }
}

Retrieve the file content of the uploaded csv trace.

get

Retrieve the file content

Authorizations
Path parameters
idinteger · int64Required

Govio File Id.

Example: 1
Responses
200
Successful operation.
application/octet-stream
Responsestring · binary
get
GET /files/{id}/content HTTP/1.1
Host: localhost:10001
GovHub-Consumer-Principal: YOUR_API_KEY
Accept: */*

binary

Retrieve the file processing messages.

get

Retrieve the file messages.

Authorizations
Path parameters
idinteger · int64Required

Govio File Id.

Example: 1
Query parameters
limitinteger · int32 · min: 1 · max: 100Optional

Max number of provided items.

offsetinteger · int64 · max: 9223372036854776000Optional

offset (zero-based) of indexed results.

Default: 0
file_message_statusstring · enumRequiredDefault: anyExample: aqcuiredPossible values:
line_number_frominteger · int64 · max: 99999999Optional
Responses
200
Successful operation.
application/hal+json
Responseall of
and
get
GET /files/{id}/file-messages HTTP/1.1
Host: localhost:10001
GovHub-Consumer-Principal: YOUR_API_KEY
Accept: */*

{
  "page": {
    "offset": 20,
    "limit": 25,
    "total": 32
  },
  "items": [
    {
      "id": 1,
      "line_number": 1,
      "line_record": "text",
      "message": {
        "id": 1
      },
      "error": "text",
      "status": "aqcuired"
    }
  ]
}
PreviousConfigurazioneNextMessaggi IO

Last updated