CFL Dimension API

• 7/11/2022
• 2 minutes to read

APIPublisher = 'christiaens';
APIGroup = 'bocountdynamics';
APIVersion = 'v2.0';
EntityName = 'dimension';
EntitySetName = 'dimensions';

GET

method: GET
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/dimensions?$expand=dimensionValues

Entity:

{
            "@odata.etag": "W/\"JzIwOzEzMzI3ODg4OTY4MTgxMzQ4NTM1MTswMDsn\"",
            "id": "6832e12f-13e0-ec11-adf8-c90fab2a25c5",
            "code": "BEDRIJFSGROEP",
            "name": "Bedrijfsgroep",
            "description": "",
            "blocked": false,
            "systemModifiedAt": "2022-05-30T12:22:42.813Z",
            "dimensionValues": [
                {
                    "@odata.etag": "W/\"JzIwOzE1NTE2MjI0Mzg3NzUzOTE0NTMxMTswMDsn\"",
                    "id": "fd25b553-13e0-ec11-adf8-c90fab2a25c5",
                    "code": "INDUSTR.",
                    "dimensionCode": "BEDRIJFSGROEP",
                    "name": "Industrieel",
                    "blocked": false,
                    "systemModifiedAt": "2022-05-30T12:33:01.92Z"
                }
            ]
        }

CREATE

method: POST
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/dimensions
Body:

{
            "code": "TEST DIM",
            "name": "TEST DIM",
            "description": "Test dimensie",
            "blocked": false,
            "dimensionValues": [
                {
                    "code": "TEST WAARDE1",
                    "name": "Test Waarde1",
                    "blocked": false
                },
                {
                    "code": "TEST WAARDE2",
                    "name": "Test Waarde2",
                    "blocked": false
                }
            ]
}

DELETE

method: DELETE
Url: http://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(9bf826fd-0be0-ec11-adf8-c90fab2a25c5)/dimensions(0983b334-65e2-ec11-adf7-d8f92d083b76)

UPDATE

method: PATCH
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/dimension(6832e12f-13e0-ec11-adf8-c90fab2a25c5)
Headers:
"If-Match" : W/"JzIwOzE4NDM4NzkwNTcxMjE4NDI0NDE1MTswMDsn"
Body:

{
    "description": "TEST AANPASSING"
}

CFL Dimension Values API

APIPublisher = 'christiaens';
APIGroup = 'bocountdynamics';
APIVersion = 'v2.0';
EntityName = 'dimensionValue';
EntitySetName = 'dimensionValues';

GET

method: GET
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/dimensionValues

Entity:

{
    "@odata.etag": "W/\"JzIwOzE1NTE2MjI0Mzg3NzUzOTE0NTMxMTswMDsn\"",
    "id": "fd25b553-13e0-ec11-adf8-c90fab2a25c5",
    "code": "INDUSTR.",
    "dimensionCode": "BEDRIJFSGROEP",
    "name": "Industrieel",
    "blocked": false,
    "systemModifiedAt": "2022-05-30T12:33:01.92Z"
}

CREATE

method: POST
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/dimensionValues
Body:

{
    "code": "TEST WAARDE1",
    "dimensionCode":"TEST DIM",
    "name": "Test Waarde1",
    "blocked": false
}

DELETE

method: DELETE
Url: http://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(9bf826fd-0be0-ec11-adf8-c90fab2a25c5)/dimensionValues(25055bd4-69e2-ec11-adf7-d8f92d083b76)

UPDATE

method: PATCH
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/dimensionValues(fd25b553-13e0-ec11-adf8-c90fab2a25c5)
Headers:
"If-Match" : W/"JzIwOzE4NDM4NzkwNTcxMjE4NDI0NDE1MTswMDsn"
Body:

{
    "name": "TEST AANPASSING"
}

CFL Default Dimensions API

APIPublisher = 'christiaens';
APIGroup = 'bocountdynamics';
APIVersion = 'v2.0';
EntityName = 'defaultDimension';
EntitySetName = 'defaultDimensions';

GET

method: GET
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/defaultDimensions

Entity:

{
    "@odata.etag": "W/\"JzIwOzEwODMyMTE5MDIyMTA3MTE1NTA0MTswMDsn\"",
    "id": "3726b553-13e0-ec11-adf8-c90fab2a25c5",
    "parentType": "Customer",
    "parentId": "84de7e92-3390-eb11-bb60-000d3a38e6db",
    "dimensionId": "cc7b3886-3390-eb11-bb60-000d3a38e6db",
    "dimensionCode": "KLANTGROEP",
    "dimensionValueId": "d07b3886-3390-eb11-bb60-000d3a38e6db",
    "dimensionValueCode": "GROOT",
    "postingValidation": "Same Code",
    "systemModifiedAt": "2022-05-30T12:33:02.67Z"
}

CREATE

method: POST
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/defaultDimensions
Body:

{
    "parentType": "Customer",
    "parentId": "84de7e92-3390-eb11-bb60-000d3a38e6db",
    "dimensionId": "cc7b3886-3390-eb11-bb60-000d3a38e6db",
    "dimensionCode": "KLANTGROEP",
    "dimensionValueId": "d07b3886-3390-eb11-bb60-000d3a38e6db",
    "dimensionValueCode": "GROOT",
    "postingValidation": "Same Code"
}

DELETE

method: DELETE
Url: http://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(9bf826fd-0be0-ec11-adf8-c90fab2a25c5)/defaultDimensions(3726b553-13e0-ec11-adf8-c90fab2a25c5)

UPDATE

method: PATCH
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/defaultDimensions(f3726b553-13e0-ec11-adf8-c90fab2a25c5)
Headers:
"If-Match" : W/"JzIwOzEwODMyMTE5MDIyMTA3MTE1NTA0MTswMDsn"
Body:

{
    "postingValidation": "Code mandatory"
}

CFL DimensionSet API

APIPublisher = 'christiaens';
APIGroup = 'bocountdynamics';
APIVersion = 'v2.0';
EntityName = 'dimensionset';
EntitySetName = 'dimensionsets';

Method: GET Url : https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/dimensions

Entity:

{
    "dimensioncode": "KSTNPLAATS",
    "dimensionvaluecode": "VERKOOP",
    "dimensionsetid": 1,
    "dimensionname": "Kostenplaats",
    "dimensionvaluename": "Verkoop"
}