Skip to content

Company User Master Data Api (1.0)

Download OpenAPI description
OpenAPISpecification.json
Languages
Servers

https://ws-cumd.traceone.com/

Companies

Operations

Users

Operations

Registrations

Operations

Company Relations

Operations

Search the list of companies that work with

Request

Search the list of companies that work with

Security
Bearer
Path
idstring(uuid)required
Query
AssociatedCompanyIdstring(uuid)
ExternalIdentifierstring
OnlyWithoutContactsboolean
ContactUserIdstring(uuid)
ContactResponsibilityIdstring(uuid)
curl -i -X GET \
  'https://ws-cumd.traceone.com/api/companies/{id}/relations?AssociatedCompanyId=497f6eca-6276-4993-bfeb-53cbbbba6f08&ExternalIdentifier=string&OnlyWithoutContacts=true&ContactUserId=497f6eca-6276-4993-bfeb-53cbbbba6f08&ContactResponsibilityId=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
externalIdentifierstring
externalNamestring
contactsArray of objects(TraceOne.Api.CompanyUserMasterData.Default.Messages.ViewModels.ContactModel)
commentsArray of objects(TraceOne.Api.CompanyUserMasterData.Default.Messages.ViewModels.CommentViewModel)
retailerCustomizedAttributesArray of objects(TraceOne.Api.CompanyUserMasterData.Default.Messages.ViewModels.RetailerCustomizedAttributeViewModel)
categoriesArray of objects(TraceOne.Api.CompanyUserMasterData.Default.Messages.ViewModels.Category)
companyActivitiesArray of integers(int32)
idstring(uuid)
ownerCompanyIdstring(uuid)
associatedWithCompanyIdstring(uuid)
createdAtstring(date-time)
modifiedAtstring(date-time)
enabledboolean
Response
application/json
{
  "externalIdentifier": "string",
  "externalName": "string",
  "contacts": [
    { … }
  ],
  "comments": [
    { … }
  ],
  "retailerCustomizedAttributes": [
    { … }
  ],
  "categories": [
    { … }
  ],
  "companyActivities": [
    0
  ],
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "ownerCompanyId": "10e96248-c873-4e93-b748-bc36e39510eb",
  "associatedWithCompanyId": "24ad6f53-4a40-49f3-9626-b81d67d22a4c",
  "createdAt": "2019-08-24T14:15:22Z",
  "modifiedAt": "2019-08-24T14:15:22Z",
  "enabled": true
}

Update the customized code and name of an associated company or enable/disable the association with that company.

Request

Update the customized code and name of an associated company or enable/disable the association with that company.

Security
Bearer
Path
idstring(uuid)required
associatedCompanyIdstring(uuid)required
Bodyapplication/json-patch+json
patchOperationsArray of objects(JsonPatchDocument)

Array of operations to perform

curl -i -X PATCH \
  'https://ws-cumd.traceone.com/api/v1.0/companies/{id}/relations/associatedCompanies/{associatedCompanyId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "patchOperations": [
      {
        "op": "string",
        "value": {},
        "path": "string"
      }
    ]
  }'

Responses

Success

Response
No content