safetychain_list_customers
List customers
List customers of the SafetyChain tenant, with ids, names, enabled flags and created/modified dates. Filter by name. The API does not page: all matches come back (cut at limit). GET /clientapis/resourcemanagement/v1.0/customers.
Parametersnamelimitis_deletedis_enabled
safetychain_get_customer
Get customer
Get one customer by id (an id from safetychain_list_customers). GET /clientapis/resourcemanagement/v1.0/customer/{id}.
Parametersidrequired
safetychain_list_locations
List locations
List locations (plants, sites, areas) of the SafetyChain tenant, with ids, names, enabled flags and created/modified dates. Filter by name. The API does not page: all matches come back (cut at limit). GET /clientapis/resourcemanagement/v1.0/locations.
Parametersnamelimitis_deletedis_enabled
safetychain_get_location
Get location
Get one location by id (an id from safetychain_list_locations). GET /clientapis/resourcemanagement/v1.0/location/{id}.
Parametersidrequired
safetychain_list_suppliers
List suppliers
List suppliers of the SafetyChain tenant, with ids, names, enabled flags and created/modified dates. Filter by name. The API does not page: all matches come back (cut at limit). GET /clientapis/resourcemanagement/v1.0/suppliers.
Parametersnamelimitis_deletedis_enabled
safetychain_get_supplier
Get supplier
Get one supplier by id (an id from safetychain_list_suppliers). GET /clientapis/resourcemanagement/v1.0/supplier/{id}.
Parametersidrequired
safetychain_list_items
List items
List items (products, ingredients, materials) of the SafetyChain tenant, with ids, names, enabled flags and created/modified dates. Filter by name. The API does not page: all matches come back (cut at limit). GET /clientapis/resourcemanagement/v1.0/items.
Parametersnamelimitis_deletedis_enabled
safetychain_get_item
Get item
Get one item by id (an id from safetychain_list_items). GET /clientapis/resourcemanagement/v1.0/item/{id}.
Parametersidrequired
safetychain_list_equipment
List equipment
List equipment of the SafetyChain tenant, with ids, names, enabled flags and created/modified dates. Filter by name. The API does not page: all matches come back (cut at limit). GET /clientapis/resourcemanagement/v1.0/equipment.
Parametersnamelimitis_deletedis_enabled
safetychain_get_equipment
Get equipment
Get one equipment by id (an id from safetychain_list_equipment). GET /clientapis/resourcemanagement/v1.0/equipment/{id}.
Parametersidrequired
safetychain_list_resources
List resources
List resources of every type (customers, equipment, items, suppliers, lists) of the SafetyChain tenant, with ids, names, enabled flags and created/modified dates. Filter by name. The API does not page: all matches come back (cut at limit). GET /clientapis/resourcemanagement/v1.0/resources.
Parametersnamelimitis_enabled
safetychain_get_resource
Get resource
Get one resource by id (an id from safetychain_list_resources). GET /clientapis/resourcemanagement/v1.0/resource/{id}.
Parametersidrequired
safetychain_list_forms
List forms
List forms (the checklists and data-entry forms operators fill in) of the SafetyChain tenant, with ids, names, enabled flags and created/modified dates. Filter by name. The API does not page: all matches come back (cut at limit). GET /clientapis/resourcemanagement/v1.0/forms.
Parametersnamelimitis_currentis_released
safetychain_get_form
Get form
Get one form by id (an id from safetychain_list_forms). GET /clientapis/resourcemanagement/v1.0/form/{id}.
Parametersidrequired
safetychain_list_categories
List categories
List categories used to group resources of the SafetyChain tenant, with ids, names, enabled flags and created/modified dates. Filter by name. The API does not page: all matches come back (cut at limit). GET /clientapis/resourcemanagement/v1.0/categories.
Parametersnamelimitis_deletedis_enabledparent_category_id
safetychain_get_category
Get category
Get one category by id (an id from safetychain_list_categories). GET /clientapis/resourcemanagement/v1.0/category/{id}.
Parametersidrequired
safetychain_search_capas
Search CAPAs
Search corrective and preventive actions (CAPA, SCAR, CCAR). Filters combine with AND. Returns id, name, severity, owner workgroup, status, event and due dates, task counts, location and template type, 50 per page. Use the Id (a GUID) with safetychain_get_capa and the other CAPA tools. POST /clientapis/capamanagement/v1.0/capas (a read: it only searches).
Parameterspagecapa_idstatuseslocationspage_sizedescendingseveritiessearch_termname_containstemplate_typesowner_workgroup_contains
safetychain_get_capa
Get CAPA
Get one CAPA's details: status, severity, event and due dates, summary, creator, resource, source, category, owner workgroup, template and steps. The id is the GUID `Id` from safetychain_search_capas. GET /clientapis/capamanagement/v1.0/capa/{id}.
Parametersidrequired
safetychain_get_capa_tasks
Get CAPA tasks
List a CAPA's tasks (step, form, location, resource, workgroup, assignee, due date, status). The id is the GUID `Id` from safetychain_search_capas. GET /clientapis/capamanagement/v1.0/capa/{id}/tasks.
Parametersidrequiredpagepage_size
safetychain_get_capa_attachments
Get CAPA attachments
List a CAPA's attachments (name, extension, link, creator, date). The id is the GUID `Id` from safetychain_search_capas. GET /clientapis/capamanagement/v1.0/capa/{id}/attachments.
Parametersidrequiredpagepage_size
safetychain_get_capa_history
Get CAPA history
List a CAPA's history entries. The id is the GUID `Id` from safetychain_search_capas. GET /clientapis/capamanagement/v1.0/capa/{id}/history.
Parametersidrequiredpagepage_size
safetychain_get_capa_linked_records
Get CAPA linked records
List a CAPA's linked records. The id is the GUID `Id` from safetychain_search_capas. GET /clientapis/capamanagement/v1.0/capa/{id}/linkedrecords.
Parametersidrequiredpagepage_size
safetychain_get_capa_linked_capas
Get CAPA linked capas
List a CAPA's linked CAPAs. The id is the GUID `Id` from safetychain_search_capas. GET /clientapis/capamanagement/v1.0/capa/{id}/linkedcapas.
Parametersidrequiredpagepage_size
safetychain_get_capa_activity
Get CAPA activity
List a CAPA's activity (comments and events). The id is the GUID `Id` from safetychain_search_capas. GET /clientapis/capamanagement/v1.0/capa/{id}/activity.
Parametersidrequired
safetychain_get_record
Get record
Get one submitted record in full by its record id (the GUID `recordId` from safetychain_search_records): form, who submitted it and when, location, resource, field values, verifications. GET /clientapis/recordmanagement/v1.0/record/{recordId}.
Parametersrecord_idrequired
safetychain_record_exists
Check a record exists
Check whether a record exists for a record id (GUID). GET /clientapis/recordmanagement/v1.0/record/{recordId}/Exists.
Parametersrecord_idrequired
safetychain_search_records
Search records
Search submitted records (the headers: record number, compliance, submitted date, location, form and version, resource, who submitted, signed, verifications, ids). Filter by date range, form, location, resource, identifier and compliance. Always narrow by a date range or a name: the tenant can hold millions of records. Pages are not snapshotted: for a stable multi-page read use a closed date range (start and end in the past). Use safetychain_get_record_fields for the field values. POST /clientapis/v2.0/getRecords (a read: it only searches).
Parametersendpagestartmin_agodate_typeform_likeform_nameis_signedpage_rowsis_verifiedlocation_likelocation_name+7 more
safetychain_get_record_fields
Get record field values
Get the field-level values of records (one entry per record with its fields: name, short name, type, value, unit, compliance, min, max, target, comments, section). Same filters as safetychain_search_records; narrow strongly (a record number or one form and a short date range), each record carries many fields. POST /clientapis/v2.0/getRecordsWithFields (a read).
Parametersendpagestartmin_agodate_typeform_likeform_nameis_signedpage_rowsfield_namesis_verifiedlocation_like+9 more
safetychain_get_record_summary
Summarize records
Fast summary of the records matching the filters: first and last date, and how many forms, resources, locations and users are involved. Use it to size a request before safetychain_search_records. POST /clientapis/v2.0/getRecordSummary (a read).
Parametersendstartmin_agodate_typeform_likeform_nameis_signedis_verifiedlocation_likelocation_namerecord_numberresource_like+5 more