Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 29 Current »

  • lenken til whiteboard:

https://unit.atlassian.net/wiki/spaces/IPM/whiteboard/2789900352

eksempler:

API calls & responses:

 Leverandører med e-post for et bestemt companyId (sample: "TF")

GET: {{ubw-rest-url}}/v1/objects/logiqeposts?companyId=TF

Response:

Response (object) schema:

{{
    "type": "object",
    "properties": {
        "aparId": {
            "type": "string",
            "description": "Den unike identifikatoren for objektet."
        },
        "aparName": {
            "type": "string",
            "description": "Navnet på objektet."
        },
        "client": {
            "type": "string",
            "description": "Klienten eller organisasjonen knyttet til objektet."
        },
        "compRegNo": {
            "type": "string",
            "description": "Selskapets registreringsnummer eller identifikator."
        },
        "eMail": {
            "type": "string",
            "format": "email",
            "description": "E-postadressen knyttet til objektet."
        },
        "lastUpdate": {
            "type": "string",
            "format": "date-time",
            "description": "Dato og klokkeslett for siste oppdatering av objektets informasjon."
        }
    },
    "required": ["aparId", "aparName", "client", "compRegNo", "eMail", "lastUpdate"]
}
 fakturareferanser med URI-attributes for et bestemt <companyId> (sample: "TF") og filter (<attributeId>) (sample: "%20eq%20'XB01'%20and%20status%20eq%20'N'")

GET: {{ubw-rest-url}}/v1/objects/attribute-values?companyId=TF&filter=attributeId%20eq%20'XB01'%20and%20status%20eq%20'N'

Response:

Response (object) schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "attributeId": {
      "type": "string"
    },
    "attributeName": {
      "type": "string"
    },
    "attributeValue": {
      "type": "string"
    },
    "companyId": {
      "type": "string"
    },
    "customValue": {
      "type": "number"
    },
    "description": {
      "type": "string"
    },
    "owner": {
      "type": "string"
    },
    "ownerAttributeId": {
      "type": "string"
    },
    "ownerAttributeName": {
      "type": "string"
    },
    "periodFrom": {
      "type": "integer"
    },
    "periodTo": {
      "type": "integer"
    },
    "status": {
      "type": "string"
    },
    "lastUpdated": {
      "type": "object",
      "properties": {
        "updatedAt": {
          "type": "string",
          "format": "date-time"
        },
        "updatedBy": {
          "type": "string"
        }
      },
      "required": ["updatedAt", "updatedBy"]
    }
  },
  "required": [
    "attributeId",
    "attributeName",
    "attributeValue",
    "companyId",
    "customValue",
    "description",
    "owner",
    "ownerAttributeId",
    "ownerAttributeName",
    "periodFrom",
    "periodTo",
    "status",
    "lastUpdated"
  ]
}

  • No labels