Px File Build With Publish

UpdatePublish.

Updates an existing live dataset, creates a new Release and submits that release for a Workflow. The starting point of the Workflow depends on the User privileges for Workflow fast track. This will be set at config.global at workflow.fastrack.

Authentication: Token based To call this API you must either be currently logged in as an Active Directory user and be able to send you Windows NTLM identity to the web server or else, you may use your own subscription token along with your AD identity. In the latter case, these must be transferred as request headers as shown below:

Name	Description
ccnusername	Windows Identity
aprtoken	Access key

Furthermore, you may only call this from subnets on the server whitelist

Privilege : Administrator , Power User

Method: PxStat.Build.Build_API.UpdatePublish

Parameters: [Object]

Name	Type	Default	Description
MtrCode	String		Matrix code of an existing live dataset
WrqDatetime	Date/Time		Release date and time. Format is yyyy-MM-ddThh:mm:ss
Dimension	Array [Object]		There will be one dimension per language in the px file

Dimension: [Object]

Name	Type	Default	Description
LngIsoCode	String		Language ISO Code
MtrTitle	String		Matrix Title
MtrNote	String		Notes
Classification	Classification Object array		Classification objects (see below)
Frequency	Frequency Object		Frequency Object(see below)
StatisticLabel	String		Label for statistics

Frequency: [Object]

Name	Type	Default	Description
FrqValue	String		Statistic Code
Period	Object Array		List of Period objects (see below)

Period: [Object] . If any of the Data pertains to new periods, then those periods must be described below.

Name	Type	Default	Description
PrdCode	String		Period Code
PrdValue	String		Period Name

Data: [Object array] Note - Each item represents an individual data point that is being added/amended. Each data point will have one statistic and one time period and one or more classifications. The number of items in the object will therefore depend on the number of classifications in the matrix.

Name	Type	Default	Description
Statistic Code	String		The value corresponding to Statistic Code
Frequency Code	String		The value corresponding to Frequency Code
Classification Code	String		The variable value corresponding to Classification Code for this data point

The Classification Code entry will be repeated for each Classification in the Matrix.

Example Parameters:

Example Parameters - Details.

{
	"jsonrpc": "2.0",
	"method": "PxStat.Build.Build_API.UpdatePublish",
	"params": {
		"MtrCode": "MIM04",
		"WrqDatetime": "2024-05-22T12:40",
		"Dimension": [
			{
				"LngIsoCode": "en",
				"MtrNote": "This is a note",
				"Frequency": {
					"Period": [
						{
							"PrdCode": "2021M01",
							"PrdValue": "2021M01"
						}
					]
				}
			}
		],
		"Data": [
			[
				"NACE2",
				"STATISTIC",
				"TLIST(M1)",
				"VALUE"
			],
			[
				"10",
				"MIM04C01",
				"2020M99",
				"114.4"
			],
			[
				"10",
				"MIM04C01",
				"2021M01",
				"11"
			],
			[
				"10",
				"MIM04C02",
				"2020M99",
				"77"
			],
			[
				"10",
				"MIM04C02",
				"2021M01",
				"22"
			],
			[
				"101",
				"MIM04C01",
				"2020M99",
				"112.1"
			],
			[
				"101",
				"MIM04C01",
				"2021M01",
				"33"
			],
			[
				"101",
				"MIM04C02",
				"2020M99",
				"100.8"
			],
			[
				"101",
				"MIM04C02",
				"2021M01",
				"44"
			],
			[
				"105",
				"MIM04C01",
				"2020M99",
				"151.1"
			],
			[
				"105",
				"MIM04C01",
				"2021M01",
				"55"
			],
			[
				"105",
				"MIM04C02",
				"2020M99",
				"157.7"
			],
			[
				"105",
				"MIM04C02",
				"2021M01",
				"66"
			]
		]
	},
	"id": 225426639
}

Return: success.

Error handling: Errors will be returned as a JSON-RPC object. An example is shown below:

{
    "jsonrpc": "2.0",
    "error": {
        "code": -32099,
        "message": "Application error",
        "data": [
            {
                "PropertyName": "MtrCode",
                "ErrorMessage": "Matrix code must not be empty",
                "AttemptedValue": "",
                "CustomState": null,
                "Severity": 0,
                "ErrorCode": "LengthValidator",
                "FormattedMessagePlaceholderValues": {
                    "MinLength": 1,
                    "MaxLength": 20,
                    "TotalLength": 0,
                    "PropertyName": "Mtr Code",
                    "PropertyValue": ""
                }
            }
        ]
    },
    "id": "225426639"
}