API endpoints: mdm
The 9 mdm resources: their published and service-account paths, what may be done with each, and every field with its type.
Every mdm resource another product can reach, 9 in all. Each one is reached two ways: through the published API at /api/v1/<code> once an administrator has published it (its code is the resource name unless they chose another), or with a service account at /api/mdm/<resource>. The verbs, parameters, filters and answers are the same for every resource and are in API endpoint reference: how to call TRANXACT.
Fields: * means required when creating; (read-only) means it is returned but not accepted on a create or change. org_id, created_at, updated_at, created_by and updated_by are on most records and are set by TRANXACT. The id is a uuid unless the table says otherwise. Field names are the JSON keys.
其他资源
| 资源 | Endpoints | 运营 | 田野 |
|---|---|---|---|
| Addresses (addresses) | /api/v1/addresses · /api/mdm/addresses · /{id} | list, get, create, change, delete | id uuid (read-only), address_line1* text, address_line2 text, address_line3 text, city text, region text, postal_code text, country text, local_script text, latitude numeric, longitude numeric, timezone text, validation_status text, validated_at timestamp with time zone (read-only), validation_source text (read-only), building_no text, district text, additional_no text, county text (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Attribute groups (attribute-groups) | /api/v1/attribute-groups · /api/mdm/attribute-groups · /{id} | list, get, create, change, delete | id uuid (read-only), code* text, name* text, entity text, category_id uuid, description text, sort_order integer, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Attributes (attributes) | /api/v1/attributes · /api/mdm/attributes · /{id} | list, get, create, change, delete | id uuid (read-only), group_id* uuid, code* text, name* text, data_type text, uom text, options jsonb, is_required boolean, min_value numeric, max_value numeric, sort_order integer, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Categories (categories) | /api/v1/categories · /api/mdm/categories · /{id} | list, get, create, change, delete | id uuid (read-only), set_id* uuid, parent_id uuid, code* text, name* text, description text, path text (read-only), depth integer (read-only), sort_order integer, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Category sets (category-sets) | /api/v1/category-sets · /api/mdm/category-sets · /{id} | list, get, create, change, delete | id uuid (read-only), code* text, name* text, description text, entity text, purpose text, allows_multiple boolean, leaf_only boolean, is_mandatory boolean, is_active boolean, xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Duplicate candidates (duplicate-candidates) | /api/v1/duplicate-candidates · /api/mdm/duplicate-candidates · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), entity text (read-only), record_a_id uuid (read-only), record_b_id uuid (read-only), record_a_label text (read-only), record_b_label text (read-only), score numeric (read-only), reasons jsonb (read-only), status text, merge_request_id uuid (read-only), first_found_at timestamp with time zone (read-only), last_found_at timestamp with time zone (read-only), decided_by uuid (read-only), decided_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Merge requests (merge-requests) | /api/v1/merge-requests · /api/mdm/merge-requests · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), request_no text (read-only), entity text (read-only), survivor_id uuid (read-only), merged_id uuid (read-only), survivor_label text (read-only), merged_label text (read-only), reason text (read-only), candidate_id uuid (read-only), status text (read-only), preview jsonb (read-only), moved jsonb (read-only), requested_by uuid (read-only), requested_at timestamp with time zone (read-only), decided_by uuid (read-only), decided_at timestamp with time zone (read-only), decision_note text (read-only), applied_at timestamp with time zone (read-only), reversed_by uuid (read-only), reversed_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Quality findings (quality-findings) | /api/v1/quality-findings · /api/mdm/quality-findings · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), rule_id uuid (read-only), entity text (read-only), record_id uuid (read-only), record_label text (read-only), field text (read-only), value text (read-only), message text (read-only), severity text (read-only), status text, first_found_at timestamp with time zone (read-only), last_found_at timestamp with time zone (read-only), resolved_at timestamp with time zone (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |
| Quality rules (quality-rules) | /api/v1/quality-rules · /api/mdm/quality-rules · /{id} | list, get, create, change, delete | id uuid (read-only), org_unit_id uuid (read-only), code* text, name* text, entity* text, field* text, rule_type* text, params jsonb, severity text, message text, is_active boolean, last_run_at timestamp with time zone (read-only), last_findings integer (read-only), xf_text_1 text (read-only), xf_text_2 text (read-only), xf_text_3 text (read-only), xf_text_4 text (read-only), xf_text_5 text (read-only), xf_num_1 numeric (read-only), xf_num_2 numeric (read-only), xf_num_3 numeric (read-only), xf_date_1 date (read-only), xf_date_2 date (read-only) |