This Help Center is a preview of a future release. The final Help Center will be available on the Validation date.

Enable Company Location Linking APIs

IT system administrators use these APIs to enable company location linking. Locations must already exist as members of the TraceLink Network and the identifiers added using the Add Identifiers to Master Data APIs must match an identifier that Tracelink verified for the company. If linking is enabled, individuals with certain roles can link to specific locations. If linking is not allowed, then all individuals with the proper roles and permissions can access all of the company's location master data.

Enable Company Location Linking

IT system administrators use these APIs to enable company location linking.

Guidelines

Element Type Description
header – Required. The request header.
  headerVersion Integer Required. The version identifier for the request. Valid value is 1.
  eventName String

Required. The fully qualified name of the request event. Valid value is masterdata-manager:create-masterDataApplicationCustomerSettings:v1.
  ownerId String Required. The identifier for the Owner company associated with the request.
  dataspace String Required. The dataspace within the environment where the request is being made. Valid value for the Production and Validation environments is default.
payload – Required. The request body.
  data Object

Required. Specifies.....

Need info from PM/Dev

  companyLocationId String

The GUID identifying the company location record against which the network node is being created.

Saurabh: Can you confirm the values for this element? Also, can we say: The GUID identifying the company location record. Usually we don't want to include "network node" in the docs. This is the same issue that we had with the Admin B2B APIs.

Example

Copy 
{
    "header": {
        "dataspace": "default",
        "appName": "masterdata-manager",
        "headerVersion": 1,
        "eventName": "masterdata-manager:enable-company-location-linking:v1",
        "ownerId": "848a9b56-7a9f-4972-935b-d6041b6ced2e"
    },
    "payload": {"companyLocationId": "43a940cd-ea8c-11ed-8f2c-51b9444f1891"},

}

Guidelines

Element Type Description
header – Required. The response header.
  headerVersion Integer Required. The version identifier for the response. Valid value is 1.
  eventName String Required. The fully qualified name of the response event. Valid value is masterdata-manager:enable-company-location-linking-response:v1.
  ownerId String Required. The identifier for the Owner company associated with the request.
  isErr Boolean

Required. Indicates whether the request was successful. Valid values:

  • true – The request was successful.
  • false – The request was not successful. The errCode field provides error information for troubleshooting.
  errCode String Required. The status code of the request. 200_OK indicates that the request was successful.
  errMsg String

Conditionally required if the call is unsuccessful. The message associated with the error code.
  licensePlate String Required. The unique identifier for the request and response instance.
  exceptionName String

The exception returned for the request, if applicable.

Valid values:

  • BadRequestException – The request is missing fields or has invalid data.
  • NotFoundException – The requested information is not available.
payload – Required. The payload containing the response body. If the call is unsuccessful, payload is null.
  companyLocationId String

Required. The GUID of the company location record.

Saurabh: This is the same issue that we had with the Admin B2B APIs. Is this helpful to the user?

  companyLocationNeworkNodeId String

Required. The GUID of the network node ID.

Saurabh: This is the same issue that we had with the Admin B2B APIs. Is this helpful to the user?

Example

Copy 
{
  "header" : {
    "headerVersion" : 1,
    "eventName" : "masterdata-manager:enable-company-location-linking-response:v1",
    "ownerId" : "848a9b56-7a9f-4972-935b-d6041b6ced2e",
    "isErr" : false,
    "errCode" : "200_OK",
    "licensePlate" : "fTAukI-unbCcZ"
  },
  "payload" : {
    "companyLocationId" : "43a940cd-ea8c-11ed-8f2c-51b9444f1891",
    "companyLocationNetworkNodeId" : "d31f51c5-f7cc-40e0-8dcc-b3bedc1ec7df"
  }
}

Errors

Element Error Message Description
companyLocationId

Invalid company location ID <companyLocationId> does not match an existing company location.

The error occurs if the companyLocationId does not match an existing company location on the TraceLink Network.

This app uses standard HTTP response codes. If an error occurs, additional available information regarding the cause of the error is provided in the errMsg element in the relevant response.